httplib.h 865 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920239212392223923239242392523926239272392823929239302393123932239332393423935239362393723938239392394023941239422394323944239452394623947239482394923950239512395223953239542395523956239572395823959239602396123962239632396423965239662396723968239692397023971239722397323974239752397623977239782397923980239812398223983239842398523986239872398823989239902399123992239932399423995239962399723998239992400024001240022400324004240052400624007240082400924010240112401224013240142401524016240172401824019240202402124022240232402424025240262402724028240292403024031240322403324034240352403624037240382403924040240412404224043240442404524046240472404824049240502405124052240532405424055240562405724058240592406024061240622406324064240652406624067240682406924070240712407224073240742407524076240772407824079240802408124082240832408424085240862408724088240892409024091240922409324094240952409624097240982409924100241012410224103241042410524106241072410824109241102411124112241132411424115241162411724118241192412024121241222412324124241252412624127241282412924130241312413224133241342413524136241372413824139241402414124142241432414424145241462414724148241492415024151241522415324154241552415624157241582415924160241612416224163241642416524166241672416824169241702417124172241732417424175241762417724178241792418024181241822418324184241852418624187241882418924190241912419224193241942419524196241972419824199242002420124202242032420424205242062420724208242092421024211242122421324214242152421624217242182421924220242212422224223242242422524226242272422824229242302423124232242332423424235242362423724238242392424024241242422424324244242452424624247242482424924250242512425224253242542425524256242572425824259242602426124262242632426424265242662426724268242692427024271242722427324274242752427624277242782427924280242812428224283242842428524286242872428824289242902429124292242932429424295242962429724298242992430024301243022430324304243052430624307243082430924310243112431224313243142431524316243172431824319243202432124322243232432424325243262432724328243292433024331243322433324334243352433624337243382433924340243412434224343243442434524346243472434824349243502435124352243532435424355243562435724358243592436024361243622436324364243652436624367243682436924370243712437224373243742437524376243772437824379243802438124382243832438424385243862438724388243892439024391243922439324394243952439624397243982439924400244012440224403244042440524406244072440824409244102441124412244132441424415244162441724418244192442024421244222442324424244252442624427244282442924430244312443224433244342443524436244372443824439244402444124442244432444424445244462444724448244492445024451244522445324454244552445624457244582445924460244612446224463244642446524466244672446824469244702447124472244732447424475244762447724478244792448024481244822448324484244852448624487244882448924490244912449224493244942449524496244972449824499245002450124502245032450424505245062450724508245092451024511245122451324514245152451624517245182451924520245212452224523245242452524526245272452824529245302453124532245332453424535245362453724538245392454024541245422454324544245452454624547245482454924550245512455224553245542455524556245572455824559245602456124562245632456424565245662456724568245692457024571245722457324574245752457624577245782457924580245812458224583245842458524586245872458824589245902459124592245932459424595245962459724598245992460024601246022460324604246052460624607246082460924610246112461224613246142461524616246172461824619246202462124622246232462424625246262462724628246292463024631246322463324634246352463624637246382463924640246412464224643246442464524646246472464824649246502465124652246532465424655246562465724658246592466024661246622466324664246652466624667246682466924670246712467224673246742467524676246772467824679246802468124682246832468424685246862468724688246892469024691246922469324694246952469624697246982469924700247012470224703247042470524706247072470824709247102471124712247132471424715247162471724718247192472024721247222472324724247252472624727247282472924730247312473224733247342473524736247372473824739247402474124742247432474424745247462474724748247492475024751247522475324754247552475624757247582475924760247612476224763247642476524766247672476824769247702477124772247732477424775247762477724778247792478024781247822478324784247852478624787247882478924790247912479224793247942479524796247972479824799248002480124802248032480424805248062480724808248092481024811248122481324814248152481624817248182481924820248212482224823248242482524826248272482824829248302483124832248332483424835248362483724838248392484024841248422484324844248452484624847248482484924850248512485224853248542485524856248572485824859248602486124862248632486424865248662486724868248692487024871248722487324874248752487624877248782487924880248812488224883248842488524886248872488824889248902489124892248932489424895248962489724898248992490024901249022490324904249052490624907249082490924910249112491224913249142491524916249172491824919249202492124922249232492424925249262492724928249292493024931249322493324934249352493624937249382493924940249412494224943249442494524946249472494824949249502495124952249532495424955249562495724958249592496024961249622496324964249652496624967249682496924970249712497224973249742497524976249772497824979249802498124982249832498424985249862498724988249892499024991249922499324994249952499624997249982499925000250012500225003250042500525006250072500825009250102501125012250132501425015250162501725018250192502025021250222502325024250252502625027250282502925030250312503225033250342503525036250372503825039250402504125042250432504425045250462504725048250492505025051250522505325054
  1. //
  2. // httplib.h
  3. //
  4. // Copyright (c) 2026 Yuji Hirose. All rights reserved.
  5. // MIT License
  6. //
  7. #ifndef CPPHTTPLIB_HTTPLIB_H
  8. #define CPPHTTPLIB_HTTPLIB_H
  9. #define CPPHTTPLIB_VERSION "0.67.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x004300"
  11. #ifdef _WIN32
  12. #if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0A00
  13. #error \
  14. "cpp-httplib doesn't support Windows 8 or lower. Please use Windows 10 or later."
  15. #endif
  16. #endif
  17. #if defined(__SANITIZE_THREAD__)
  18. #define CPPHTTPLIB_THREAD_SANITIZER
  19. #elif defined(__has_feature)
  20. #if __has_feature(thread_sanitizer)
  21. #define CPPHTTPLIB_THREAD_SANITIZER
  22. #endif
  23. #endif
  24. /*
  25. * Configuration
  26. */
  27. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  28. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  29. #endif
  30. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  31. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  32. #endif
  33. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  34. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  35. #endif
  36. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  37. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  38. #endif
  39. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  40. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  41. #endif
  42. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  43. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  44. #endif
  45. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  46. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  47. #endif
  48. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  49. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  50. #endif
  51. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  52. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  53. #endif
  54. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  55. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  56. #endif
  57. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  58. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  59. #endif
  60. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  61. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  62. #endif
  63. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  64. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  65. #endif
  66. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  67. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  68. #endif
  69. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  70. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  71. #endif
  72. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  73. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  74. #endif
  75. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  76. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  77. #endif
  78. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  79. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  80. #endif
  81. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  82. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  83. #endif
  84. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  85. #ifdef _WIN32
  86. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  87. #else
  88. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  89. #endif
  90. #endif
  91. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  92. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  93. #endif
  94. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  95. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  96. #endif
  97. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  98. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  99. #endif
  100. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  101. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  102. #endif
  103. #ifndef CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT
  104. #define CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT 100
  105. #endif
  106. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  107. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  108. #endif
  109. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  110. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  111. #endif
  112. // How much of an unread request body the server skips to reuse the connection,
  113. // 0 for no limit
  114. #ifndef CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH
  115. #define CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH (256 * 1024) // 256KB
  116. #endif
  117. #ifndef CPPHTTPLIB_SSE_MAX_EVENT_LENGTH
  118. #define CPPHTTPLIB_SSE_MAX_EVENT_LENGTH (16 * 1024 * 1024) // 16MB
  119. #endif
  120. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  121. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  122. #endif
  123. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  124. // 1400 rather than a round number: a body that already fits in one 1500-byte
  125. // MTU gains nothing from being made smaller.
  126. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  127. #endif
  128. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  129. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  130. #endif
  131. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  132. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  133. #endif
  134. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  135. // recurses roughly once per matched character for quantified patterns such
  136. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  137. // a default ~8MB thread stack that has been observed to take on the order of
  138. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  139. // margin below that (well under the 8192-byte request URI limit) while still
  140. // fitting any realistic route segment; raise it if a route legitimately needs
  141. // longer paths. Regex routes are never applied to paths longer than this.
  142. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  143. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  144. #endif
  145. #ifndef CPPHTTPLIB_TCP_NODELAY
  146. #define CPPHTTPLIB_TCP_NODELAY false
  147. #endif
  148. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  149. #define CPPHTTPLIB_IPV6_V6ONLY false
  150. #endif
  151. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  152. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  153. #endif
  154. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  155. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  156. #endif
  157. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  158. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  159. #endif
  160. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  161. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  162. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  163. ? std::thread::hardware_concurrency() - 1 \
  164. : 0))
  165. #endif
  166. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  167. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  168. #endif
  169. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  170. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  171. #endif
  172. #ifndef CPPHTTPLIB_RECV_FLAGS
  173. #define CPPHTTPLIB_RECV_FLAGS 0
  174. #endif
  175. #ifndef CPPHTTPLIB_SEND_FLAGS
  176. #define CPPHTTPLIB_SEND_FLAGS 0
  177. #endif
  178. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  179. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  180. #endif
  181. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  182. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  183. #endif
  184. // These bound the parsing of every request, so 0 cannot lift them.
  185. static_assert(CPPHTTPLIB_REQUEST_URI_MAX_LENGTH > 0,
  186. "CPPHTTPLIB_REQUEST_URI_MAX_LENGTH must be positive");
  187. static_assert(CPPHTTPLIB_HEADER_MAX_LENGTH > 0,
  188. "CPPHTTPLIB_HEADER_MAX_LENGTH must be positive");
  189. static_assert(CPPHTTPLIB_HEADER_MAX_COUNT > 0,
  190. "CPPHTTPLIB_HEADER_MAX_COUNT must be positive");
  191. static_assert(CPPHTTPLIB_MAX_LINE_LENGTH > 0,
  192. "CPPHTTPLIB_MAX_LINE_LENGTH must be positive");
  193. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  194. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  195. #endif
  196. // One macro used to set the read timeout for both sides. They want different
  197. // defaults: a client's read timeout is the caller's own tool (it waits forever
  198. // until asked not to), while a server keeps a ceiling that reclaims a worker
  199. // from a peer that has gone quiet. The old name still works and sets both.
  200. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  201. #pragma message( \
  202. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  203. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  204. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  205. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  206. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  207. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  208. #endif
  209. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  210. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  211. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  212. #endif
  213. #endif
  214. // 0 waits forever. A read timeout is how a caller gets control back to send on
  215. // the same connection; it is not a liveness check (that is ping/pong). Only a
  216. // timeout set at runtime through set_read_timeout() is reported as
  217. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  218. // ws::Fail and closes the connection.
  219. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  220. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  221. #endif
  222. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  223. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  224. #endif
  225. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  226. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  227. #endif
  228. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  229. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  230. #endif
  231. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  232. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  233. #endif
  234. // A WebSocket connection carries small messages each way, which Nagle's
  235. // algorithm would hold back for the peer's delayed ACK (tens of milliseconds
  236. // on Linux), so it sets TCP_NODELAY unless this is false.
  237. #ifndef CPPHTTPLIB_WEBSOCKET_TCP_NODELAY
  238. #define CPPHTTPLIB_WEBSOCKET_TCP_NODELAY true
  239. #endif
  240. /*
  241. * Headers
  242. */
  243. #ifdef _WIN32
  244. #ifndef _CRT_SECURE_NO_WARNINGS
  245. #define _CRT_SECURE_NO_WARNINGS
  246. #endif //_CRT_SECURE_NO_WARNINGS
  247. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  248. #define _CRT_NONSTDC_NO_DEPRECATE
  249. #endif //_CRT_NONSTDC_NO_DEPRECATE
  250. #if defined(_MSC_VER)
  251. #if _MSC_VER < 1900
  252. #error Sorry, Visual Studio versions prior to 2015 are not supported
  253. #endif
  254. #pragma comment(lib, "ws2_32.lib")
  255. #ifndef _SSIZE_T_DEFINED
  256. using ssize_t = __int64;
  257. #define _SSIZE_T_DEFINED
  258. #endif
  259. #endif // _MSC_VER
  260. #ifndef S_ISREG
  261. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  262. #endif // S_ISREG
  263. #ifndef S_ISDIR
  264. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  265. #endif // S_ISDIR
  266. #ifndef NOMINMAX
  267. #define NOMINMAX
  268. #endif // NOMINMAX
  269. #include <io.h>
  270. #include <winsock2.h>
  271. #include <ws2tcpip.h>
  272. #if defined(__has_include)
  273. #if __has_include(<afunix.h>)
  274. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  275. #include <afunix.h>
  276. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  277. #endif
  278. #endif
  279. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  280. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  281. #endif
  282. using nfds_t = unsigned long;
  283. using socket_t = SOCKET;
  284. using socklen_t = int;
  285. #else // not _WIN32
  286. #include <arpa/inet.h>
  287. #if !defined(_AIX) && !defined(__MVS__)
  288. #include <ifaddrs.h>
  289. #endif
  290. #ifdef __MVS__
  291. #include <strings.h>
  292. #ifndef NI_MAXHOST
  293. #define NI_MAXHOST 1025
  294. #endif
  295. #endif
  296. #include <net/if.h>
  297. #include <netdb.h>
  298. #include <netinet/in.h>
  299. #ifdef __linux__
  300. #include <resolv.h>
  301. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  302. #include <sys/epoll.h>
  303. #include <sys/eventfd.h>
  304. #endif
  305. #include <csignal>
  306. #include <netinet/tcp.h>
  307. #include <poll.h>
  308. #include <pthread.h>
  309. #include <sys/socket.h>
  310. #include <sys/un.h>
  311. #include <unistd.h>
  312. using socket_t = int;
  313. #ifndef INVALID_SOCKET
  314. #define INVALID_SOCKET (-1)
  315. #endif
  316. #endif //_WIN32
  317. #if defined(__APPLE__)
  318. #include <TargetConditionals.h>
  319. #endif
  320. #if defined(__APPLE__) || defined(__FreeBSD__)
  321. #define CPPHTTPLIB_KQUEUE_POLLER
  322. #include <sys/event.h>
  323. #endif
  324. #include <algorithm>
  325. #include <array>
  326. #include <atomic>
  327. #include <cassert>
  328. #include <chrono>
  329. #include <climits>
  330. #include <condition_variable>
  331. #include <cstdlib>
  332. #include <cstring>
  333. #include <errno.h>
  334. #include <exception>
  335. #include <fcntl.h>
  336. #include <fstream>
  337. #include <functional>
  338. #include <iomanip>
  339. #include <iostream>
  340. #include <iterator>
  341. #include <list>
  342. #include <map>
  343. #include <memory>
  344. #include <mutex>
  345. #include <random>
  346. #include <regex>
  347. #include <set>
  348. #include <sstream>
  349. #include <string>
  350. #include <sys/stat.h>
  351. #include <system_error>
  352. #include <thread>
  353. #include <type_traits>
  354. #include <unordered_map>
  355. #include <unordered_set>
  356. #include <utility>
  357. #include <vector>
  358. // On macOS with a TLS backend, enable Keychain root certificates by default
  359. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  360. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  361. // only; on those platforms the user must provide a CA bundle explicitly.
  362. #if defined(__APPLE__) && defined(__clang__) && \
  363. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  364. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  365. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  366. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  367. #if TARGET_OS_OSX
  368. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  369. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  370. #endif
  371. #endif
  372. #endif
  373. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  374. defined(__APPLE__) && !TARGET_OS_OSX
  375. #error \
  376. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  377. #endif
  378. // On Windows, enable Schannel certificate verification by default
  379. // unless the user explicitly opts out.
  380. #if defined(_WIN32) && \
  381. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  382. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  383. #endif
  384. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  385. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  386. #if TARGET_OS_MAC && defined(__clang__)
  387. #include <CFNetwork/CFHost.h>
  388. #include <CoreFoundation/CoreFoundation.h>
  389. #endif
  390. #endif
  391. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  392. #ifdef _WIN32
  393. #include <wincrypt.h>
  394. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  395. // used
  396. #undef X509_NAME
  397. #undef X509_CERT_PAIR
  398. #undef X509_EXTENSIONS
  399. #undef PKCS7_SIGNER_INFO
  400. #ifdef _MSC_VER
  401. #pragma comment(lib, "crypt32.lib")
  402. #endif
  403. #endif // _WIN32
  404. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  405. #if TARGET_OS_OSX
  406. #include <Security/Security.h>
  407. #endif
  408. #endif
  409. #include <openssl/err.h>
  410. #include <openssl/evp.h>
  411. #include <openssl/rand.h>
  412. #include <openssl/ssl.h>
  413. #include <openssl/x509v3.h>
  414. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  415. #include <openssl/applink.c>
  416. #endif
  417. #include <iostream>
  418. #include <sstream>
  419. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  420. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  421. #error Please use OpenSSL or a current version of BoringSSL
  422. #endif
  423. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  424. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  425. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  426. #endif
  427. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  428. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  429. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  430. // in with this first include group so the version gating below can use it.
  431. #include <mbedtls/error.h>
  432. #include <mbedtls/net_sockets.h>
  433. #include <mbedtls/oid.h>
  434. #include <mbedtls/pk.h>
  435. #include <mbedtls/ssl.h>
  436. #include <mbedtls/version.h>
  437. #include <mbedtls/x509_crt.h>
  438. #if MBEDTLS_VERSION_MAJOR >= 4
  439. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  440. #include <psa/crypto.h>
  441. #else
  442. #include <mbedtls/ctr_drbg.h>
  443. #include <mbedtls/entropy.h>
  444. #include <mbedtls/md5.h>
  445. #include <mbedtls/sha1.h>
  446. #include <mbedtls/sha256.h>
  447. #include <mbedtls/sha512.h>
  448. #endif
  449. #ifdef _WIN32
  450. #include <wincrypt.h>
  451. #ifdef _MSC_VER
  452. #pragma comment(lib, "crypt32.lib")
  453. #endif
  454. #endif // _WIN32
  455. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  456. #if TARGET_OS_OSX
  457. #include <Security/Security.h>
  458. #endif
  459. #endif
  460. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  461. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  462. #if MBEDTLS_VERSION_MAJOR >= 4
  463. #define CPPHTTPLIB_MBEDTLS_V4
  464. #endif
  465. #if MBEDTLS_VERSION_MAJOR >= 3
  466. #define CPPHTTPLIB_MBEDTLS_V3
  467. #endif
  468. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  469. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  470. #include <wolfssl/options.h>
  471. #include <wolfssl/openssl/x509v3.h>
  472. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  473. #ifndef WOLFSSL_GEN_EMAIL
  474. #define WOLFSSL_GEN_EMAIL 1
  475. #endif
  476. #ifndef WOLFSSL_GEN_DNS
  477. #define WOLFSSL_GEN_DNS 2
  478. #endif
  479. #ifndef WOLFSSL_GEN_URI
  480. #define WOLFSSL_GEN_URI 6
  481. #endif
  482. #ifndef WOLFSSL_GEN_IPADD
  483. #define WOLFSSL_GEN_IPADD 7
  484. #endif
  485. #include <wolfssl/ssl.h>
  486. #include <wolfssl/wolfcrypt/hash.h>
  487. #include <wolfssl/wolfcrypt/md5.h>
  488. #include <wolfssl/wolfcrypt/sha256.h>
  489. #include <wolfssl/wolfcrypt/sha512.h>
  490. #ifdef _WIN32
  491. #include <wincrypt.h>
  492. #ifdef _MSC_VER
  493. #pragma comment(lib, "crypt32.lib")
  494. #endif
  495. #endif // _WIN32
  496. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  497. #if TARGET_OS_OSX
  498. #include <Security/Security.h>
  499. #endif
  500. #endif
  501. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  502. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  503. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  504. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  505. #define CPPHTTPLIB_SSL_ENABLED
  506. #endif
  507. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  508. #include <zlib.h>
  509. #endif
  510. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  511. #include <brotli/decode.h>
  512. #include <brotli/encode.h>
  513. #endif
  514. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  515. #include <zstd.h>
  516. #endif
  517. /*
  518. * Declaration
  519. */
  520. namespace httplib {
  521. namespace ws {
  522. class WebSocket;
  523. } // namespace ws
  524. namespace sse {
  525. class SSEClient;
  526. } // namespace sse
  527. namespace detail {
  528. /*
  529. * Backport std::make_unique from C++14.
  530. *
  531. * NOTE: This code came up with the following stackoverflow post:
  532. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  533. *
  534. */
  535. template <class T, class... Args>
  536. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  537. make_unique(Args &&...args) {
  538. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  539. }
  540. template <class T>
  541. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  542. make_unique(std::size_t n) {
  543. typedef typename std::remove_extent<T>::type RT;
  544. return std::unique_ptr<T>(new RT[n]);
  545. }
  546. // Locale-independent ASCII character classification. The <cctype>
  547. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  548. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  549. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  550. // classified without regard to the locale.
  551. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  552. inline bool is_ascii_alpha(char c) {
  553. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  554. }
  555. inline bool is_ascii_alnum(char c) {
  556. return is_ascii_digit(c) || is_ascii_alpha(c);
  557. }
  558. namespace case_ignore {
  559. inline unsigned char to_lower(int c) {
  560. const static unsigned char table[256] = {
  561. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  562. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  563. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  564. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  565. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  566. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  567. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  568. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  569. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  570. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  571. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  572. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  573. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  574. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  575. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  576. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  577. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  578. 255,
  579. };
  580. return table[(unsigned char)(char)c];
  581. }
  582. inline std::string to_lower(const std::string &s) {
  583. std::string result = s;
  584. std::transform(
  585. result.begin(), result.end(), result.begin(),
  586. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  587. return result;
  588. }
  589. inline bool equal(const std::string &a, const std::string &b) {
  590. return a.size() == b.size() &&
  591. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  592. return to_lower(ca) == to_lower(cb);
  593. });
  594. }
  595. // For a literal, without building a std::string from it.
  596. template <size_t N>
  597. inline bool equal(const std::string &a, const char (&b)[N]) {
  598. return a.size() == N - 1 &&
  599. std::equal(a.begin(), a.end(), b, [](char ca, char cb) {
  600. return to_lower(ca) == to_lower(cb);
  601. });
  602. }
  603. struct equal_to {
  604. bool operator()(const std::string &a, const std::string &b) const {
  605. return equal(a, b);
  606. }
  607. };
  608. struct hash {
  609. size_t operator()(const std::string &key) const {
  610. size_t h = 0;
  611. for (auto c : key) {
  612. // Unsets the 6 high bits of h, therefore no overflow happens
  613. h = (((std::numeric_limits<size_t>::max)() >> 6) & h * 33) ^
  614. static_cast<unsigned char>(to_lower(c));
  615. }
  616. return h;
  617. }
  618. };
  619. template <typename T>
  620. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  621. detail::case_ignore::equal_to>;
  622. } // namespace case_ignore
  623. // This is based on
  624. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  625. struct scope_exit {
  626. explicit scope_exit(std::function<void(void)> &&f)
  627. : exit_function(std::move(f)), execute_on_destruction{true} {}
  628. scope_exit(scope_exit &&rhs) noexcept
  629. : exit_function(std::move(rhs.exit_function)),
  630. execute_on_destruction{rhs.execute_on_destruction} {
  631. rhs.release();
  632. }
  633. ~scope_exit() {
  634. if (execute_on_destruction) { this->exit_function(); }
  635. }
  636. void release() { this->execute_on_destruction = false; }
  637. private:
  638. scope_exit(const scope_exit &) = delete;
  639. void operator=(const scope_exit &) = delete;
  640. scope_exit &operator=(scope_exit &&) = delete;
  641. std::function<void(void)> exit_function;
  642. bool execute_on_destruction;
  643. };
  644. // Simple from_chars implementation for integer and double types (C++17
  645. // substitute)
  646. template <typename T> struct from_chars_result {
  647. const char *ptr;
  648. std::errc ec;
  649. };
  650. template <typename T>
  651. inline from_chars_result<T> from_chars(const char *first, const char *last,
  652. T &value, int base = 10) {
  653. value = 0;
  654. const char *p = first;
  655. bool negative = false;
  656. if (p != last && *p == '-') {
  657. negative = true;
  658. ++p;
  659. }
  660. if (p == last) { return {first, std::errc::invalid_argument}; }
  661. auto radix = static_cast<T>(base);
  662. T result = 0;
  663. for (; p != last; ++p) {
  664. char c = *p;
  665. int digit = -1;
  666. if (is_ascii_digit(c)) {
  667. digit = c - '0';
  668. } else if ('a' <= c && c <= 'z') {
  669. digit = c - 'a' + 10;
  670. } else if ('A' <= c && c <= 'Z') {
  671. digit = c - 'A' + 10;
  672. } else {
  673. break;
  674. }
  675. if (digit < 0 || digit >= base) { break; }
  676. auto d = static_cast<T>(digit);
  677. if (result > ((std::numeric_limits<T>::max)() - d) / radix) {
  678. return {p, std::errc::result_out_of_range};
  679. }
  680. result = result * radix + d;
  681. }
  682. if (p == first || (negative && p == first + 1)) {
  683. return {first, std::errc::invalid_argument};
  684. }
  685. value = negative ? T(0) - result : result;
  686. return {p, std::errc{}};
  687. }
  688. // from_chars for double (hand-written, locale-independent)
  689. //
  690. // The only double consumed by this library is the HTTP quality value, whose
  691. // grammar is (RFC 9110 12.4.2):
  692. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  693. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  694. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  695. // '.' always the decimal separator (std::strtod would instead read it from the
  696. // global C locale, mis-parsing q-values once an embedder calls
  697. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  698. // the result to [0, 1], so inputs outside that range need not be distinguished
  699. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  700. // cases that exponent and wide-range handling would introduce.
  701. inline from_chars_result<double> from_chars(const char *first, const char *last,
  702. double &value) {
  703. value = 0.0;
  704. const char *p = first;
  705. // Each 1eN is exactly representable, so a single final division by the
  706. // matching entry yields a correctly-rounded result.
  707. static const double powers_of_ten[] = {
  708. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  709. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  710. const int max_frac_digits =
  711. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  712. // Accumulate digits into a 64-bit integer and remember how many were
  713. // fractional. Two independent caps keep this bounded and safe:
  714. // * accumulation saturates before mantissa could overflow uint64_t, and
  715. // * frac_digits is capped at max_frac_digits so it is always a valid index
  716. // into powers_of_ten (without this an input like "0.000...0" would never
  717. // grow mantissa, so the saturation cap alone would not bound it).
  718. // Both caps only drop digits far beyond the precision a q-value needs; any
  719. // value they would change is well outside [0, 1] and rejected by the caller.
  720. uint64_t mantissa = 0;
  721. int frac_digits = 0;
  722. bool seen_digit = false;
  723. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  724. auto accumulate = [&](char c) {
  725. if (mantissa <= limit) {
  726. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  727. return true;
  728. }
  729. return false;
  730. };
  731. for (; p != last && is_ascii_digit(*p); ++p) {
  732. seen_digit = true;
  733. accumulate(*p);
  734. }
  735. if (p != last && *p == '.') {
  736. ++p;
  737. for (; p != last && is_ascii_digit(*p); ++p) {
  738. seen_digit = true;
  739. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  740. }
  741. }
  742. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  743. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  744. return {p, std::errc{}};
  745. }
  746. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  747. int &out) {
  748. int val = 0;
  749. auto r = from_chars(s, s + len, val);
  750. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  751. return false;
  752. }
  753. out = val;
  754. return true;
  755. }
  756. inline bool parse_port(const char *s, size_t len, int &port) {
  757. return parse_int_in_range(s, len, 1, 65535, port);
  758. }
  759. inline bool parse_port(const std::string &s, int &port) {
  760. return parse_port(s.data(), s.size(), port);
  761. }
  762. struct UrlComponents {
  763. std::string scheme;
  764. std::string host;
  765. std::string port;
  766. std::string path;
  767. std::string query;
  768. };
  769. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  770. uc = {};
  771. size_t pos = 0;
  772. auto sep = url.find("://");
  773. if (sep != std::string::npos) {
  774. // Schemes are case-insensitive (RFC 3986 3.1)
  775. uc.scheme = case_ignore::to_lower(url.substr(0, sep));
  776. // Scheme must be [a-z]+ only
  777. if (uc.scheme.empty()) { return false; }
  778. for (auto c : uc.scheme) {
  779. if (c < 'a' || c > 'z') { return false; }
  780. }
  781. pos = sep + 3;
  782. } else if (url.compare(0, 2, "//") == 0) {
  783. pos = 2;
  784. }
  785. auto has_authority_prefix = pos > 0;
  786. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  787. url[0] != '?' && url[0] != '#');
  788. if (has_authority) {
  789. // userinfo is not supported, and a backslash that some parsers take for
  790. // '/' would leave them seeing another host than this one.
  791. if (url.find_first_of("@\\", pos) < url.find_first_of("/?#", pos)) {
  792. return false;
  793. }
  794. if (pos < url.size() && url[pos] == '[') {
  795. auto close = url.find(']', pos);
  796. if (close == std::string::npos) { return false; }
  797. uc.host = url.substr(pos + 1, close - pos - 1);
  798. // IPv6 host must be [a-fA-F0-9:]+ only
  799. if (uc.host.empty()) { return false; }
  800. for (auto c : uc.host) {
  801. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  802. (c >= 'A' && c <= 'F') || c == ':')) {
  803. return false;
  804. }
  805. }
  806. pos = close + 1;
  807. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  808. // path, query or fragment delimiter (or the end of input). Otherwise the
  809. // trailing bytes would be folded into the path while the connection
  810. // still targets the bracketed address.
  811. if (pos < url.size()) {
  812. auto c = url[pos];
  813. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  814. }
  815. } else {
  816. auto end = url.find_first_of(":/?#", pos);
  817. if (end == std::string::npos) { end = url.size(); }
  818. uc.host = url.substr(pos, end - pos);
  819. pos = end;
  820. }
  821. if (pos < url.size() && url[pos] == ':') {
  822. ++pos;
  823. auto end = url.find_first_of("/?#", pos);
  824. if (end == std::string::npos) { end = url.size(); }
  825. uc.port = url.substr(pos, end - pos);
  826. pos = end;
  827. }
  828. // Without :// or //, the entire input must be consumed as host[:port].
  829. // If there is leftover (path, query, etc.), this is not a valid
  830. // host[:port] string — clear and reparse as a plain path.
  831. if (!has_authority_prefix && pos < url.size()) {
  832. uc.host.clear();
  833. uc.port.clear();
  834. pos = 0;
  835. }
  836. }
  837. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  838. auto end = url.find_first_of("?#", pos);
  839. if (end == std::string::npos) { end = url.size(); }
  840. uc.path = url.substr(pos, end - pos);
  841. pos = end;
  842. }
  843. if (pos < url.size() && url[pos] == '?') {
  844. auto end = url.find('#', pos);
  845. if (end == std::string::npos) { end = url.size(); }
  846. uc.query = url.substr(pos, end - pos);
  847. }
  848. return true;
  849. }
  850. // Removes "." and ".." segments from a path that starts with '/' (RFC 3986
  851. // section 5.2.4).
  852. inline std::string remove_dot_segments(const std::string &path) {
  853. std::string out;
  854. size_t i = 0;
  855. while (i < path.size()) {
  856. auto next = (std::min)(path.find('/', i + 1), path.size());
  857. auto segment = path.substr(i + 1, next - i - 1);
  858. auto is_last = next == path.size();
  859. if (segment == "." || segment == "..") {
  860. if (segment == "..") {
  861. out.erase((std::min)(out.rfind('/'), out.size()));
  862. }
  863. if (is_last) { out += '/'; }
  864. } else {
  865. out += '/';
  866. out += segment;
  867. }
  868. i = next;
  869. }
  870. if (out.empty()) { out = "/"; }
  871. return out;
  872. }
  873. // Resolves a relative-path or query-only Location value against the path of
  874. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  875. // references starting with '/' are returned unchanged.
  876. inline std::string resolve_relative_location(const std::string &location,
  877. const std::string &base) {
  878. if (location.empty() || location[0] == '/') { return location; }
  879. // A ':' in the first segment means the value has a scheme.
  880. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  881. // A path starting with "//" would be re-parsed as an authority. Prefix "/."
  882. // (as the URL Standard does); remove_dot_segments strips it later.
  883. auto on_this_host = [](std::string path) -> std::string {
  884. if (path.compare(0, 2, "//") == 0) { path.insert(0, "/."); }
  885. return path;
  886. };
  887. if (location[0] == '#') {
  888. return on_this_host(base.substr(0, base.find('#')) + location);
  889. }
  890. auto base_path = base.substr(0, base.find_first_of("?#"));
  891. if (location[0] == '?') { return on_this_host(base_path + location); }
  892. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  893. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  894. // Remove "." and ".." segments from the merged path.
  895. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  896. return on_this_host(remove_dot_segments(merged.substr(0, path_end)) +
  897. merged.substr(path_end));
  898. }
  899. } // namespace detail
  900. enum class SSLVerifierResponse {
  901. // no decision has been made, use the built-in certificate verifier
  902. NoDecisionMade,
  903. // connection certificate is verified and accepted
  904. CertificateAccepted,
  905. // connection certificate was processed but is rejected
  906. CertificateRejected
  907. };
  908. // System CA loading policy for SSL clients. Auto (the default) loads system
  909. // CA certs only when no custom CA is configured; enable_system_ca() switches
  910. // to an explicit policy.
  911. enum class SystemCAMode { Auto, Enabled, Disabled };
  912. enum StatusCode {
  913. // Information responses
  914. Continue_100 = 100,
  915. SwitchingProtocol_101 = 101,
  916. Processing_102 = 102,
  917. EarlyHints_103 = 103,
  918. // Successful responses
  919. OK_200 = 200,
  920. Created_201 = 201,
  921. Accepted_202 = 202,
  922. NonAuthoritativeInformation_203 = 203,
  923. NoContent_204 = 204,
  924. ResetContent_205 = 205,
  925. PartialContent_206 = 206,
  926. MultiStatus_207 = 207,
  927. AlreadyReported_208 = 208,
  928. IMUsed_226 = 226,
  929. // Redirection messages
  930. MultipleChoices_300 = 300,
  931. MovedPermanently_301 = 301,
  932. Found_302 = 302,
  933. SeeOther_303 = 303,
  934. NotModified_304 = 304,
  935. UseProxy_305 = 305,
  936. unused_306 = 306,
  937. TemporaryRedirect_307 = 307,
  938. PermanentRedirect_308 = 308,
  939. // Client error responses
  940. BadRequest_400 = 400,
  941. Unauthorized_401 = 401,
  942. PaymentRequired_402 = 402,
  943. Forbidden_403 = 403,
  944. NotFound_404 = 404,
  945. MethodNotAllowed_405 = 405,
  946. NotAcceptable_406 = 406,
  947. ProxyAuthenticationRequired_407 = 407,
  948. RequestTimeout_408 = 408,
  949. Conflict_409 = 409,
  950. Gone_410 = 410,
  951. LengthRequired_411 = 411,
  952. PreconditionFailed_412 = 412,
  953. PayloadTooLarge_413 = 413,
  954. UriTooLong_414 = 414,
  955. UnsupportedMediaType_415 = 415,
  956. RangeNotSatisfiable_416 = 416,
  957. ExpectationFailed_417 = 417,
  958. ImATeapot_418 = 418,
  959. MisdirectedRequest_421 = 421,
  960. UnprocessableContent_422 = 422,
  961. Locked_423 = 423,
  962. FailedDependency_424 = 424,
  963. TooEarly_425 = 425,
  964. UpgradeRequired_426 = 426,
  965. PreconditionRequired_428 = 428,
  966. TooManyRequests_429 = 429,
  967. RequestHeaderFieldsTooLarge_431 = 431,
  968. UnavailableForLegalReasons_451 = 451,
  969. // Server error responses
  970. InternalServerError_500 = 500,
  971. NotImplemented_501 = 501,
  972. BadGateway_502 = 502,
  973. ServiceUnavailable_503 = 503,
  974. GatewayTimeout_504 = 504,
  975. HttpVersionNotSupported_505 = 505,
  976. VariantAlsoNegotiates_506 = 506,
  977. InsufficientStorage_507 = 507,
  978. LoopDetected_508 = 508,
  979. NotExtended_510 = 510,
  980. NetworkAuthenticationRequired_511 = 511,
  981. };
  982. namespace detail {
  983. // A multimap that keeps its entries in the order they were inserted.
  984. //
  985. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  986. // fields sharing a field name significant and forbids a proxy from reordering
  987. // them, and a query string's parameters are meaningful in the order the caller
  988. // wrote them. Neither standard container expresses it: std::unordered_multimap
  989. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  990. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  991. // key, which would drop control data such as Host behind whatever else the
  992. // message carries and alphabetise a query string.
  993. //
  994. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  995. // scan, which beats hashing for the handful of entries a message carries
  996. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  997. //
  998. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  999. // Params, whose parameter names are case-sensitive, not.
  1000. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  1001. public:
  1002. using key_type = std::string;
  1003. using mapped_type = Mapped;
  1004. using value_type = std::pair<std::string, Mapped>;
  1005. using size_type = std::size_t;
  1006. using difference_type = std::ptrdiff_t;
  1007. using reference = value_type &;
  1008. using const_reference = const value_type &;
  1009. private:
  1010. static size_type npos() { return static_cast<size_type>(-1); }
  1011. static bool keys_equal(const std::string &a, const std::string &b) {
  1012. return KeyEqual()(a, b);
  1013. }
  1014. // Iterating yields every entry in insertion order, but equal_range() and
  1015. // find() have to walk only the entries sharing one key, which are not
  1016. // adjacent. Both are the same iterator type: key_idx_ selects between the
  1017. // two traversals, and since equality compares only the position, an iterator
  1018. // restricted to one key still compares equal to end().
  1019. template <typename V> class iterator_t {
  1020. public:
  1021. using iterator_category = std::bidirectional_iterator_tag;
  1022. using value_type = insertion_ordered_multimap::value_type;
  1023. using difference_type = insertion_ordered_multimap::difference_type;
  1024. using pointer = V *;
  1025. using reference = V &;
  1026. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  1027. template <typename U,
  1028. typename std::enable_if<std::is_convertible<U *, V *>::value,
  1029. int>::type = 0>
  1030. iterator_t(const iterator_t<U> &rhs)
  1031. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  1032. key_idx_(rhs.key_idx_) {}
  1033. reference operator*() const { return data_[idx_]; }
  1034. pointer operator->() const { return data_ + idx_; }
  1035. iterator_t &operator++() {
  1036. // Saturating, so that advancing past the last entry of a key stays at
  1037. // end() instead of running off the container.
  1038. if (idx_ >= size_) { return *this; }
  1039. ++idx_;
  1040. if (key_idx_ != npos()) {
  1041. while (idx_ < size_ && !matches(idx_)) {
  1042. ++idx_;
  1043. }
  1044. }
  1045. return *this;
  1046. }
  1047. iterator_t operator++(int) {
  1048. auto tmp = *this;
  1049. ++*this;
  1050. return tmp;
  1051. }
  1052. iterator_t &operator--() {
  1053. if (idx_ == 0) { return *this; }
  1054. --idx_;
  1055. if (key_idx_ != npos()) {
  1056. while (idx_ > 0 && !matches(idx_)) {
  1057. --idx_;
  1058. }
  1059. }
  1060. return *this;
  1061. }
  1062. iterator_t operator--(int) {
  1063. auto tmp = *this;
  1064. --*this;
  1065. return tmp;
  1066. }
  1067. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1068. return idx_ == rhs.idx_;
  1069. }
  1070. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1071. return idx_ != rhs.idx_;
  1072. }
  1073. private:
  1074. friend class insertion_ordered_multimap;
  1075. template <typename> friend class iterator_t;
  1076. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1077. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1078. bool matches(size_type i) const {
  1079. return keys_equal(data_[i].first, data_[key_idx_].first);
  1080. }
  1081. V *data_;
  1082. size_type idx_;
  1083. size_type size_;
  1084. size_type key_idx_;
  1085. };
  1086. public:
  1087. using iterator = iterator_t<value_type>;
  1088. using const_iterator = iterator_t<const value_type>;
  1089. insertion_ordered_multimap() = default;
  1090. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1091. : entries_(il) {}
  1092. template <typename InputIt>
  1093. insertion_ordered_multimap(InputIt first, InputIt last)
  1094. : entries_(first, last) {}
  1095. iterator begin() { return make_iter(0, npos()); }
  1096. iterator end() { return make_iter(entries_.size(), npos()); }
  1097. const_iterator begin() const { return make_citer(0, npos()); }
  1098. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1099. const_iterator cbegin() const { return begin(); }
  1100. const_iterator cend() const { return end(); }
  1101. bool empty() const { return entries_.empty(); }
  1102. size_type size() const { return entries_.size(); }
  1103. void clear() { entries_.clear(); }
  1104. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1105. iterator insert(const value_type &val) {
  1106. entries_.push_back(val);
  1107. return make_iter(entries_.size() - 1, npos());
  1108. }
  1109. iterator insert(value_type &&val) {
  1110. entries_.push_back(std::move(val));
  1111. return make_iter(entries_.size() - 1, npos());
  1112. }
  1113. template <typename... Args> iterator emplace(Args &&...args) {
  1114. entries_.emplace_back(std::forward<Args>(args)...);
  1115. return make_iter(entries_.size() - 1, npos());
  1116. }
  1117. // For entries that have to lead the message, such as the Host header field
  1118. // (RFC 9110 5.3 recommends sending control data first).
  1119. template <typename... Args> iterator emplace_front(Args &&...args) {
  1120. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1121. return make_iter(0, npos());
  1122. }
  1123. iterator find(const std::string &key) {
  1124. auto i = index_of(key);
  1125. return i == npos() ? end() : make_iter(i, i);
  1126. }
  1127. const_iterator find(const std::string &key) const {
  1128. auto i = index_of(key);
  1129. return i == npos() ? end() : make_citer(i, i);
  1130. }
  1131. size_type count(const std::string &key) const {
  1132. size_type n = 0;
  1133. for (const auto &entry : entries_) {
  1134. if (keys_equal(entry.first, key)) { n++; }
  1135. }
  1136. return n;
  1137. }
  1138. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1139. auto i = index_of(key);
  1140. return i == npos() ? std::make_pair(end(), end())
  1141. : std::make_pair(make_iter(i, i), end());
  1142. }
  1143. std::pair<const_iterator, const_iterator>
  1144. equal_range(const std::string &key) const {
  1145. auto i = index_of(key);
  1146. return i == npos() ? std::make_pair(end(), end())
  1147. : std::make_pair(make_citer(i, i), end());
  1148. }
  1149. size_type erase(const std::string &key) {
  1150. auto before = entries_.size();
  1151. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1152. [key](const value_type &entry) {
  1153. return keys_equal(entry.first, key);
  1154. }),
  1155. entries_.end());
  1156. return before - entries_.size();
  1157. }
  1158. iterator erase(const_iterator pos) {
  1159. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1160. return make_iter(pos.idx_, npos());
  1161. }
  1162. // Erases what iterating [first, last) would actually visit, so erasing an
  1163. // equal_range() removes only the entries with that key, not everything
  1164. // positioned between them.
  1165. iterator erase(const_iterator first, const_iterator last) {
  1166. auto from = first.idx_;
  1167. auto to = last.idx_;
  1168. if (from >= to) { return make_iter(from, npos()); }
  1169. auto begin_it = entries_.begin();
  1170. auto from_it = begin_it + static_cast<difference_type>(from);
  1171. auto to_it = begin_it + static_cast<difference_type>(to);
  1172. if (first.key_idx_ == npos()) {
  1173. entries_.erase(from_it, to_it);
  1174. } else {
  1175. auto key = entries_[first.key_idx_].first;
  1176. auto keep = from_it;
  1177. for (auto it = from_it; it != to_it; ++it) {
  1178. if (!keys_equal(it->first, key)) {
  1179. if (keep != it) { *keep = std::move(*it); }
  1180. ++keep;
  1181. }
  1182. }
  1183. if (keep != to_it) {
  1184. keep = std::move(to_it, entries_.end(), keep);
  1185. } else {
  1186. keep = entries_.end();
  1187. }
  1188. entries_.erase(keep, entries_.end());
  1189. }
  1190. return make_iter(from, npos());
  1191. }
  1192. friend bool operator==(const insertion_ordered_multimap &lhs,
  1193. const insertion_ordered_multimap &rhs) {
  1194. return lhs.entries_ == rhs.entries_;
  1195. }
  1196. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1197. const insertion_ordered_multimap &rhs) {
  1198. return !(lhs == rhs);
  1199. }
  1200. private:
  1201. size_type index_of(const std::string &key) const {
  1202. for (size_type i = 0; i < entries_.size(); i++) {
  1203. if (keys_equal(entries_[i].first, key)) { return i; }
  1204. }
  1205. return npos();
  1206. }
  1207. iterator make_iter(size_type idx, size_type key_idx) {
  1208. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1209. }
  1210. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1211. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1212. }
  1213. std::vector<value_type> entries_;
  1214. };
  1215. } // namespace detail
  1216. using Headers =
  1217. detail::insertion_ordered_multimap<std::string,
  1218. detail::case_ignore::equal_to>;
  1219. // Query parameter names are case-sensitive, unlike header field names.
  1220. using Params =
  1221. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1222. using Match = std::smatch;
  1223. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1224. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1225. /*
  1226. * detail: type-erased storage used by UserData.
  1227. * ABI-stable regardless of C++ standard — always uses this custom
  1228. * implementation instead of std::any.
  1229. */
  1230. namespace detail {
  1231. using any_type_id = const void *;
  1232. template <typename T> any_type_id any_typeid() noexcept {
  1233. static const char id = 0;
  1234. return &id;
  1235. }
  1236. struct any_storage {
  1237. virtual ~any_storage() = default;
  1238. virtual std::unique_ptr<any_storage> clone() const = 0;
  1239. virtual any_type_id type_id() const noexcept = 0;
  1240. };
  1241. template <typename T> struct any_value final : any_storage {
  1242. T value;
  1243. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1244. std::unique_ptr<any_storage> clone() const override {
  1245. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1246. }
  1247. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1248. };
  1249. } // namespace detail
  1250. class UserData {
  1251. public:
  1252. UserData() = default;
  1253. UserData(UserData &&) noexcept = default;
  1254. UserData &operator=(UserData &&) noexcept = default;
  1255. UserData(const UserData &o) {
  1256. for (const auto &e : o.entries_) {
  1257. if (e.second) { entries_[e.first] = e.second->clone(); }
  1258. }
  1259. }
  1260. UserData &operator=(const UserData &o) {
  1261. if (this != &o) {
  1262. entries_.clear();
  1263. for (const auto &e : o.entries_) {
  1264. if (e.second) { entries_[e.first] = e.second->clone(); }
  1265. }
  1266. }
  1267. return *this;
  1268. }
  1269. template <typename T> void set(const std::string &key, T &&value) {
  1270. using D = typename std::decay<T>::type;
  1271. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1272. }
  1273. template <typename T> T *get(const std::string &key) noexcept {
  1274. auto it = entries_.find(key);
  1275. if (it == entries_.end() || !it->second) { return nullptr; }
  1276. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1277. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1278. }
  1279. template <typename T> const T *get(const std::string &key) const noexcept {
  1280. auto it = entries_.find(key);
  1281. if (it == entries_.end() || !it->second) { return nullptr; }
  1282. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1283. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1284. }
  1285. bool has(const std::string &key) const noexcept {
  1286. return entries_.find(key) != entries_.end();
  1287. }
  1288. void erase(const std::string &key) { entries_.erase(key); }
  1289. void clear() noexcept { entries_.clear(); }
  1290. private:
  1291. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1292. entries_;
  1293. };
  1294. struct Response;
  1295. using ResponseHandler = std::function<bool(const Response &response)>;
  1296. struct FormData {
  1297. std::string name;
  1298. std::string content;
  1299. std::string filename;
  1300. std::string content_type;
  1301. Headers headers;
  1302. };
  1303. struct FormField {
  1304. std::string name;
  1305. std::string content;
  1306. Headers headers;
  1307. };
  1308. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1309. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1310. // should see the parts as they were sent. A std::multimap sorts by field name
  1311. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1312. // than the case-insensitive predicate Headers uses.
  1313. using FormFields =
  1314. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1315. using FormFiles =
  1316. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1317. struct MultipartFormData {
  1318. FormFields fields; // Text fields from multipart
  1319. FormFiles files; // Files from multipart
  1320. // Text field access
  1321. std::string get_field(const std::string &key, size_t id = 0) const;
  1322. std::vector<std::string> get_fields(const std::string &key) const;
  1323. bool has_field(const std::string &key) const;
  1324. size_t get_field_count(const std::string &key) const;
  1325. // File access
  1326. FormData get_file(const std::string &key, size_t id = 0) const;
  1327. std::vector<FormData> get_files(const std::string &key) const;
  1328. bool has_file(const std::string &key) const;
  1329. size_t get_file_count(const std::string &key) const;
  1330. };
  1331. struct UploadFormData {
  1332. std::string name;
  1333. std::string content;
  1334. std::string filename;
  1335. std::string content_type;
  1336. };
  1337. using UploadFormDataItems = std::vector<UploadFormData>;
  1338. class DataSink {
  1339. public:
  1340. DataSink() : os(&sb_), sb_(*this) {}
  1341. DataSink(const DataSink &) = delete;
  1342. DataSink &operator=(const DataSink &) = delete;
  1343. DataSink(DataSink &&) = delete;
  1344. DataSink &operator=(DataSink &&) = delete;
  1345. std::function<bool(const char *data, size_t data_len)> write;
  1346. // Only `write` is mandatory. The rest are defaulted so that a provider
  1347. // calling one on a writer that does not set it gets sensible behaviour
  1348. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1349. // `this` is safe: DataSink is neither copyable nor movable.
  1350. std::function<bool()> is_writable = []() { return true; };
  1351. std::function<void()> done = []() {};
  1352. std::function<void(const Headers &trailer)> done_with_trailer =
  1353. [this](const Headers & /*trailer*/) { done(); };
  1354. std::ostream os;
  1355. private:
  1356. class data_sink_streambuf final : public std::streambuf {
  1357. public:
  1358. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1359. protected:
  1360. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1361. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1362. return 0;
  1363. }
  1364. private:
  1365. DataSink &sink_;
  1366. };
  1367. data_sink_streambuf sb_;
  1368. };
  1369. using ContentProvider =
  1370. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1371. using ContentProviderWithoutLength =
  1372. std::function<bool(size_t offset, DataSink &sink)>;
  1373. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1374. struct FormDataProvider {
  1375. std::string name;
  1376. ContentProviderWithoutLength provider;
  1377. std::string filename;
  1378. std::string content_type;
  1379. };
  1380. using FormDataProviderItems = std::vector<FormDataProvider>;
  1381. inline FormDataProvider
  1382. make_file_provider(const std::string &name, const std::string &filepath,
  1383. const std::string &filename = std::string(),
  1384. const std::string &content_type = std::string()) {
  1385. FormDataProvider fdp;
  1386. fdp.name = name;
  1387. fdp.filename = filename.empty() ? filepath : filename;
  1388. fdp.content_type = content_type;
  1389. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1390. std::ifstream f(filepath, std::ios::binary);
  1391. if (!f) { return false; }
  1392. if (offset > 0) {
  1393. f.seekg(static_cast<std::streamoff>(offset));
  1394. if (!f.good()) {
  1395. sink.done();
  1396. return true;
  1397. }
  1398. }
  1399. char buf[8192];
  1400. f.read(buf, sizeof(buf));
  1401. auto n = static_cast<size_t>(f.gcount());
  1402. if (n > 0) { return sink.write(buf, n); }
  1403. sink.done(); // EOF
  1404. return true;
  1405. };
  1406. return fdp;
  1407. }
  1408. inline std::pair<size_t, ContentProvider>
  1409. make_file_body(const std::string &filepath) {
  1410. size_t size = 0;
  1411. {
  1412. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1413. if (!f) { return {0, ContentProvider{}}; }
  1414. size = static_cast<size_t>(f.tellg());
  1415. }
  1416. ContentProvider provider = [filepath](size_t offset, size_t length,
  1417. DataSink &sink) -> bool {
  1418. std::ifstream f(filepath, std::ios::binary);
  1419. if (!f) { return false; }
  1420. f.seekg(static_cast<std::streamoff>(offset));
  1421. if (!f.good()) { return false; }
  1422. char buf[8192];
  1423. while (length > 0) {
  1424. auto to_read = (std::min)(sizeof(buf), length);
  1425. f.read(buf, static_cast<std::streamsize>(to_read));
  1426. auto n = static_cast<size_t>(f.gcount());
  1427. // The file is shorter than the size make_file_body() measured, which the
  1428. // caller has already committed to as Content-Length. The body cannot be
  1429. // completed, so fail as every other error here does.
  1430. if (n == 0) { return false; }
  1431. if (!sink.write(buf, n)) { return false; }
  1432. length -= n;
  1433. }
  1434. return true;
  1435. };
  1436. return {size, std::move(provider)};
  1437. }
  1438. using ContentReceiverWithProgress = std::function<bool(
  1439. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1440. using ContentReceiver =
  1441. std::function<bool(const char *data, size_t data_length)>;
  1442. using FormDataHeader = std::function<bool(const FormData &file)>;
  1443. class ContentReader {
  1444. public:
  1445. using Reader = std::function<bool(ContentReceiver receiver)>;
  1446. using FormDataReader =
  1447. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1448. ContentReader(Reader reader, FormDataReader multipart_reader)
  1449. : reader_(std::move(reader)),
  1450. formdata_reader_(std::move(multipart_reader)) {}
  1451. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1452. return formdata_reader_(std::move(header), std::move(receiver));
  1453. }
  1454. bool operator()(ContentReceiver receiver) const {
  1455. return reader_(std::move(receiver));
  1456. }
  1457. Reader reader_;
  1458. FormDataReader formdata_reader_;
  1459. };
  1460. using Range = std::pair<ssize_t, ssize_t>;
  1461. using Ranges = std::vector<Range>;
  1462. #ifdef CPPHTTPLIB_SSL_ENABLED
  1463. // TLS abstraction layer - public type definitions and API
  1464. namespace tls {
  1465. // Opaque handles (defined as void* for abstraction)
  1466. using ctx_t = void *;
  1467. using session_t = void *;
  1468. using const_session_t = const void *; // For read-only session access
  1469. using cert_t = void *;
  1470. using ca_store_t = void *;
  1471. // TLS versions
  1472. enum class Version {
  1473. TLS1_2 = 0x0303,
  1474. TLS1_3 = 0x0304,
  1475. };
  1476. // Subject Alternative Names (SAN) entry types
  1477. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1478. // SAN entry structure
  1479. struct SanEntry {
  1480. SanType type;
  1481. std::string value;
  1482. };
  1483. // Verification context for certificate verification callback
  1484. struct VerifyContext {
  1485. session_t session; // TLS session handle
  1486. cert_t cert; // Current certificate being verified
  1487. int depth; // Certificate chain depth (0 = leaf)
  1488. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1489. long error_code; // Backend-specific error code (0 = no error)
  1490. const char *error_string; // Human-readable error description
  1491. // Certificate introspection methods
  1492. std::string subject_cn() const;
  1493. std::string issuer_name() const;
  1494. bool check_hostname(const char *hostname) const;
  1495. std::vector<SanEntry> sans() const;
  1496. bool validity(time_t &not_before, time_t &not_after) const;
  1497. std::string serial() const;
  1498. };
  1499. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1500. // TlsError codes for TLS operations (backend-independent)
  1501. enum class ErrorCode : int {
  1502. Success = 0,
  1503. WantRead, // Non-blocking: need to wait for read
  1504. WantWrite, // Non-blocking: need to wait for write
  1505. PeerClosed, // Peer closed the connection
  1506. Fatal, // Unrecoverable error
  1507. SyscallError, // System call error (check sys_errno)
  1508. CertVerifyFailed, // Certificate verification failed
  1509. HostnameMismatch, // Hostname verification failed
  1510. };
  1511. // TLS error information
  1512. struct TlsError {
  1513. ErrorCode code = ErrorCode::Fatal;
  1514. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1515. int sys_errno = 0; // errno when SyscallError
  1516. // Convert verification error code to human-readable string
  1517. static std::string verify_error_to_string(long error_code);
  1518. };
  1519. // RAII wrapper for peer certificate
  1520. class PeerCert {
  1521. public:
  1522. PeerCert();
  1523. PeerCert(PeerCert &&other) noexcept;
  1524. PeerCert &operator=(PeerCert &&other) noexcept;
  1525. ~PeerCert();
  1526. PeerCert(const PeerCert &) = delete;
  1527. PeerCert &operator=(const PeerCert &) = delete;
  1528. explicit operator bool() const;
  1529. std::string subject_cn() const;
  1530. std::string issuer_name() const;
  1531. bool check_hostname(const char *hostname) const;
  1532. std::vector<SanEntry> sans() const;
  1533. bool validity(time_t &not_before, time_t &not_after) const;
  1534. std::string serial() const;
  1535. private:
  1536. explicit PeerCert(cert_t cert);
  1537. cert_t cert_ = nullptr;
  1538. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1539. };
  1540. // Callback for TLS context setup (used by SSLServer constructor)
  1541. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1542. } // namespace tls
  1543. #endif
  1544. struct Request {
  1545. std::string method;
  1546. std::string path;
  1547. std::string matched_route;
  1548. Params params;
  1549. Headers headers;
  1550. Headers trailers;
  1551. std::string body;
  1552. std::string remote_addr;
  1553. int remote_port = -1;
  1554. std::string local_addr;
  1555. int local_port = -1;
  1556. // for server
  1557. std::string version;
  1558. std::string target;
  1559. MultipartFormData form;
  1560. Ranges ranges;
  1561. Match matches;
  1562. std::unordered_map<std::string, std::string> path_params;
  1563. std::function<bool()> is_connection_closed = []() { return true; };
  1564. // for client
  1565. std::vector<std::string> accept_content_types;
  1566. ResponseHandler response_handler;
  1567. ContentReceiverWithProgress content_receiver;
  1568. DownloadProgress download_progress;
  1569. UploadProgress upload_progress;
  1570. bool has_header(const std::string &key) const;
  1571. std::string get_header_value(const std::string &key, const char *def = "",
  1572. size_t id = 0) const;
  1573. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1574. size_t id = 0) const;
  1575. size_t get_header_value_count(const std::string &key) const;
  1576. void set_header(const std::string &key, const std::string &val);
  1577. bool has_trailer(const std::string &key) const;
  1578. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1579. size_t get_trailer_value_count(const std::string &key) const;
  1580. bool has_param(const std::string &key) const;
  1581. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1582. std::vector<std::string> get_param_values(const std::string &key) const;
  1583. size_t get_param_value_count(const std::string &key) const;
  1584. bool is_multipart_form_data() const;
  1585. // private members...
  1586. bool body_read_started_ = false;
  1587. bool body_consumed_ = false;
  1588. bool expect_100_continue_pending_ = false;
  1589. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1590. size_t content_length_ = 0;
  1591. ContentProvider content_provider_;
  1592. bool is_chunked_content_provider_ = false;
  1593. size_t authorization_count_ = 0;
  1594. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1595. (std::chrono::steady_clock::time_point::min)();
  1596. #ifdef CPPHTTPLIB_SSL_ENABLED
  1597. tls::const_session_t ssl = nullptr;
  1598. tls::PeerCert peer_cert() const;
  1599. std::string sni() const;
  1600. #endif
  1601. };
  1602. namespace detail {
  1603. // Declared up here, away from the rest of the compression helpers, because
  1604. // `Response` stores one.
  1605. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1606. } // namespace detail
  1607. struct Response {
  1608. std::string version;
  1609. int status = -1;
  1610. std::string reason;
  1611. Headers headers;
  1612. Headers trailers;
  1613. std::string body;
  1614. std::string location; // Redirect location
  1615. // User-defined context — set by pre-routing/pre-request handlers and read
  1616. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1617. UserData user_data;
  1618. bool has_header(const std::string &key) const;
  1619. std::string get_header_value(const std::string &key, const char *def = "",
  1620. size_t id = 0) const;
  1621. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1622. size_t id = 0) const;
  1623. size_t get_header_value_count(const std::string &key) const;
  1624. void set_header(const std::string &key, const std::string &val);
  1625. bool has_trailer(const std::string &key) const;
  1626. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1627. size_t get_trailer_value_count(const std::string &key) const;
  1628. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1629. void set_content(const char *s, size_t n, const std::string &content_type);
  1630. void set_content(const std::string &s, const std::string &content_type);
  1631. void set_content(std::string &&s, const std::string &content_type);
  1632. void set_content_provider(
  1633. size_t length, const std::string &content_type, ContentProvider provider,
  1634. ContentProviderResourceReleaser resource_releaser = nullptr);
  1635. void set_content_provider(
  1636. const std::string &content_type, ContentProviderWithoutLength provider,
  1637. ContentProviderResourceReleaser resource_releaser = nullptr);
  1638. void set_chunked_content_provider(
  1639. const std::string &content_type, ContentProviderWithoutLength provider,
  1640. ContentProviderResourceReleaser resource_releaser = nullptr);
  1641. void set_file_content(const std::string &path,
  1642. const std::string &content_type);
  1643. void set_file_content(const std::string &path);
  1644. Response() = default;
  1645. Response(const Response &) = default;
  1646. Response &operator=(const Response &) = default;
  1647. Response(Response &&) = default;
  1648. Response &operator=(Response &&) = default;
  1649. ~Response() {
  1650. if (content_provider_resource_releaser_) {
  1651. content_provider_resource_releaser_(content_provider_success_);
  1652. }
  1653. }
  1654. // private members...
  1655. size_t content_length_ = 0;
  1656. ContentProvider content_provider_;
  1657. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1658. bool is_chunked_content_provider_ = false;
  1659. bool is_file_content_provider_ = false;
  1660. bool content_provider_success_ = false;
  1661. std::string file_content_path_;
  1662. std::string file_content_content_type_;
  1663. // Content coding chosen for the response body, decided once so that the
  1664. // headers and the body cannot disagree: where the file is opened for a
  1665. // file-backed content provider (keeping the ETag honest), and in
  1666. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1667. // for every other kind of response.
  1668. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1669. };
  1670. enum class Error {
  1671. Success = 0,
  1672. Unknown,
  1673. Connection,
  1674. BindIPAddress,
  1675. Read,
  1676. Write,
  1677. ExceedRedirectCount,
  1678. Canceled,
  1679. SSLConnection,
  1680. SSLLoadingCerts,
  1681. SSLServerVerification,
  1682. SSLServerHostnameVerification,
  1683. UnsupportedMultipartBoundaryChars,
  1684. Compression,
  1685. ConnectionTimeout,
  1686. ProxyConnection,
  1687. ConnectionClosed,
  1688. Timeout,
  1689. ResourceExhaustion,
  1690. TooManyFormDataFiles,
  1691. ExceedMaxPayloadSize,
  1692. ExceedUriMaxLength,
  1693. ExceedMaxSocketDescriptorCount,
  1694. InvalidRequestLine,
  1695. InvalidHTTPMethod,
  1696. InvalidHTTPVersion,
  1697. InvalidHeaders,
  1698. MultipartParsing,
  1699. OpenFile,
  1700. Listen,
  1701. GetSockName,
  1702. UnsupportedAddressFamily,
  1703. HTTPParsing,
  1704. InvalidRangeHeader,
  1705. UnsupportedContentEncoding,
  1706. WebSocketHandshake,
  1707. UserCallbackException,
  1708. // For internal use only
  1709. SSLPeerCouldBeClosed_,
  1710. };
  1711. std::string to_string(Error error);
  1712. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1713. class Stream {
  1714. public:
  1715. virtual ~Stream() = default;
  1716. virtual bool is_readable() const = 0;
  1717. virtual bool wait_readable() const = 0;
  1718. virtual bool wait_writable() const = 0;
  1719. virtual bool is_peer_alive() const { return wait_writable(); }
  1720. virtual ssize_t read(char *ptr, size_t size) = 0;
  1721. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1722. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1723. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1724. virtual socket_t socket() const = 0;
  1725. virtual time_t duration() const = 0;
  1726. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1727. (void)sec;
  1728. (void)usec;
  1729. }
  1730. // Bounds the reads from now on to `msec` in total, on top of the timeout of
  1731. // each one. 0 lifts the bound.
  1732. virtual void set_max_timeout(time_t msec) { (void)msec; }
  1733. // Lets a wait for data end early once `interrupted` returns true, so that
  1734. // another thread can stop a blocked read on every platform.
  1735. virtual void set_read_interrupt(std::function<bool()> interrupted) {
  1736. (void)interrupted;
  1737. }
  1738. // Bytes already pulled off the socket and sitting in this stream's own
  1739. // buffer. Exposing them lets a line reader scan for a terminator in one
  1740. // pass instead of asking for a byte at a time. A stream that does no
  1741. // buffering of its own reports none, and readers fall back to read().
  1742. virtual const char *buffered_data(size_t &size) const {
  1743. size = 0;
  1744. return nullptr;
  1745. }
  1746. // Discards `size` bytes previously returned by buffered_data().
  1747. virtual void consume_buffered(size_t size) { (void)size; }
  1748. ssize_t write(const char *ptr);
  1749. ssize_t write(const std::string &s);
  1750. Error get_error() const { return error_; }
  1751. protected:
  1752. Error error_ = Error::Success;
  1753. };
  1754. class TaskQueue {
  1755. public:
  1756. TaskQueue() = default;
  1757. virtual ~TaskQueue() = default;
  1758. virtual bool enqueue(std::function<void()> fn) = 0;
  1759. virtual void shutdown() = 0;
  1760. virtual void on_idle() {}
  1761. };
  1762. class ThreadPool final : public TaskQueue {
  1763. public:
  1764. explicit ThreadPool(
  1765. size_t n, size_t max_n = 0, size_t mqr = 0,
  1766. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1767. ThreadPool(const ThreadPool &) = delete;
  1768. ~ThreadPool() override = default;
  1769. bool enqueue(std::function<void()> fn) override;
  1770. void shutdown() override;
  1771. private:
  1772. void worker(bool is_dynamic);
  1773. void move_to_finished(std::thread::id id);
  1774. void cleanup_finished_threads();
  1775. size_t base_thread_count_;
  1776. size_t max_thread_count_;
  1777. size_t max_queued_requests_;
  1778. time_t idle_timeout_sec_;
  1779. size_t idle_thread_count_;
  1780. bool shutdown_;
  1781. std::list<std::function<void()>> jobs_;
  1782. std::vector<std::thread> threads_; // base threads
  1783. std::list<std::thread> dynamic_threads_; // dynamic threads
  1784. std::vector<std::thread>
  1785. finished_threads_; // exited dynamic threads awaiting join
  1786. std::condition_variable cond_;
  1787. std::mutex mutex_;
  1788. };
  1789. using Logger = std::function<void(const Request &, const Response &)>;
  1790. // Forward declaration for Error type
  1791. enum class Error;
  1792. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1793. using SocketOptions = std::function<void(socket_t sock)>;
  1794. void default_socket_options(socket_t sock);
  1795. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1796. const char *status_message(int status);
  1797. std::string to_string(Error error);
  1798. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1799. std::string get_bearer_token_auth(const Request &req);
  1800. namespace detail {
  1801. class MatcherBase {
  1802. public:
  1803. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1804. virtual ~MatcherBase() = default;
  1805. const std::string &pattern() const { return pattern_; }
  1806. // Match request path and populate its matches and
  1807. virtual bool match(Request &request) const = 0;
  1808. private:
  1809. std::string pattern_;
  1810. };
  1811. /**
  1812. * Captures parameters in request path and stores them in Request::path_params
  1813. *
  1814. * Capture name is a substring of a pattern from : to /.
  1815. * The rest of the pattern is matched against the request path directly
  1816. * Parameters are captured starting from the next character after
  1817. * the end of the last matched static pattern fragment until the next /.
  1818. *
  1819. * Example pattern:
  1820. * "/path/fragments/:capture/more/fragments/:second_capture"
  1821. * Static fragments:
  1822. * "/path/fragments/", "more/fragments/"
  1823. *
  1824. * Given the following request path:
  1825. * "/path/fragments/:1/more/fragments/:2"
  1826. * the resulting capture will be
  1827. * {{"capture", "1"}, {"second_capture", "2"}}
  1828. */
  1829. class PathParamsMatcher final : public MatcherBase {
  1830. public:
  1831. PathParamsMatcher(const std::string &pattern);
  1832. bool match(Request &request) const override;
  1833. private:
  1834. // Treat segment separators as the end of path parameter capture
  1835. // Does not need to handle query parameters as they are parsed before path
  1836. // matching
  1837. static constexpr char separator = '/';
  1838. // Contains static path fragments to match against, excluding the '/' after
  1839. // path params
  1840. // Fragments are separated by path params
  1841. std::vector<std::string> static_fragments_;
  1842. // Stores the names of the path parameters to be used as keys in the
  1843. // Request::path_params map
  1844. std::vector<std::string> param_names_;
  1845. };
  1846. /**
  1847. * Performs std::regex_match on request path
  1848. * and stores the result in Request::matches
  1849. *
  1850. * Note that regex match is performed directly on the whole request.
  1851. * This means that wildcard patterns may match multiple path segments with /:
  1852. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1853. */
  1854. class RegexMatcher final : public MatcherBase {
  1855. public:
  1856. RegexMatcher(const std::string &pattern)
  1857. : MatcherBase(pattern), regex_(pattern) {}
  1858. bool match(Request &request) const override;
  1859. private:
  1860. std::regex regex_;
  1861. };
  1862. int close_socket(socket_t sock) noexcept;
  1863. bool is_accept_resource_error();
  1864. bool is_accept_transient_error();
  1865. ssize_t write_headers(Stream &strm, const Headers &headers);
  1866. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1867. time_t usec);
  1868. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1869. const std::string &boundary);
  1870. ContentProvider
  1871. make_multipart_content_provider(const UploadFormDataItems &items,
  1872. const std::string &boundary);
  1873. } // namespace detail
  1874. bool is_valid_multipart_boundary(const std::string &boundary);
  1875. // Serializer for multipart/form-data request bodies. The boundary is owned
  1876. // by the writer so that per-part framing and the final terminator always
  1877. // agree. Field names and filenames are escaped following the WHATWG HTML
  1878. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1879. // in content types.
  1880. class MultipartFormDataWriter {
  1881. public:
  1882. MultipartFormDataWriter();
  1883. // precondition: is_valid_multipart_boundary(boundary)
  1884. explicit MultipartFormDataWriter(std::string boundary);
  1885. const std::string &boundary() const;
  1886. std::string content_type() const;
  1887. // In-memory items -> whole body (known length)
  1888. std::string serialize(const UploadFormDataItems &items) const;
  1889. size_t content_length(const UploadFormDataItems &items) const;
  1890. // Per-part framing for streaming via a content provider
  1891. std::string item_begin(const UploadFormData &item) const;
  1892. static std::string item_end();
  1893. std::string finish() const;
  1894. private:
  1895. std::string boundary_;
  1896. };
  1897. class Server {
  1898. public:
  1899. using Handler = std::function<void(const Request &, Response &)>;
  1900. using ExceptionHandler =
  1901. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1902. enum class HandlerResponse {
  1903. Handled,
  1904. Unhandled,
  1905. };
  1906. using HandlerWithResponse =
  1907. std::function<HandlerResponse(const Request &, Response &)>;
  1908. using HandlerWithContentReader = std::function<void(
  1909. const Request &, Response &, const ContentReader &content_reader)>;
  1910. using Expect100ContinueHandler =
  1911. std::function<int(const Request &, Response &)>;
  1912. using StartHandler = std::function<void()>;
  1913. using WebSocketHandler =
  1914. std::function<void(const Request &, ws::WebSocket &)>;
  1915. using SubProtocolSelector =
  1916. std::function<std::string(const std::vector<std::string> &protocols)>;
  1917. Server();
  1918. virtual ~Server();
  1919. virtual bool is_valid() const;
  1920. Server &Get(const std::string &pattern, Handler handler);
  1921. Server &Post(const std::string &pattern, Handler handler);
  1922. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1923. Server &Put(const std::string &pattern, Handler handler);
  1924. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1925. Server &Patch(const std::string &pattern, Handler handler);
  1926. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1927. Server &Delete(const std::string &pattern, Handler handler);
  1928. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1929. Server &Options(const std::string &pattern, Handler handler);
  1930. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1931. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1932. // server accept it; an unregistered method is still rejected with 400.
  1933. // `method` must be a valid HTTP method token and must not be one of the
  1934. // built-in methods, which have their own registration functions above. A
  1935. // rejected registration makes is_valid() return false, so listen() fails.
  1936. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1937. Handler handler);
  1938. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1939. HandlerWithContentReader handler);
  1940. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1941. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1942. SubProtocolSelector sub_protocol_selector);
  1943. bool set_base_dir(const std::string &dir,
  1944. const std::string &mount_point = std::string());
  1945. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1946. Headers headers = Headers());
  1947. bool remove_mount_point(const std::string &mount_point);
  1948. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1949. const std::string &mime);
  1950. Server &set_default_file_mimetype(const std::string &mime);
  1951. Server &set_file_request_handler(Handler handler);
  1952. template <class ErrorHandlerFunc>
  1953. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1954. return set_error_handler_core(
  1955. std::forward<ErrorHandlerFunc>(handler),
  1956. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1957. }
  1958. Server &set_exception_handler(ExceptionHandler handler);
  1959. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1960. Server &set_post_routing_handler(Handler handler);
  1961. Server &set_pre_request_handler(HandlerWithResponse handler);
  1962. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1963. Server &set_start_handler(StartHandler handler);
  1964. Server &set_logger(Logger logger);
  1965. Server &set_pre_compression_logger(Logger logger);
  1966. Server &set_error_logger(ErrorLogger error_logger);
  1967. Server &set_address_family(int family);
  1968. Server &set_tcp_nodelay(bool on);
  1969. Server &set_ipv6_v6only(bool on);
  1970. Server &set_socket_options(SocketOptions socket_options);
  1971. Server &set_default_headers(Headers headers);
  1972. Server &
  1973. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1974. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1975. Server &set_keep_alive_max_count(size_t count);
  1976. Server &set_keep_alive_timeout(time_t sec);
  1977. template <class Rep, class Period>
  1978. Server &
  1979. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1980. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1981. template <class Rep, class Period>
  1982. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1983. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1984. template <class Rep, class Period>
  1985. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1986. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1987. template <class Rep, class Period>
  1988. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1989. Server &set_payload_max_length(size_t length);
  1990. Server &set_compress(bool on);
  1991. Server &set_static_file_compression(bool on);
  1992. Server &set_static_file_compression_min_length(size_t length);
  1993. Server &set_static_file_compression_max_length(size_t length);
  1994. Server &set_websocket_ping_interval(time_t sec);
  1995. template <class Rep, class Period>
  1996. Server &set_websocket_ping_interval(
  1997. const std::chrono::duration<Rep, Period> &duration);
  1998. Server &set_websocket_max_missed_pongs(int count);
  1999. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  2000. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  2001. bool listen_after_bind();
  2002. bool listen(const std::string &host, int port, int socket_flags = 0);
  2003. bool is_running() const;
  2004. void wait_until_ready() const;
  2005. void stop() noexcept;
  2006. void decommission();
  2007. std::function<TaskQueue *(void)> new_task_queue;
  2008. protected:
  2009. bool process_request(Stream &strm, const std::string &remote_addr,
  2010. int remote_port, const std::string &local_addr,
  2011. int local_port, bool close_connection,
  2012. bool &connection_closed,
  2013. const std::function<void(Request &)> &setup_request,
  2014. bool *websocket_upgraded = nullptr);
  2015. // Runs the per-connection serving loop and stops an exception thrown by a
  2016. // user callback from escaping the worker thread.
  2017. //
  2018. // process_request() wraps only routing() and the hooks before a WebSocket
  2019. // upgrade in a try/catch. Content providers, the post-routing, error,
  2020. // logging and expect-100 handlers and WebSocket handlers all run outside
  2021. // it, and the task queue calls the job without a catch, so an exception
  2022. // from any of those would terminate the process.
  2023. //
  2024. // No 500 is possible here: by the time a content provider runs, the status
  2025. // line and headers are already on the wire. Report it through the error
  2026. // logger and drop the connection, which is what the peer observes either
  2027. // way. Other connections are unaffected.
  2028. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  2029. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  2030. return serve();
  2031. #else
  2032. try {
  2033. return serve();
  2034. } catch (...) {
  2035. // The error logger is a user callback too, so it must not be able to
  2036. // throw the guard back open.
  2037. try {
  2038. output_error_log(Error::UserCallbackException, nullptr);
  2039. } catch (...) {}
  2040. return false;
  2041. }
  2042. #endif
  2043. }
  2044. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  2045. // stop() takes the listening socket away; listen() then waits for handlers
  2046. bool is_stopping() const { return svr_sock_ == INVALID_SOCKET; }
  2047. std::vector<std::string> trusted_proxies_;
  2048. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  2049. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  2050. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  2051. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  2052. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  2053. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  2054. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  2055. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  2056. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2057. bool compress_ = true;
  2058. bool static_file_compression_ = false;
  2059. size_t static_file_compression_min_length_ =
  2060. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  2061. size_t static_file_compression_max_length_ =
  2062. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  2063. time_t websocket_ping_interval_sec_ =
  2064. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  2065. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  2066. private:
  2067. using Handlers =
  2068. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2069. using HandlersForContentReader =
  2070. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2071. HandlerWithContentReader>>;
  2072. // Both handler tables for one custom method live in a single entry, so that
  2073. // routing() needs only one map lookup per request to reach either of them.
  2074. struct CustomHandlerEntry {
  2075. Handlers handlers;
  2076. HandlersForContentReader handlers_for_content_reader;
  2077. };
  2078. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2079. static std::unique_ptr<detail::MatcherBase>
  2080. make_matcher(const std::string &pattern);
  2081. static const std::set<std::string> &builtin_methods();
  2082. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2083. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2084. template <typename H>
  2085. Server &add_handler(
  2086. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2087. const std::string &pattern, H handler) {
  2088. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2089. return *this;
  2090. }
  2091. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2092. Server &set_error_handler_core(Handler handler, std::false_type);
  2093. socket_t create_server_socket(const std::string &host, int port,
  2094. int socket_flags,
  2095. SocketOptions socket_options) const;
  2096. int bind_internal(const std::string &host, int port, int socket_flags);
  2097. bool listen_internal();
  2098. bool routing(Request &req, Response &res, Stream &strm,
  2099. bool skip_pre_routing);
  2100. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  2101. bool handle_exception(Request &req, Response &res);
  2102. #endif
  2103. bool handle_file_request(Request &req, Response &res);
  2104. bool check_if_not_modified(const Request &req, Response &res,
  2105. const std::string &etag, time_t mtime) const;
  2106. bool check_if_range(Request &req, const std::string &etag,
  2107. time_t mtime) const;
  2108. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2109. Stream &strm);
  2110. bool dispatch_request_for_content_reader(
  2111. Request &req, Response &res, ContentReader content_reader,
  2112. const HandlersForContentReader &handlers) const;
  2113. bool parse_request_line(const char *s, Request &req) const;
  2114. detail::EncodingType static_file_encoding(const Request &req,
  2115. const Response &res,
  2116. const std::string &content_type,
  2117. size_t length) const;
  2118. bool apply_static_file_compression(const Request &req, Response &res) const;
  2119. void apply_ranges(const Request &req, Response &res,
  2120. std::string &content_type, std::string &boundary) const;
  2121. bool write_response(Stream &strm, bool close_connection, Request &req,
  2122. Response &res);
  2123. bool write_response_with_content(Stream &strm, bool close_connection,
  2124. const Request &req, Response &res);
  2125. bool write_response_core(Stream &strm, bool close_connection,
  2126. const Request &req, Response &res,
  2127. bool need_apply_ranges);
  2128. bool write_content_with_provider(Stream &strm, const Request &req,
  2129. Response &res, const std::string &boundary,
  2130. const std::string &content_type);
  2131. bool read_content(Stream &strm, Request &req, Response &res);
  2132. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2133. Response &res,
  2134. ContentReceiver receiver,
  2135. FormDataHeader multipart_header,
  2136. ContentReceiver multipart_receiver);
  2137. bool read_content_core(Stream &strm, Request &req, Response &res,
  2138. ContentReceiver receiver,
  2139. FormDataHeader multipart_header,
  2140. ContentReceiver multipart_receiver) const;
  2141. virtual bool process_and_close_socket(socket_t sock);
  2142. void output_log(const Request &req, const Response &res) const;
  2143. void output_pre_compression_log(const Request &req,
  2144. const Response &res) const;
  2145. void output_error_log(const Error &err, const Request *req) const;
  2146. std::atomic<bool> is_running_{false};
  2147. std::atomic<bool> is_decommissioned{false};
  2148. // Set when CustomRoute() refuses a registration. Written before listen(),
  2149. // read by is_valid() on the same thread, so it needs no synchronization.
  2150. bool has_invalid_registration_ = false;
  2151. struct MountPointEntry {
  2152. std::string mount_point;
  2153. std::string base_dir;
  2154. std::string resolved_base_dir;
  2155. Headers headers;
  2156. };
  2157. std::vector<MountPointEntry> base_dirs_;
  2158. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2159. std::string default_file_mimetype_ = "application/octet-stream";
  2160. Handler file_request_handler_;
  2161. Handlers get_handlers_;
  2162. Handlers post_handlers_;
  2163. HandlersForContentReader post_handlers_for_content_reader_;
  2164. Handlers put_handlers_;
  2165. HandlersForContentReader put_handlers_for_content_reader_;
  2166. Handlers patch_handlers_;
  2167. HandlersForContentReader patch_handlers_for_content_reader_;
  2168. Handlers delete_handlers_;
  2169. HandlersForContentReader delete_handlers_for_content_reader_;
  2170. Handlers options_handlers_;
  2171. CustomHandlers custom_handlers_;
  2172. struct WebSocketHandlerEntry {
  2173. std::unique_ptr<detail::MatcherBase> matcher;
  2174. WebSocketHandler handler;
  2175. SubProtocolSelector sub_protocol_selector;
  2176. };
  2177. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2178. WebSocketHandlers websocket_handlers_;
  2179. HandlerWithResponse error_handler_;
  2180. ExceptionHandler exception_handler_;
  2181. HandlerWithResponse pre_routing_handler_;
  2182. Handler post_routing_handler_;
  2183. HandlerWithResponse pre_request_handler_;
  2184. Expect100ContinueHandler expect_100_continue_handler_;
  2185. StartHandler start_handler_;
  2186. mutable std::mutex logger_mutex_;
  2187. Logger logger_;
  2188. Logger pre_compression_logger_;
  2189. ErrorLogger error_logger_;
  2190. int address_family_ = AF_UNSPEC;
  2191. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2192. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2193. SocketOptions socket_options_ = default_socket_options;
  2194. Headers default_headers_;
  2195. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2196. detail::write_headers;
  2197. };
  2198. class Result {
  2199. public:
  2200. Result() = default;
  2201. Result(std::unique_ptr<Response> &&res, Error err,
  2202. Headers &&request_headers = Headers{})
  2203. : res_(std::move(res)), err_(err),
  2204. request_headers_(std::move(request_headers)) {}
  2205. // Response
  2206. operator bool() const { return res_ != nullptr; }
  2207. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2208. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2209. const Response &value() const { return *res_; }
  2210. Response &value() { return *res_; }
  2211. const Response &operator*() const { return *res_; }
  2212. Response &operator*() { return *res_; }
  2213. const Response *operator->() const { return res_.get(); }
  2214. Response *operator->() { return res_.get(); }
  2215. // Error
  2216. Error error() const { return err_; }
  2217. // Request Headers
  2218. bool has_request_header(const std::string &key) const;
  2219. std::string get_request_header_value(const std::string &key,
  2220. const char *def = "",
  2221. size_t id = 0) const;
  2222. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2223. size_t id = 0) const;
  2224. size_t get_request_header_value_count(const std::string &key) const;
  2225. private:
  2226. std::unique_ptr<Response> res_;
  2227. Error err_ = Error::Unknown;
  2228. Headers request_headers_;
  2229. #ifdef CPPHTTPLIB_SSL_ENABLED
  2230. public:
  2231. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2232. int ssl_error)
  2233. : res_(std::move(res)), err_(err),
  2234. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2235. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2236. int ssl_error, uint64_t ssl_backend_error)
  2237. : res_(std::move(res)), err_(err),
  2238. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2239. ssl_backend_error_(ssl_backend_error) {}
  2240. int ssl_error() const { return ssl_error_; }
  2241. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2242. private:
  2243. int ssl_error_ = 0;
  2244. uint64_t ssl_backend_error_ = 0;
  2245. #endif
  2246. };
  2247. struct ClientConnection {
  2248. socket_t sock = INVALID_SOCKET;
  2249. bool is_open() const { return sock != INVALID_SOCKET; }
  2250. ClientConnection() = default;
  2251. ~ClientConnection();
  2252. ClientConnection(const ClientConnection &) = delete;
  2253. ClientConnection &operator=(const ClientConnection &) = delete;
  2254. ClientConnection(ClientConnection &&other) noexcept
  2255. : sock(other.sock)
  2256. #ifdef CPPHTTPLIB_SSL_ENABLED
  2257. ,
  2258. session(other.session)
  2259. #endif
  2260. {
  2261. other.sock = INVALID_SOCKET;
  2262. #ifdef CPPHTTPLIB_SSL_ENABLED
  2263. other.session = nullptr;
  2264. #endif
  2265. }
  2266. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2267. if (this != &other) {
  2268. sock = other.sock;
  2269. other.sock = INVALID_SOCKET;
  2270. #ifdef CPPHTTPLIB_SSL_ENABLED
  2271. session = other.session;
  2272. other.session = nullptr;
  2273. #endif
  2274. }
  2275. return *this;
  2276. }
  2277. #ifdef CPPHTTPLIB_SSL_ENABLED
  2278. tls::session_t session = nullptr;
  2279. #endif
  2280. };
  2281. namespace detail {
  2282. struct ChunkedDecoder;
  2283. struct BodyReader {
  2284. Stream *stream = nullptr;
  2285. bool has_content_length = false;
  2286. size_t content_length = 0;
  2287. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2288. size_t bytes_read = 0;
  2289. bool chunked = false;
  2290. bool eof = false;
  2291. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2292. Error last_error = Error::Success;
  2293. ssize_t read(char *buf, size_t len);
  2294. bool has_error() const { return last_error != Error::Success; }
  2295. };
  2296. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2297. size_t len) {
  2298. (void)stream;
  2299. return br.read(buf, len);
  2300. }
  2301. class decompressor;
  2302. enum class NoProxyKind {
  2303. Wildcard, // "*"
  2304. HostnameSuffix, // "example.com" or ".example.com"
  2305. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2306. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2307. };
  2308. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2309. // Lets one CIDR matcher cover both families.
  2310. using IPBytes = std::array<uint8_t, 16>;
  2311. struct NoProxyEntry {
  2312. NoProxyKind kind = NoProxyKind::Wildcard;
  2313. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2314. IPBytes net{};
  2315. int prefix_bits = 0;
  2316. };
  2317. struct NormalizedTarget {
  2318. std::string hostname; // lowercase; brackets and trailing dot removed
  2319. bool is_ipv4 = false;
  2320. bool is_ipv6 = false;
  2321. IPBytes ip{};
  2322. };
  2323. } // namespace detail
  2324. class ClientImpl {
  2325. public:
  2326. explicit ClientImpl(const std::string &host);
  2327. explicit ClientImpl(const std::string &host, int port);
  2328. explicit ClientImpl(const std::string &host, int port,
  2329. const std::string &client_cert_path,
  2330. const std::string &client_key_path);
  2331. virtual ~ClientImpl();
  2332. virtual bool is_valid() const;
  2333. struct StreamHandle {
  2334. std::unique_ptr<Response> response;
  2335. Error error = Error::Success;
  2336. StreamHandle() = default;
  2337. StreamHandle(const StreamHandle &) = delete;
  2338. StreamHandle &operator=(const StreamHandle &) = delete;
  2339. StreamHandle(StreamHandle &&) = default;
  2340. StreamHandle &operator=(StreamHandle &&) = default;
  2341. ~StreamHandle() = default;
  2342. bool is_valid() const {
  2343. return response != nullptr && error == Error::Success;
  2344. }
  2345. ssize_t read(char *buf, size_t len);
  2346. void parse_trailers_if_needed();
  2347. Error get_read_error() const { return body_reader_.last_error; }
  2348. bool has_read_error() const { return body_reader_.has_error(); }
  2349. bool trailers_parsed_ = false;
  2350. private:
  2351. friend class ClientImpl;
  2352. friend class sse::SSEClient;
  2353. ssize_t read_with_decompression(char *buf, size_t len);
  2354. std::unique_ptr<ClientConnection> connection_;
  2355. std::unique_ptr<Stream> socket_stream_;
  2356. Stream *stream_ = nullptr;
  2357. detail::BodyReader body_reader_;
  2358. std::unique_ptr<detail::decompressor> decompressor_;
  2359. std::string decompress_buffer_;
  2360. size_t decompress_offset_ = 0;
  2361. size_t decompressed_bytes_read_ = 0;
  2362. };
  2363. // clang-format off
  2364. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2365. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2366. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2367. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2368. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2369. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2370. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2371. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2372. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2373. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2374. Result Head(const std::string &path);
  2375. Result Head(const std::string &path, const Headers &headers);
  2376. Result Post(const std::string &path);
  2377. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2378. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2379. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2380. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2381. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2382. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2383. Result Post(const std::string &path, const Params &params);
  2384. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2385. Result Post(const std::string &path, const Headers &headers);
  2386. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2387. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2388. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2389. 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);
  2390. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2391. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2392. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2393. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2394. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2395. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2396. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2397. Result Put(const std::string &path);
  2398. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2399. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2400. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2401. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2402. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2403. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2404. Result Put(const std::string &path, const Params &params);
  2405. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2406. Result Put(const std::string &path, const Headers &headers);
  2407. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2408. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2409. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2410. 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);
  2411. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2412. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2413. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2414. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2415. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2416. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2417. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2418. Result Patch(const std::string &path);
  2419. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2420. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2421. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2422. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2423. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2424. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2425. Result Patch(const std::string &path, const Params &params);
  2426. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2427. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2428. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2429. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2430. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2431. 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);
  2432. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2433. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2434. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2435. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2436. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2437. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2438. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2439. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2440. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2441. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2442. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2443. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2444. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2445. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2446. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2447. Result Options(const std::string &path);
  2448. Result Options(const std::string &path, const Headers &headers);
  2449. // clang-format on
  2450. // Streaming API: Open a stream for reading response body incrementally
  2451. // Socket ownership is transferred to StreamHandle for true streaming
  2452. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2453. StreamHandle open_stream(const std::string &method, const std::string &path,
  2454. const Params &params = {},
  2455. const Headers &headers = {},
  2456. const std::string &body = {},
  2457. const std::string &content_type = {});
  2458. bool send(Request &req, Response &res, Error &error);
  2459. Result send(const Request &req);
  2460. void stop();
  2461. std::string host() const;
  2462. int port() const;
  2463. size_t is_socket_open() const;
  2464. socket_t socket() const;
  2465. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  2466. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2467. void
  2468. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2469. void
  2470. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2471. void set_default_headers(Headers headers);
  2472. void
  2473. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2474. void set_address_family(int family);
  2475. void set_tcp_nodelay(bool on);
  2476. void set_ipv6_v6only(bool on);
  2477. void set_socket_options(SocketOptions socket_options);
  2478. void set_connection_timeout(time_t sec, time_t usec = 0);
  2479. template <class Rep, class Period>
  2480. void
  2481. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2482. void set_read_timeout(time_t sec, time_t usec = 0);
  2483. template <class Rep, class Period>
  2484. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2485. void set_write_timeout(time_t sec, time_t usec = 0);
  2486. template <class Rep, class Period>
  2487. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2488. void set_max_timeout(time_t msec);
  2489. template <class Rep, class Period>
  2490. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2491. void set_basic_auth(const std::string &username, const std::string &password);
  2492. void set_bearer_token_auth(const std::string &token);
  2493. void set_keep_alive(bool on);
  2494. void set_follow_location(bool on);
  2495. void set_path_encode(bool on);
  2496. void set_compress(bool on);
  2497. void set_decompress(bool on);
  2498. void set_payload_max_length(size_t length);
  2499. void set_interface(const std::string &intf);
  2500. void set_proxy(const std::string &host, int port);
  2501. void set_proxy_basic_auth(const std::string &username,
  2502. const std::string &password);
  2503. void set_proxy_bearer_token_auth(const std::string &token);
  2504. void set_no_proxy(const std::vector<std::string> &patterns);
  2505. void set_logger(Logger logger);
  2506. void set_error_logger(ErrorLogger error_logger);
  2507. protected:
  2508. struct Socket {
  2509. socket_t sock = INVALID_SOCKET;
  2510. // For Mbed TLS compatibility: start_time for request timeout tracking
  2511. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2512. bool is_open() const { return sock != INVALID_SOCKET; }
  2513. #ifdef CPPHTTPLIB_SSL_ENABLED
  2514. tls::session_t ssl = nullptr;
  2515. #endif
  2516. };
  2517. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2518. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2519. virtual bool setup_proxy_connection(
  2520. Socket &socket,
  2521. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2522. Response &res, bool &success, Error &error);
  2523. bool is_proxy_enabled_for_host(const std::string &host) const;
  2524. // All of:
  2525. // shutdown_ssl
  2526. // shutdown_socket
  2527. // close_socket
  2528. // disconnect
  2529. // should ONLY be called on socket_ with socket_mutex_ locked, or on a
  2530. // connection being opened, and only when no other thread is using it.
  2531. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2532. void shutdown_socket(Socket &socket) const;
  2533. void close_socket(Socket &socket);
  2534. void disconnect(bool gracefully);
  2535. // Under socket_mutex_: whether the connection kept alive can take another
  2536. // request. One with anything to read, or one set up under TLS settings
  2537. // changed since, is closed instead.
  2538. bool socket_reusable();
  2539. // Makes socket_ ready for a request, with socket_mutex_ held by guard. A new
  2540. // connection is opened without the lock, so that stop() can end it.
  2541. bool
  2542. prepare_socket(std::unique_lock<std::mutex> &guard,
  2543. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2544. Response &res, bool &success, Error &error);
  2545. // TLS settings apply as a connection is set up, so a change makes the
  2546. // connection kept alive unfit for the next request.
  2547. void tls_settings_changed() { tls_settings_version_++; }
  2548. std::string make_request_target(const Request &req) const;
  2549. bool process_request(Stream &strm, Request &req, Response &res,
  2550. bool close_connection, Error &error);
  2551. bool write_content_with_provider(Stream &strm, const Request &req,
  2552. Error &error) const;
  2553. void output_log(const Request &req, const Response &res) const;
  2554. void output_error_log(const Error &err, const Request *req) const;
  2555. // Socket endpoint information
  2556. const std::string host_;
  2557. const int port_;
  2558. // Current open socket
  2559. Socket socket_;
  2560. mutable std::mutex socket_mutex_;
  2561. std::recursive_mutex request_mutex_;
  2562. // How many send() calls are running on this client, guarded by
  2563. // request_mutex_
  2564. size_t send_depth_ = 0;
  2565. // Also guarded by request_mutex_
  2566. size_t socket_tls_settings_version_ = 0;
  2567. // These are all protected under socket_mutex
  2568. size_t socket_requests_in_flight_ = 0;
  2569. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2570. bool socket_should_be_closed_when_request_is_done_ = false;
  2571. // Set by stop(), cleared as a send() or an open_stream() starts. Its waits
  2572. // poll it: shutdown() does not reach a connection being opened, nor wake a
  2573. // read on Windows.
  2574. std::atomic<bool> stop_requested_{false};
  2575. std::function<bool()> stop_interrupt() const {
  2576. return [this] { return stop_requested_.load(); };
  2577. }
  2578. std::atomic<size_t> tls_settings_version_{0};
  2579. // Hostname to connection target map. The value is an IP literal or another
  2580. // hostname; only the connection target changes, never the identity.
  2581. std::map<std::string, std::string> addr_map_;
  2582. // Hostname to CONNECT target map, used only through a proxy.
  2583. std::map<std::string, std::string> tunnel_addr_map_;
  2584. // Default headers
  2585. Headers default_headers_;
  2586. // Header writer
  2587. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2588. detail::write_headers;
  2589. // Settings
  2590. std::string client_cert_path_;
  2591. std::string client_key_path_;
  2592. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2593. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2594. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2595. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2596. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2597. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2598. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2599. std::string basic_auth_username_;
  2600. std::string basic_auth_password_;
  2601. std::string bearer_token_auth_token_;
  2602. bool keep_alive_ = false;
  2603. bool follow_location_ = false;
  2604. bool path_encode_ = true;
  2605. int address_family_ = AF_UNSPEC;
  2606. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2607. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2608. SocketOptions socket_options_ = nullptr;
  2609. bool compress_ = false;
  2610. bool decompress_ = true;
  2611. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2612. bool has_payload_max_length_ = false;
  2613. std::string interface_;
  2614. std::string proxy_host_;
  2615. int proxy_port_ = -1;
  2616. std::string proxy_basic_auth_username_;
  2617. std::string proxy_basic_auth_password_;
  2618. std::string proxy_bearer_token_auth_token_;
  2619. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2620. mutable detail::NormalizedTarget host_normalized_;
  2621. mutable bool host_normalized_valid_ = false;
  2622. mutable std::mutex logger_mutex_;
  2623. Logger logger_;
  2624. ErrorLogger error_logger_;
  2625. private:
  2626. bool send_(Request &req, Response &res, Error &error);
  2627. Result send_(Request &&req);
  2628. socket_t create_client_socket(Error &error) const;
  2629. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2630. bool skip_100_continue = true) const;
  2631. bool write_request(Stream &strm, Request &req, bool close_connection,
  2632. Error &error, bool skip_body, bool &rejected_locally);
  2633. bool write_request_body(Stream &strm, Request &req, Error &error);
  2634. void prepare_default_headers(Request &r, bool for_stream,
  2635. const std::string &ct);
  2636. bool redirect(Request &req, Response &res, Error &error);
  2637. bool create_redirect_client(const std::string &scheme,
  2638. const std::string &host, int port, Request &req,
  2639. Response &res, const std::string &path,
  2640. const std::string &location, Error &error);
  2641. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2642. bool handle_request(Stream &strm, Request &req, Response &res,
  2643. bool close_connection, Error &error);
  2644. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2645. Request &req, const char *body, size_t content_length,
  2646. ContentProvider content_provider,
  2647. ContentProviderWithoutLength content_provider_without_length,
  2648. const std::string &content_type, ContentReceiver content_receiver,
  2649. Error &error);
  2650. Result send_with_content_provider_and_receiver(
  2651. const std::string &method, const std::string &path,
  2652. const Headers &headers, const char *body, size_t content_length,
  2653. ContentProvider content_provider,
  2654. ContentProviderWithoutLength content_provider_without_length,
  2655. const std::string &content_type, ContentReceiver content_receiver,
  2656. UploadProgress progress);
  2657. ContentProviderWithoutLength get_multipart_content_provider(
  2658. const std::string &boundary, const UploadFormDataItems &items,
  2659. const FormDataProviderItems &provider_items) const;
  2660. virtual bool
  2661. process_socket(const Socket &socket,
  2662. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2663. std::function<bool(Stream &strm)> callback);
  2664. virtual bool is_ssl() const;
  2665. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2666. StreamHandle open_stream_(Request &req);
  2667. void add_credential_headers(Request &req);
  2668. std::string proxy_target_prefix() const;
  2669. #ifdef CPPHTTPLIB_SSL_ENABLED
  2670. public:
  2671. void set_digest_auth(const std::string &username,
  2672. const std::string &password);
  2673. void set_proxy_digest_auth(const std::string &username,
  2674. const std::string &password);
  2675. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2676. const std::string &ca_cert_dir_path = std::string());
  2677. void enable_server_certificate_verification(bool enabled);
  2678. void enable_server_hostname_verification(bool enabled);
  2679. void enable_system_ca(bool enabled);
  2680. protected:
  2681. std::string digest_auth_username_;
  2682. std::string digest_auth_password_;
  2683. std::string proxy_digest_auth_username_;
  2684. std::string proxy_digest_auth_password_;
  2685. std::string ca_cert_file_path_;
  2686. std::string ca_cert_dir_path_;
  2687. bool server_certificate_verification_ = true;
  2688. bool server_hostname_verification_ = true;
  2689. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2690. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2691. int last_ssl_error_ = 0;
  2692. uint64_t last_backend_error_ = 0;
  2693. #endif
  2694. };
  2695. namespace detail {
  2696. // Stands in for a client that Client could not make from its arguments, so a
  2697. // request fails rather than going through a null pointer.
  2698. class InvalidClientImpl final : public ClientImpl {
  2699. public:
  2700. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2701. bool is_valid() const override { return false; }
  2702. private:
  2703. bool create_and_connect_socket(Socket &, Error &error) override {
  2704. error = Error::Connection;
  2705. return false;
  2706. }
  2707. };
  2708. } // namespace detail
  2709. class Client {
  2710. public:
  2711. // Universal interface
  2712. explicit Client(const std::string &scheme_host_port);
  2713. explicit Client(const std::string &scheme_host_port,
  2714. const std::string &client_cert_path,
  2715. const std::string &client_key_path);
  2716. // HTTP only interface
  2717. explicit Client(const std::string &host, int port);
  2718. explicit Client(const std::string &host, int port,
  2719. const std::string &client_cert_path,
  2720. const std::string &client_key_path);
  2721. Client(Client &&) = default;
  2722. Client &operator=(Client &&) = default;
  2723. ~Client();
  2724. bool is_valid() const;
  2725. // clang-format off
  2726. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2727. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2728. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2729. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2730. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2731. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2732. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2733. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2734. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2735. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2736. Result Head(const std::string &path);
  2737. Result Head(const std::string &path, const Headers &headers);
  2738. Result Post(const std::string &path);
  2739. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2740. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2741. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2742. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2743. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2744. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2745. Result Post(const std::string &path, const Params &params);
  2746. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2747. Result Post(const std::string &path, const Headers &headers);
  2748. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2749. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2750. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2751. 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);
  2752. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2753. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2754. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2755. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2756. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2757. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2758. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2759. Result Put(const std::string &path);
  2760. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2761. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2762. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2763. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2764. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2765. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2766. Result Put(const std::string &path, const Params &params);
  2767. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2768. Result Put(const std::string &path, const Headers &headers);
  2769. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2770. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2771. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2772. 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);
  2773. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2774. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2775. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2776. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2777. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2778. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2779. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2780. Result Patch(const std::string &path);
  2781. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2782. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2783. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2784. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2785. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2786. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2787. Result Patch(const std::string &path, const Params &params);
  2788. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2789. Result Patch(const std::string &path, const Headers &headers);
  2790. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2791. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2792. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2793. 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);
  2794. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2795. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2796. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2797. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2798. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2799. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2800. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2801. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2802. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2803. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2804. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2805. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2806. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2807. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2808. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2809. Result Options(const std::string &path);
  2810. Result Options(const std::string &path, const Headers &headers);
  2811. // clang-format on
  2812. // Streaming API: Open a stream for reading response body incrementally
  2813. // Socket ownership is transferred to StreamHandle for true streaming
  2814. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2815. ClientImpl::StreamHandle open_stream(const std::string &method,
  2816. const std::string &path,
  2817. const Params &params = {},
  2818. const Headers &headers = {},
  2819. const std::string &body = {},
  2820. const std::string &content_type = {});
  2821. bool send(Request &req, Response &res, Error &error);
  2822. Result send(const Request &req);
  2823. void stop();
  2824. std::string host() const;
  2825. int port() const;
  2826. size_t is_socket_open() const;
  2827. socket_t socket() const;
  2828. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  2829. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2830. void
  2831. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2832. void
  2833. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2834. void set_default_headers(Headers headers);
  2835. void
  2836. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2837. void set_address_family(int family);
  2838. void set_tcp_nodelay(bool on);
  2839. void set_socket_options(SocketOptions socket_options);
  2840. void set_connection_timeout(time_t sec, time_t usec = 0);
  2841. template <class Rep, class Period>
  2842. void
  2843. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2844. void set_read_timeout(time_t sec, time_t usec = 0);
  2845. template <class Rep, class Period>
  2846. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2847. void set_write_timeout(time_t sec, time_t usec = 0);
  2848. template <class Rep, class Period>
  2849. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2850. void set_max_timeout(time_t msec);
  2851. template <class Rep, class Period>
  2852. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2853. void set_basic_auth(const std::string &username, const std::string &password);
  2854. void set_bearer_token_auth(const std::string &token);
  2855. void set_keep_alive(bool on);
  2856. void set_follow_location(bool on);
  2857. void set_path_encode(bool on);
  2858. void set_compress(bool on);
  2859. void set_decompress(bool on);
  2860. void set_payload_max_length(size_t length);
  2861. void set_interface(const std::string &intf);
  2862. void set_proxy(const std::string &host, int port);
  2863. void set_proxy_basic_auth(const std::string &username,
  2864. const std::string &password);
  2865. void set_proxy_bearer_token_auth(const std::string &token);
  2866. void set_no_proxy(const std::vector<std::string> &patterns);
  2867. void set_logger(Logger logger);
  2868. void set_error_logger(ErrorLogger error_logger);
  2869. private:
  2870. std::unique_ptr<ClientImpl> cli_;
  2871. #ifdef CPPHTTPLIB_SSL_ENABLED
  2872. public:
  2873. void set_digest_auth(const std::string &username,
  2874. const std::string &password);
  2875. void set_proxy_digest_auth(const std::string &username,
  2876. const std::string &password);
  2877. void enable_server_certificate_verification(bool enabled);
  2878. void enable_server_hostname_verification(bool enabled);
  2879. void enable_system_ca(bool enabled);
  2880. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2881. const std::string &ca_cert_dir_path = std::string());
  2882. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2883. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2884. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2885. void set_session_verifier(
  2886. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2887. tls::ctx_t tls_context() const;
  2888. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2889. void enable_windows_certificate_verification(bool enabled);
  2890. #endif
  2891. private:
  2892. bool is_ssl_ = false;
  2893. #endif
  2894. };
  2895. #ifdef CPPHTTPLIB_SSL_ENABLED
  2896. class SSLServer : public Server {
  2897. public:
  2898. SSLServer(const char *cert_path, const char *private_key_path,
  2899. const char *client_ca_cert_file_path = nullptr,
  2900. const char *client_ca_cert_dir_path = nullptr,
  2901. const char *private_key_password = nullptr);
  2902. struct PemMemory {
  2903. const char *cert_pem;
  2904. size_t cert_pem_len;
  2905. const char *key_pem;
  2906. size_t key_pem_len;
  2907. const char *client_ca_pem;
  2908. size_t client_ca_pem_len;
  2909. const char *private_key_password;
  2910. };
  2911. explicit SSLServer(const PemMemory &pem);
  2912. // The callback receives the ctx_t handle which can be cast to the
  2913. // appropriate backend type (SSL_CTX* for OpenSSL,
  2914. // tls::impl::MbedTlsContext* for Mbed TLS)
  2915. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2916. ~SSLServer() override;
  2917. bool is_valid() const override;
  2918. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2919. const char *client_ca_pem = nullptr,
  2920. const char *password = nullptr);
  2921. tls::ctx_t tls_context() const { return ctx_; }
  2922. int ssl_last_error() const { return last_ssl_error_; }
  2923. private:
  2924. bool process_and_close_socket(socket_t sock) override;
  2925. tls::ctx_t ctx_ = nullptr;
  2926. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2927. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2928. // bounds, and new ones wait while it is pending so that they cannot keep it
  2929. // waiting.
  2930. std::mutex ctx_mutex_;
  2931. std::condition_variable ctx_cv_;
  2932. size_t handshakes_in_progress_ = 0;
  2933. size_t updates_pending_ = 0;
  2934. int last_ssl_error_ = 0;
  2935. };
  2936. class SSLClient final : public ClientImpl {
  2937. public:
  2938. explicit SSLClient(const std::string &host);
  2939. explicit SSLClient(const std::string &host, int port);
  2940. explicit SSLClient(const std::string &host, int port,
  2941. const std::string &client_cert_path,
  2942. const std::string &client_key_path,
  2943. const std::string &private_key_password = std::string());
  2944. struct PemMemory {
  2945. const char *cert_pem;
  2946. size_t cert_pem_len;
  2947. const char *key_pem;
  2948. size_t key_pem_len;
  2949. const char *private_key_password;
  2950. };
  2951. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2952. ~SSLClient() override;
  2953. bool is_valid() const override;
  2954. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2955. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2956. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2957. // Post-handshake session verifier (backend-independent)
  2958. void set_session_verifier(
  2959. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2960. tls::ctx_t tls_context() const { return ctx_; }
  2961. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2962. void enable_windows_certificate_verification(bool enabled);
  2963. #endif
  2964. private:
  2965. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2966. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2967. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2968. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2969. bool
  2970. process_socket(const Socket &socket,
  2971. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2972. std::function<bool(Stream &strm)> callback) override;
  2973. bool is_ssl() const override;
  2974. bool setup_proxy_connection(
  2975. Socket &socket,
  2976. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2977. Response &res, bool &success, Error &error) override;
  2978. bool connect_with_proxy(
  2979. Socket &sock,
  2980. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2981. Response &res, bool &success, Error &error);
  2982. bool initialize_ssl(Socket &socket, Error &error);
  2983. void init_ctx();
  2984. void reset_ctx_on_error();
  2985. bool load_certs();
  2986. tls::ctx_t ctx_ = nullptr;
  2987. std::mutex ctx_mutex_;
  2988. std::once_flag initialize_cert_;
  2989. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2990. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2991. bool ca_cert_store_set_ = false;
  2992. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  2993. // no certificate, so that a CA that failed to come through fails
  2994. // verification instead of letting the system CAs in.
  2995. bool custom_ca_loaded_ = false;
  2996. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2997. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2998. // set_server_certificate_verifier() installed there.
  2999. tls::VerifyCallback server_certificate_verifier_;
  3000. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  3001. bool enable_windows_cert_verification_ = true;
  3002. #endif
  3003. friend class ClientImpl;
  3004. };
  3005. #endif // CPPHTTPLIB_SSL_ENABLED
  3006. namespace detail {
  3007. template <typename T, typename U>
  3008. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  3009. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  3010. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  3011. duration - std::chrono::seconds(sec))
  3012. .count();
  3013. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  3014. }
  3015. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  3016. return N - 1;
  3017. }
  3018. inline bool is_numeric(const std::string &str) {
  3019. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  3020. }
  3021. // std::ranges::next(first, n, last) for C++11
  3022. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  3023. for (; n > 0 && first != last; --n) {
  3024. ++first;
  3025. }
  3026. return first;
  3027. }
  3028. inline size_t get_header_value_u64(const Headers &headers,
  3029. const std::string &key, size_t def,
  3030. size_t id, bool &is_invalid_value) {
  3031. is_invalid_value = false;
  3032. auto rng = headers.equal_range(key);
  3033. auto it = bounded_next(rng.first, id, rng.second);
  3034. if (it != rng.second) {
  3035. if (is_numeric(it->second)) {
  3036. // Parse at size_t width so an out-of-range Content-Length is reported
  3037. // rather than silently saturated/truncated (a value above 2^32 would
  3038. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  3039. // and return SIZE_MAX so the existing oversized-value guards reject it.
  3040. size_t val = 0;
  3041. const auto &s = it->second;
  3042. auto r = from_chars(s.data(), s.data() + s.size(), val);
  3043. if (r.ec == std::errc::result_out_of_range) {
  3044. is_invalid_value = true;
  3045. return (std::numeric_limits<size_t>::max)();
  3046. }
  3047. return val;
  3048. } else {
  3049. is_invalid_value = true;
  3050. }
  3051. }
  3052. return def;
  3053. }
  3054. inline size_t get_header_value_u64(const Headers &headers,
  3055. const std::string &key, size_t def,
  3056. size_t id) {
  3057. auto dummy = false;
  3058. return get_header_value_u64(headers, key, def, id, dummy);
  3059. }
  3060. } // namespace detail
  3061. template <class Rep, class Period>
  3062. inline Server &
  3063. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3064. detail::duration_to_sec_and_usec(
  3065. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3066. return *this;
  3067. }
  3068. template <class Rep, class Period>
  3069. inline Server &
  3070. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3071. detail::duration_to_sec_and_usec(
  3072. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3073. return *this;
  3074. }
  3075. template <class Rep, class Period>
  3076. inline Server &
  3077. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  3078. detail::duration_to_sec_and_usec(
  3079. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  3080. return *this;
  3081. }
  3082. template <class Rep, class Period>
  3083. inline void ClientImpl::set_connection_timeout(
  3084. const std::chrono::duration<Rep, Period> &duration) {
  3085. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3086. set_connection_timeout(sec, usec);
  3087. });
  3088. }
  3089. template <class Rep, class Period>
  3090. inline void ClientImpl::set_read_timeout(
  3091. const std::chrono::duration<Rep, Period> &duration) {
  3092. detail::duration_to_sec_and_usec(
  3093. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3094. }
  3095. template <class Rep, class Period>
  3096. inline void ClientImpl::set_write_timeout(
  3097. const std::chrono::duration<Rep, Period> &duration) {
  3098. detail::duration_to_sec_and_usec(
  3099. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3100. }
  3101. template <class Rep, class Period>
  3102. inline void ClientImpl::set_max_timeout(
  3103. const std::chrono::duration<Rep, Period> &duration) {
  3104. auto msec =
  3105. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  3106. set_max_timeout(static_cast<time_t>(msec));
  3107. }
  3108. template <class Rep, class Period>
  3109. inline void Client::set_connection_timeout(
  3110. const std::chrono::duration<Rep, Period> &duration) {
  3111. cli_->set_connection_timeout(duration);
  3112. }
  3113. template <class Rep, class Period>
  3114. inline void
  3115. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3116. cli_->set_read_timeout(duration);
  3117. }
  3118. template <class Rep, class Period>
  3119. inline void
  3120. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3121. cli_->set_write_timeout(duration);
  3122. }
  3123. inline void Client::set_max_timeout(time_t msec) {
  3124. cli_->set_max_timeout(msec);
  3125. }
  3126. template <class Rep, class Period>
  3127. inline void
  3128. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3129. cli_->set_max_timeout(duration);
  3130. }
  3131. /*
  3132. * Forward declarations and types that will be part of the .h file if split into
  3133. * .h + .cc.
  3134. */
  3135. std::string hosted_at(const std::string &hostname);
  3136. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3137. // JavaScript-style URL encoding/decoding functions
  3138. std::string encode_uri_component(const std::string &value);
  3139. std::string encode_uri(const std::string &value);
  3140. std::string decode_uri_component(const std::string &value);
  3141. std::string decode_uri(const std::string &value);
  3142. // RFC 3986 compliant URL component encoding/decoding functions
  3143. std::string encode_path_component(const std::string &component);
  3144. std::string decode_path_component(const std::string &component);
  3145. std::string encode_query_component(const std::string &component,
  3146. bool space_as_plus = true);
  3147. std::string decode_query_component(const std::string &component,
  3148. bool plus_as_space = true);
  3149. std::string sanitize_filename(const std::string &filename);
  3150. std::string append_query_params(const std::string &path, const Params &params);
  3151. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3152. std::pair<std::string, std::string>
  3153. make_basic_authentication_header(const std::string &username,
  3154. const std::string &password,
  3155. bool is_proxy = false);
  3156. namespace detail {
  3157. #if defined(_WIN32)
  3158. inline std::wstring u8string_to_wstring(const char *s) {
  3159. if (!s) { return std::wstring(); }
  3160. auto len = static_cast<int>(strlen(s));
  3161. if (!len) { return std::wstring(); }
  3162. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3163. if (!wlen) { return std::wstring(); }
  3164. std::wstring ws;
  3165. ws.resize(wlen);
  3166. wlen = ::MultiByteToWideChar(
  3167. CP_UTF8, 0, s, len,
  3168. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3169. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3170. return ws;
  3171. }
  3172. #endif
  3173. struct FileStat {
  3174. FileStat(const std::string &path);
  3175. bool is_file() const;
  3176. bool is_dir() const;
  3177. time_t mtime() const;
  3178. size_t size() const;
  3179. private:
  3180. #if defined(_WIN32)
  3181. struct _stat st_;
  3182. #else
  3183. struct stat st_;
  3184. #endif
  3185. int ret_ = -1;
  3186. };
  3187. std::string make_host_and_port_string(const std::string &host, int port,
  3188. bool is_ssl);
  3189. template <typename T>
  3190. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3191. Error &error);
  3192. bool write_data(Stream &strm, const char *d, size_t l);
  3193. std::string trim_copy(const std::string &s);
  3194. void divide(
  3195. const char *data, std::size_t size, char d,
  3196. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3197. fn);
  3198. void divide(
  3199. const std::string &str, char d,
  3200. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3201. fn);
  3202. void split(const char *b, const char *e, char d,
  3203. std::function<void(const char *, const char *)> fn);
  3204. void split(const char *b, const char *e, char d, size_t m,
  3205. std::function<void(const char *, const char *)> fn);
  3206. bool split_find(const char *b, const char *e, char d,
  3207. std::function<bool(const char *, const char *)> fn);
  3208. bool has_header_token(const Headers &headers, const std::string &key,
  3209. const std::string &token);
  3210. std::string websocket_accept_key(const std::string &client_key);
  3211. bool is_websocket_upgrade(const Request &req);
  3212. bool process_client_socket(
  3213. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3214. time_t write_timeout_sec, time_t write_timeout_usec,
  3215. time_t max_timeout_msec,
  3216. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3217. std::function<bool(Stream &)> callback);
  3218. socket_t create_client_socket(
  3219. const std::string &host, const std::string &ip, int port,
  3220. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  3221. SocketOptions socket_options, time_t connection_timeout_sec,
  3222. time_t connection_timeout_usec, time_t read_timeout_sec,
  3223. time_t read_timeout_usec, time_t write_timeout_sec,
  3224. time_t write_timeout_usec, const std::string &intf, Error &error,
  3225. const std::function<bool()> &interrupted = nullptr);
  3226. const char *get_header_value(const Headers &headers, const std::string &key,
  3227. const char *def, size_t id);
  3228. std::string get_combined_header_value(const Headers &headers,
  3229. const std::string &key);
  3230. std::string params_to_query_str(const Params &params);
  3231. void parse_query_text(const char *data, std::size_t size, Params &params);
  3232. void parse_query_text(const std::string &s, Params &params);
  3233. bool parse_multipart_boundary(const std::string &content_type,
  3234. std::string &boundary);
  3235. bool parse_range_header(const std::string &s, Ranges &ranges);
  3236. bool parse_accept_header(const std::string &s,
  3237. std::vector<std::string> &content_types);
  3238. void parse_disposition_params(const std::string &s, Params &params);
  3239. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3240. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3241. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3242. EncodingType encoding_type(const Request &req, const Response &res,
  3243. const std::string &content_type);
  3244. EncodingType encoding_type(const Request &req, const Response &res);
  3245. // Creates a connected pair of stream sockets that child processes do not
  3246. // inherit. Windows has no socketpair(), so it is emulated there.
  3247. bool create_socket_pair(socket_t sv[2]);
  3248. // Ends a Poller's wait() from another thread. The poller watches fd() for
  3249. // readability, level-triggered, and calls drain() when it is reported.
  3250. class PollerWaker {
  3251. public:
  3252. ~PollerWaker();
  3253. // An eventfd on Linux, a socket pair elsewhere.
  3254. bool open();
  3255. socket_t fd() const { return fd_; }
  3256. // An address inside the poller, which no caller's token can be.
  3257. uintptr_t token() const { return reinterpret_cast<uintptr_t>(this); }
  3258. // From any thread. While one is pending, later calls make no syscall.
  3259. void wake() noexcept;
  3260. void drain() noexcept;
  3261. private:
  3262. socket_t fd_ = INVALID_SOCKET;
  3263. socket_t pair_fd_ = INVALID_SOCKET; // the end wake() writes; none on Linux
  3264. std::atomic<bool> pending_{false};
  3265. };
  3266. // One-shot readiness notification for a reactor:
  3267. // - A delivered event disarms the descriptor; arm() it again to wait again.
  3268. // - A hang-up or an error counts as readable.
  3269. // - Only an unarmed descriptor may be armed, and an armed one must be
  3270. // disarmed before it is closed.
  3271. // - wake() may be called from any thread; the rest belongs to one thread.
  3272. class Poller {
  3273. public:
  3274. using Token = uintptr_t;
  3275. virtual ~Poller() = default;
  3276. virtual bool arm(socket_t fd, Token token) = 0;
  3277. virtual void disarm(socket_t fd) = 0;
  3278. // Fills `ready` in no particular order and returns whether wake() was
  3279. // called. A negative timeout waits until either happens.
  3280. virtual bool wait(int timeout_ms, std::vector<Token> &ready) = 0;
  3281. virtual void wake() noexcept = 0;
  3282. };
  3283. // poll() on POSIX, WSAPoll() on Windows. Works everywhere.
  3284. class PollPoller final : public Poller {
  3285. public:
  3286. // nullptr when the descriptors cannot be created.
  3287. static std::unique_ptr<Poller> create();
  3288. bool arm(socket_t fd, Token token) override;
  3289. void disarm(socket_t fd) override;
  3290. bool wait(int timeout_ms, std::vector<Token> &ready) override;
  3291. void wake() noexcept override { waker_.wake(); }
  3292. private:
  3293. PollPoller() = default;
  3294. void remove_at(size_t index);
  3295. PollerWaker waker_;
  3296. // fds_[0] is the waker's, which is always armed; tokens_[i] belongs to
  3297. // fds_[i].
  3298. std::vector<struct pollfd> fds_;
  3299. std::vector<Token> tokens_;
  3300. std::unordered_map<socket_t, size_t> index_;
  3301. };
  3302. #ifdef __linux__
  3303. // epoll with EPOLLONESHOT. Waits in O(ready) instead of O(armed).
  3304. class EpollPoller final : public Poller {
  3305. public:
  3306. // nullptr when the descriptors cannot be created.
  3307. static std::unique_ptr<Poller> create();
  3308. ~EpollPoller() override;
  3309. bool arm(socket_t fd, Token token) override;
  3310. void disarm(socket_t fd) override;
  3311. bool wait(int timeout_ms, std::vector<Token> &ready) override;
  3312. void wake() noexcept override { waker_.wake(); }
  3313. private:
  3314. EpollPoller() = default;
  3315. int epfd_ = -1;
  3316. PollerWaker waker_; // always armed
  3317. std::vector<struct epoll_event> events_;
  3318. };
  3319. #endif
  3320. #ifdef CPPHTTPLIB_KQUEUE_POLLER
  3321. // kqueue with EV_ONESHOT. Waits in O(ready) instead of O(armed).
  3322. class KqueuePoller final : public Poller {
  3323. public:
  3324. // nullptr when the descriptors cannot be created.
  3325. static std::unique_ptr<Poller> create();
  3326. ~KqueuePoller() override;
  3327. bool arm(socket_t fd, Token token) override;
  3328. void disarm(socket_t fd) override;
  3329. bool wait(int timeout_ms, std::vector<Token> &ready) override;
  3330. void wake() noexcept override { waker_.wake(); }
  3331. private:
  3332. KqueuePoller() = default;
  3333. int kq_ = -1;
  3334. PollerWaker waker_; // always armed
  3335. std::vector<struct kevent> events_;
  3336. };
  3337. #endif
  3338. // The best poller for this platform, or nullptr when it cannot be created.
  3339. std::unique_ptr<Poller> make_poller();
  3340. class BufferStream final : public Stream {
  3341. public:
  3342. BufferStream() = default;
  3343. ~BufferStream() override = default;
  3344. bool is_readable() const override;
  3345. bool wait_readable() const override;
  3346. bool wait_writable() const override;
  3347. ssize_t read(char *ptr, size_t size) override;
  3348. ssize_t write(const char *ptr, size_t size) override;
  3349. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3350. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3351. socket_t socket() const override;
  3352. time_t duration() const override;
  3353. const std::string &get_buffer() const;
  3354. private:
  3355. std::string buffer;
  3356. size_t position = 0;
  3357. };
  3358. class compressor {
  3359. public:
  3360. virtual ~compressor() = default;
  3361. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3362. virtual bool compress(const char *data, size_t data_length, bool last,
  3363. Callback callback) = 0;
  3364. };
  3365. class decompressor {
  3366. public:
  3367. virtual ~decompressor() = default;
  3368. virtual bool is_valid() const = 0;
  3369. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3370. virtual bool decompress(const char *data, size_t data_length,
  3371. Callback callback) = 0;
  3372. };
  3373. class nocompressor final : public compressor {
  3374. public:
  3375. ~nocompressor() override = default;
  3376. bool compress(const char *data, size_t data_length, bool /*last*/,
  3377. Callback callback) override;
  3378. };
  3379. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3380. class gzip_compressor final : public compressor {
  3381. public:
  3382. gzip_compressor();
  3383. ~gzip_compressor() override;
  3384. bool compress(const char *data, size_t data_length, bool last,
  3385. Callback callback) override;
  3386. private:
  3387. bool is_valid_ = false;
  3388. z_stream strm_;
  3389. };
  3390. class gzip_decompressor final : public decompressor {
  3391. public:
  3392. gzip_decompressor();
  3393. ~gzip_decompressor() override;
  3394. bool is_valid() const override;
  3395. bool decompress(const char *data, size_t data_length,
  3396. Callback callback) override;
  3397. private:
  3398. bool is_valid_ = false;
  3399. z_stream strm_;
  3400. };
  3401. #endif
  3402. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3403. class brotli_compressor final : public compressor {
  3404. public:
  3405. brotli_compressor();
  3406. ~brotli_compressor();
  3407. bool compress(const char *data, size_t data_length, bool last,
  3408. Callback callback) override;
  3409. private:
  3410. BrotliEncoderState *state_ = nullptr;
  3411. };
  3412. class brotli_decompressor final : public decompressor {
  3413. public:
  3414. brotli_decompressor();
  3415. ~brotli_decompressor();
  3416. bool is_valid() const override;
  3417. bool decompress(const char *data, size_t data_length,
  3418. Callback callback) override;
  3419. private:
  3420. BrotliDecoderResult decoder_r;
  3421. BrotliDecoderState *decoder_s = nullptr;
  3422. };
  3423. #endif
  3424. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3425. class zstd_compressor : public compressor {
  3426. public:
  3427. zstd_compressor();
  3428. ~zstd_compressor();
  3429. bool compress(const char *data, size_t data_length, bool last,
  3430. Callback callback) override;
  3431. private:
  3432. ZSTD_CCtx *ctx_ = nullptr;
  3433. };
  3434. class zstd_decompressor : public decompressor {
  3435. public:
  3436. zstd_decompressor();
  3437. ~zstd_decompressor();
  3438. bool is_valid() const override;
  3439. bool decompress(const char *data, size_t data_length,
  3440. Callback callback) override;
  3441. private:
  3442. ZSTD_DCtx *ctx_ = nullptr;
  3443. };
  3444. #endif
  3445. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3446. // to store data. The call can set memory on stack for performance.
  3447. class stream_line_reader {
  3448. public:
  3449. stream_line_reader(Stream &strm, char *fixed_buffer,
  3450. size_t fixed_buffer_size);
  3451. const char *ptr() const;
  3452. size_t size() const;
  3453. bool end_with_crlf() const;
  3454. bool getline();
  3455. private:
  3456. void append(char c);
  3457. void append(const char *data, size_t size);
  3458. Stream &strm_;
  3459. char *fixed_buffer_;
  3460. const size_t fixed_buffer_size_;
  3461. size_t fixed_buffer_used_size_ = 0;
  3462. std::string growable_buffer_;
  3463. };
  3464. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3465. const Headers &src_headers);
  3466. struct ChunkedDecoder {
  3467. Stream &strm;
  3468. size_t chunk_remaining = 0;
  3469. bool finished = false;
  3470. char line_buf[64];
  3471. size_t last_chunk_total = 0;
  3472. size_t last_chunk_offset = 0;
  3473. size_t overhead = 0;
  3474. explicit ChunkedDecoder(Stream &s);
  3475. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3476. size_t &out_chunk_total);
  3477. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3478. };
  3479. // A regular file opened to be served: mapped on Windows, read with pread()
  3480. // elsewhere.
  3481. class mmap {
  3482. public:
  3483. mmap(const char *path);
  3484. ~mmap();
  3485. bool open(const char *path);
  3486. void close();
  3487. bool is_open() const;
  3488. size_t size() const;
  3489. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3490. // down to 0, if the file has shrunk since it was opened.
  3491. size_t read(size_t offset, char *buf, size_t len) const;
  3492. private:
  3493. #if defined(_WIN32)
  3494. HANDLE hFile_ = NULL;
  3495. HANDLE hMapping_ = NULL;
  3496. void *addr_ = nullptr;
  3497. bool is_open_empty_file = false;
  3498. #else
  3499. int fd_ = -1;
  3500. #endif
  3501. size_t size_ = 0;
  3502. };
  3503. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3504. namespace fields {
  3505. bool is_token_char(char c);
  3506. bool is_token(const std::string &s);
  3507. bool is_field_name(const std::string &s);
  3508. bool is_vchar(char c);
  3509. bool is_obs_text(char c);
  3510. bool is_field_vchar(char c);
  3511. bool is_field_content(const std::string &s);
  3512. bool is_field_value(const std::string &s);
  3513. bool is_field_valid(const std::string &name, const std::string &value);
  3514. bool is_request_target(const std::string &s);
  3515. bool is_host(const std::string &s);
  3516. } // namespace fields
  3517. } // namespace detail
  3518. /*
  3519. * TLS Abstraction Layer Declarations
  3520. */
  3521. #ifdef CPPHTTPLIB_SSL_ENABLED
  3522. // TLS abstraction layer - backend-specific type declarations
  3523. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3524. namespace tls {
  3525. namespace impl {
  3526. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3527. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3528. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3529. struct MbedTlsContext {
  3530. mbedtls_ssl_config conf;
  3531. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3532. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3533. mbedtls_entropy_context entropy;
  3534. mbedtls_ctr_drbg_context ctr_drbg;
  3535. #endif
  3536. mbedtls_x509_crt ca_chain;
  3537. mbedtls_x509_crt own_cert;
  3538. mbedtls_pk_context own_key;
  3539. bool is_server = false;
  3540. // Peer certificate required (set_verify_client()); a client defaults to true
  3541. bool verify_client = false;
  3542. // Set by tls::set_verify_callback().
  3543. VerifyCallback verify_callback;
  3544. MbedTlsContext();
  3545. ~MbedTlsContext();
  3546. MbedTlsContext(const MbedTlsContext &) = delete;
  3547. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3548. };
  3549. } // namespace impl
  3550. } // namespace tls
  3551. #endif
  3552. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3553. namespace tls {
  3554. namespace impl {
  3555. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3556. // This struct is accessible via tls::impl for use in SSL context
  3557. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3558. struct WolfSSLContext {
  3559. WOLFSSL_CTX *ctx = nullptr;
  3560. bool is_server = false;
  3561. // Peer certificate required (set_verify_client()); a client defaults to true
  3562. bool verify_client = false;
  3563. // Replaced under verify_callback_mutex()
  3564. std::shared_ptr<VerifyCallback> verify_callback;
  3565. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3566. WolfSSLContext();
  3567. ~WolfSSLContext();
  3568. WolfSSLContext(const WolfSSLContext &) = delete;
  3569. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3570. };
  3571. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3572. struct WolfSSLCAStore {
  3573. std::string pem_data;
  3574. };
  3575. } // namespace impl
  3576. } // namespace tls
  3577. #endif
  3578. #endif // CPPHTTPLIB_SSL_ENABLED
  3579. namespace stream {
  3580. class Result {
  3581. public:
  3582. Result();
  3583. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3584. Result(Result &&other) noexcept;
  3585. Result &operator=(Result &&other) noexcept;
  3586. Result(const Result &) = delete;
  3587. Result &operator=(const Result &) = delete;
  3588. // Response info
  3589. bool is_valid() const;
  3590. explicit operator bool() const;
  3591. int status() const;
  3592. const Headers &headers() const;
  3593. std::string get_header_value(const std::string &key,
  3594. const char *def = "") const;
  3595. bool has_header(const std::string &key) const;
  3596. Error error() const;
  3597. Error read_error() const;
  3598. bool has_read_error() const;
  3599. // Stream reading
  3600. bool next();
  3601. const char *data() const;
  3602. size_t size() const;
  3603. std::string read_all();
  3604. private:
  3605. ClientImpl::StreamHandle handle_;
  3606. std::string buffer_;
  3607. size_t current_size_ = 0;
  3608. size_t chunk_size_;
  3609. bool finished_ = false;
  3610. };
  3611. // GET
  3612. template <typename ClientType>
  3613. inline Result Get(ClientType &cli, const std::string &path,
  3614. size_t chunk_size = 8192) {
  3615. return Result{cli.open_stream("GET", path), chunk_size};
  3616. }
  3617. template <typename ClientType>
  3618. inline Result Get(ClientType &cli, const std::string &path,
  3619. const Headers &headers, size_t chunk_size = 8192) {
  3620. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3621. }
  3622. template <typename ClientType>
  3623. inline Result Get(ClientType &cli, const std::string &path,
  3624. const Params &params, size_t chunk_size = 8192) {
  3625. return Result{cli.open_stream("GET", path, params), chunk_size};
  3626. }
  3627. template <typename ClientType>
  3628. inline Result Get(ClientType &cli, const std::string &path,
  3629. const Params &params, const Headers &headers,
  3630. size_t chunk_size = 8192) {
  3631. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3632. }
  3633. // POST
  3634. template <typename ClientType>
  3635. inline Result Post(ClientType &cli, const std::string &path,
  3636. const std::string &body, const std::string &content_type,
  3637. size_t chunk_size = 8192) {
  3638. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3639. chunk_size};
  3640. }
  3641. template <typename ClientType>
  3642. inline Result Post(ClientType &cli, const std::string &path,
  3643. const Headers &headers, const std::string &body,
  3644. const std::string &content_type, size_t chunk_size = 8192) {
  3645. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3646. chunk_size};
  3647. }
  3648. template <typename ClientType>
  3649. inline Result Post(ClientType &cli, const std::string &path,
  3650. const Params &params, const std::string &body,
  3651. const std::string &content_type, size_t chunk_size = 8192) {
  3652. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3653. chunk_size};
  3654. }
  3655. template <typename ClientType>
  3656. inline Result Post(ClientType &cli, const std::string &path,
  3657. const Params &params, const Headers &headers,
  3658. const std::string &body, const std::string &content_type,
  3659. size_t chunk_size = 8192) {
  3660. return Result{
  3661. cli.open_stream("POST", path, params, headers, body, content_type),
  3662. chunk_size};
  3663. }
  3664. // PUT
  3665. template <typename ClientType>
  3666. inline Result Put(ClientType &cli, const std::string &path,
  3667. const std::string &body, const std::string &content_type,
  3668. size_t chunk_size = 8192) {
  3669. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3670. chunk_size};
  3671. }
  3672. template <typename ClientType>
  3673. inline Result Put(ClientType &cli, const std::string &path,
  3674. const Headers &headers, const std::string &body,
  3675. const std::string &content_type, size_t chunk_size = 8192) {
  3676. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3677. chunk_size};
  3678. }
  3679. template <typename ClientType>
  3680. inline Result Put(ClientType &cli, const std::string &path,
  3681. const Params &params, const std::string &body,
  3682. const std::string &content_type, size_t chunk_size = 8192) {
  3683. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3684. chunk_size};
  3685. }
  3686. template <typename ClientType>
  3687. inline Result Put(ClientType &cli, const std::string &path,
  3688. const Params &params, const Headers &headers,
  3689. const std::string &body, const std::string &content_type,
  3690. size_t chunk_size = 8192) {
  3691. return Result{
  3692. cli.open_stream("PUT", path, params, headers, body, content_type),
  3693. chunk_size};
  3694. }
  3695. // PATCH
  3696. template <typename ClientType>
  3697. inline Result Patch(ClientType &cli, const std::string &path,
  3698. const std::string &body, const std::string &content_type,
  3699. size_t chunk_size = 8192) {
  3700. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3701. chunk_size};
  3702. }
  3703. template <typename ClientType>
  3704. inline Result Patch(ClientType &cli, const std::string &path,
  3705. const Headers &headers, const std::string &body,
  3706. const std::string &content_type, size_t chunk_size = 8192) {
  3707. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3708. chunk_size};
  3709. }
  3710. template <typename ClientType>
  3711. inline Result Patch(ClientType &cli, const std::string &path,
  3712. const Params &params, const std::string &body,
  3713. const std::string &content_type, size_t chunk_size = 8192) {
  3714. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3715. chunk_size};
  3716. }
  3717. template <typename ClientType>
  3718. inline Result Patch(ClientType &cli, const std::string &path,
  3719. const Params &params, const Headers &headers,
  3720. const std::string &body, const std::string &content_type,
  3721. size_t chunk_size = 8192) {
  3722. return Result{
  3723. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3724. chunk_size};
  3725. }
  3726. // DELETE
  3727. template <typename ClientType>
  3728. inline Result Delete(ClientType &cli, const std::string &path,
  3729. size_t chunk_size = 8192) {
  3730. return Result{cli.open_stream("DELETE", path), chunk_size};
  3731. }
  3732. template <typename ClientType>
  3733. inline Result Delete(ClientType &cli, const std::string &path,
  3734. const Headers &headers, size_t chunk_size = 8192) {
  3735. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3736. }
  3737. template <typename ClientType>
  3738. inline Result Delete(ClientType &cli, const std::string &path,
  3739. const std::string &body, const std::string &content_type,
  3740. size_t chunk_size = 8192) {
  3741. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3742. chunk_size};
  3743. }
  3744. template <typename ClientType>
  3745. inline Result Delete(ClientType &cli, const std::string &path,
  3746. const Headers &headers, const std::string &body,
  3747. const std::string &content_type,
  3748. size_t chunk_size = 8192) {
  3749. return Result{
  3750. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3751. chunk_size};
  3752. }
  3753. template <typename ClientType>
  3754. inline Result Delete(ClientType &cli, const std::string &path,
  3755. const Params &params, size_t chunk_size = 8192) {
  3756. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3757. }
  3758. template <typename ClientType>
  3759. inline Result Delete(ClientType &cli, const std::string &path,
  3760. const Params &params, const Headers &headers,
  3761. size_t chunk_size = 8192) {
  3762. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3763. }
  3764. template <typename ClientType>
  3765. inline Result Delete(ClientType &cli, const std::string &path,
  3766. const Params &params, const std::string &body,
  3767. const std::string &content_type,
  3768. size_t chunk_size = 8192) {
  3769. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3770. chunk_size};
  3771. }
  3772. template <typename ClientType>
  3773. inline Result Delete(ClientType &cli, const std::string &path,
  3774. const Params &params, const Headers &headers,
  3775. const std::string &body, const std::string &content_type,
  3776. size_t chunk_size = 8192) {
  3777. return Result{
  3778. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3779. chunk_size};
  3780. }
  3781. // HEAD
  3782. template <typename ClientType>
  3783. inline Result Head(ClientType &cli, const std::string &path,
  3784. size_t chunk_size = 8192) {
  3785. return Result{cli.open_stream("HEAD", path), chunk_size};
  3786. }
  3787. template <typename ClientType>
  3788. inline Result Head(ClientType &cli, const std::string &path,
  3789. const Headers &headers, size_t chunk_size = 8192) {
  3790. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3791. }
  3792. template <typename ClientType>
  3793. inline Result Head(ClientType &cli, const std::string &path,
  3794. const Params &params, size_t chunk_size = 8192) {
  3795. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3796. }
  3797. template <typename ClientType>
  3798. inline Result Head(ClientType &cli, const std::string &path,
  3799. const Params &params, const Headers &headers,
  3800. size_t chunk_size = 8192) {
  3801. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3802. }
  3803. // OPTIONS
  3804. template <typename ClientType>
  3805. inline Result Options(ClientType &cli, const std::string &path,
  3806. size_t chunk_size = 8192) {
  3807. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3808. }
  3809. template <typename ClientType>
  3810. inline Result Options(ClientType &cli, const std::string &path,
  3811. const Headers &headers, size_t chunk_size = 8192) {
  3812. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3813. }
  3814. template <typename ClientType>
  3815. inline Result Options(ClientType &cli, const std::string &path,
  3816. const Params &params, size_t chunk_size = 8192) {
  3817. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3818. }
  3819. template <typename ClientType>
  3820. inline Result Options(ClientType &cli, const std::string &path,
  3821. const Params &params, const Headers &headers,
  3822. size_t chunk_size = 8192) {
  3823. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3824. }
  3825. } // namespace stream
  3826. namespace sse {
  3827. struct SSEMessage {
  3828. std::string event; // Event type (default: "message")
  3829. std::string data; // Event payload
  3830. std::string id; // Event ID for Last-Event-ID header
  3831. SSEMessage();
  3832. void clear();
  3833. };
  3834. class SSEClient {
  3835. public:
  3836. using MessageHandler = std::function<void(const SSEMessage &)>;
  3837. using ErrorHandler = std::function<void(Error)>;
  3838. using OpenHandler = std::function<void()>;
  3839. SSEClient(Client &client, const std::string &path);
  3840. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3841. ~SSEClient();
  3842. SSEClient(const SSEClient &) = delete;
  3843. SSEClient &operator=(const SSEClient &) = delete;
  3844. // Event handlers
  3845. SSEClient &on_message(MessageHandler handler);
  3846. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3847. SSEClient &on_open(OpenHandler handler);
  3848. SSEClient &on_error(ErrorHandler handler);
  3849. SSEClient &set_reconnect_interval(int ms);
  3850. SSEClient &set_max_reconnect_attempts(int n);
  3851. // Update headers (thread-safe)
  3852. SSEClient &set_headers(const Headers &headers);
  3853. // State accessors
  3854. bool is_connected() const;
  3855. std::string last_event_id() const;
  3856. // Blocking start - runs event loop with auto-reconnect
  3857. void start();
  3858. // Non-blocking start - runs in background thread
  3859. void start_async();
  3860. // Stop the client (thread-safe)
  3861. void stop();
  3862. private:
  3863. void run_event_loop();
  3864. void dispatch_event(const SSEMessage &msg);
  3865. bool should_reconnect(int count) const;
  3866. void wait_for_reconnect();
  3867. // Client and path
  3868. Client &client_;
  3869. std::string path_;
  3870. Headers headers_;
  3871. mutable std::mutex headers_mutex_;
  3872. // Callbacks
  3873. MessageHandler on_message_;
  3874. std::map<std::string, MessageHandler> event_handlers_;
  3875. OpenHandler on_open_;
  3876. ErrorHandler on_error_;
  3877. // Configuration
  3878. int reconnect_interval_ms_ = 3000;
  3879. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3880. // State
  3881. std::atomic<bool> running_{false};
  3882. std::atomic<bool> connected_{false};
  3883. // Written by the event loop, which start_async() runs on its own thread
  3884. std::string last_event_id_;
  3885. mutable std::mutex last_event_id_mutex_;
  3886. // Async support
  3887. std::thread async_thread_;
  3888. };
  3889. } // namespace sse
  3890. namespace detail {
  3891. // Interprets an event stream fed in chunks of any size
  3892. class SSEParser {
  3893. public:
  3894. using EventHandler = std::function<void(const sse::SSEMessage &msg)>;
  3895. using IdHandler = std::function<void(const std::string &id)>;
  3896. using RetryHandler = std::function<void(int retry_ms)>;
  3897. SSEParser(EventHandler on_event, IdHandler on_id, RetryHandler on_retry,
  3898. size_t max_event_length = CPPHTTPLIB_SSE_MAX_EVENT_LENGTH);
  3899. // Returns false once the line and the event still waiting for their end
  3900. // exceed max_event_length. 0 means no limit.
  3901. bool parse(const char *buf, size_t n);
  3902. private:
  3903. void parse_line(const std::string &line);
  3904. EventHandler on_event_;
  3905. IdHandler on_id_;
  3906. RetryHandler on_retry_;
  3907. size_t max_event_length_;
  3908. std::string buffer_;
  3909. sse::SSEMessage msg_;
  3910. bool has_data_ = false;
  3911. bool has_id_ = false;
  3912. bool first_line_ = true;
  3913. bool after_cr_ = false;
  3914. };
  3915. } // namespace detail
  3916. namespace ws {
  3917. class WebSocketClient;
  3918. enum class Opcode : uint8_t {
  3919. Continuation = 0x0,
  3920. Text = 0x1,
  3921. Binary = 0x2,
  3922. Close = 0x8,
  3923. Ping = 0x9,
  3924. Pong = 0xA,
  3925. };
  3926. enum class CloseStatus : uint16_t {
  3927. Normal = 1000,
  3928. GoingAway = 1001,
  3929. ProtocolError = 1002,
  3930. UnsupportedData = 1003,
  3931. NoStatus = 1005,
  3932. Abnormal = 1006,
  3933. InvalidPayload = 1007,
  3934. PolicyViolation = 1008,
  3935. MessageTooBig = 1009,
  3936. MandatoryExtension = 1010,
  3937. InternalError = 1011,
  3938. };
  3939. // Timeout is returned only when a read timeout was set and it elapsed before
  3940. // any byte of a frame arrived: nothing was consumed and the connection is
  3941. // still open, so the caller can send on it and read again. `msg` is left
  3942. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3943. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3944. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3945. // upgrade handshake fully succeeded. On failure error() identifies the
  3946. // failing layer; status()/headers() expose the server's upgrade response
  3947. // when one was received (status() is -1 otherwise), or the proxy's reply to
  3948. // CONNECT when error() is ProxyConnection.
  3949. class Result {
  3950. public:
  3951. Result() = default;
  3952. Result(Error err, int status, Headers &&headers)
  3953. : err_(err), status_(status), headers_(std::move(headers)) {}
  3954. explicit operator bool() const { return err_ == Error::Success; }
  3955. Error error() const { return err_; }
  3956. // Upgrade response info
  3957. int status() const { return status_; }
  3958. const Headers &headers() const { return headers_; }
  3959. std::string get_header_value(const std::string &key,
  3960. const char *def = "") const {
  3961. return detail::get_header_value(headers_, key, def, 0);
  3962. }
  3963. bool has_header(const std::string &key) const {
  3964. return headers_.find(key) != headers_.end();
  3965. }
  3966. #ifdef CPPHTTPLIB_SSL_ENABLED
  3967. Result(Error err, int status, Headers &&headers, int ssl_error,
  3968. uint64_t ssl_backend_error)
  3969. : err_(err), status_(status), headers_(std::move(headers)),
  3970. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3971. int ssl_error() const { return ssl_error_; }
  3972. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3973. #endif
  3974. private:
  3975. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3976. int status_ = -1;
  3977. Headers headers_;
  3978. #ifdef CPPHTTPLIB_SSL_ENABLED
  3979. int ssl_error_ = 0;
  3980. uint64_t ssl_backend_error_ = 0;
  3981. #endif
  3982. };
  3983. namespace impl {
  3984. bool is_valid_utf8(const std::string &s);
  3985. // Three states: a frame, a failure (the connection cannot be read on), or a
  3986. // timeout with the stream still usable.
  3987. enum class FrameRead { Ok, Fail, Timeout };
  3988. // A frame read in as many calls as it takes. A timeout leaves what was read
  3989. // so far in place, and the next read() goes on from there, so the stream is
  3990. // usable after a timeout wherever in a frame it lands.
  3991. class FrameReader {
  3992. public:
  3993. FrameRead read(Stream &strm, Opcode &opcode, std::string &payload, bool &fin,
  3994. bool expect_masked, size_t max_len);
  3995. // Whether part of a frame has been read and the rest is still to come
  3996. bool begun() const { return have_ > 0; }
  3997. private:
  3998. void reset();
  3999. uint8_t head_[14] = {0}; // FIN + opcode, MASK + length, its extension, key
  4000. size_t have_ = 0; // bytes of the header read so far
  4001. size_t need_ = 2; // bytes of the header, once the second is read
  4002. bool sized_ = false; // the header is whole and its length checked
  4003. size_t len_ = 0; // the payload's length, once sized_
  4004. std::string payload_;
  4005. };
  4006. // A whole frame read in one go: a timeout before any of it came is reported,
  4007. // and one that cuts it short is a failure.
  4008. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4009. std::string &payload, bool &fin,
  4010. bool expect_masked, size_t max_len);
  4011. } // namespace impl
  4012. class WebSocket {
  4013. public:
  4014. WebSocket(const WebSocket &) = delete;
  4015. WebSocket &operator=(const WebSocket &) = delete;
  4016. ~WebSocket();
  4017. ReadResult read(std::string &msg);
  4018. bool send(const std::string &data);
  4019. bool send(const char *data, size_t len);
  4020. void close(CloseStatus status = CloseStatus::Normal,
  4021. const std::string &reason = "");
  4022. const Request &request() const;
  4023. bool is_open() const;
  4024. // Bound how long read() waits before returning Timeout. 0 waits forever.
  4025. // A server handler owns its connection's timeout this way; a client sets it
  4026. // through WebSocketClient. Safe to call while another thread is in read().
  4027. // It lands anywhere, inside a message too: what was read of it is kept,
  4028. // and the next read() goes on from there.
  4029. //
  4030. // Only a timeout set here is reported as Timeout. The compile-time default
  4031. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  4032. // than a request for control, so when it elapses read() returns Fail and
  4033. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  4034. void set_read_timeout(time_t sec, time_t usec = 0);
  4035. template <class Rep, class Period>
  4036. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  4037. private:
  4038. friend class httplib::Server;
  4039. friend class httplib::ws::WebSocketClient;
  4040. WebSocket(
  4041. Stream &strm, const Request &req, bool is_server,
  4042. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  4043. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS,
  4044. std::function<bool()> server_stopping = nullptr)
  4045. : strm_(strm), req_(req), is_server_(is_server),
  4046. ping_interval_sec_(ping_interval_sec),
  4047. max_missed_pongs_(max_missed_pongs),
  4048. server_stopping_(std::move(server_stopping)) {
  4049. interrupt_reads();
  4050. start_heartbeat();
  4051. }
  4052. WebSocket(
  4053. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  4054. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  4055. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS,
  4056. std::function<bool()> server_stopping = nullptr)
  4057. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  4058. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  4059. max_missed_pongs_(max_missed_pongs),
  4060. server_stopping_(std::move(server_stopping)) {
  4061. interrupt_reads();
  4062. start_heartbeat();
  4063. }
  4064. void interrupt_reads();
  4065. bool server_stopping() const {
  4066. return server_stopping_ && server_stopping_();
  4067. }
  4068. void start_heartbeat();
  4069. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  4070. Stream &strm_;
  4071. std::unique_ptr<Stream> owned_strm_;
  4072. Request req_;
  4073. bool is_server_;
  4074. time_t ping_interval_sec_;
  4075. int max_missed_pongs_;
  4076. int unacked_pings_ = 0;
  4077. std::atomic<bool> closed_{false};
  4078. // Set when the peer stopped answering pings, to end a read() waiting on it
  4079. std::atomic<bool> pong_timed_out_{false};
  4080. // A server connection's view of Server::stop(), which ends its read() too
  4081. std::function<bool()> server_stopping_;
  4082. // Set once the caller has bounded read() through set_read_timeout(). Until
  4083. // then the timeout in effect is the compile-time default, and elapsing it
  4084. // is a failure that closes the connection, not a Timeout.
  4085. std::atomic<bool> read_timeout_set_{false};
  4086. std::mutex write_mutex_;
  4087. // Owned by whichever thread is parsing frames off strm_. Only one thread
  4088. // may do so: a frame is read until it has the whole declared length,
  4089. // across several read() calls when a timeout lands inside it (frames_
  4090. // below), so a second parser stealing bytes silently corrupts the message
  4091. // the first one is assembling.
  4092. std::mutex read_mutex_;
  4093. // What read() has of the frame and the message it has not finished, kept
  4094. // across a timeout. Guarded by read_mutex_.
  4095. impl::FrameReader frames_;
  4096. std::string message_;
  4097. ReadResult message_kind_ = Fail; // Text or Binary while one is assembled
  4098. std::thread ping_thread_;
  4099. std::mutex ping_mutex_;
  4100. std::condition_variable ping_cv_;
  4101. };
  4102. class WebSocketClient {
  4103. public:
  4104. explicit WebSocketClient(const std::string &scheme_host_port_path,
  4105. const Headers &headers = {});
  4106. ~WebSocketClient();
  4107. WebSocketClient(const WebSocketClient &) = delete;
  4108. WebSocketClient &operator=(const WebSocketClient &) = delete;
  4109. bool is_valid() const;
  4110. Result connect();
  4111. ReadResult read(std::string &msg);
  4112. bool send(const std::string &data);
  4113. bool send(const char *data, size_t len);
  4114. void close(CloseStatus status = CloseStatus::Normal,
  4115. const std::string &reason = "");
  4116. bool is_open() const;
  4117. const std::string &subprotocol() const;
  4118. void set_read_timeout(time_t sec, time_t usec = 0);
  4119. template <class Rep, class Period>
  4120. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  4121. void set_write_timeout(time_t sec, time_t usec = 0);
  4122. template <class Rep, class Period>
  4123. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  4124. void set_websocket_ping_interval(time_t sec);
  4125. void set_websocket_max_missed_pongs(int count);
  4126. void set_tcp_nodelay(bool on);
  4127. void set_address_family(int family);
  4128. void set_ipv6_v6only(bool on);
  4129. void set_socket_options(SocketOptions socket_options);
  4130. void set_connection_timeout(time_t sec, time_t usec = 0);
  4131. template <class Rep, class Period>
  4132. void
  4133. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  4134. void set_interface(const std::string &intf);
  4135. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  4136. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  4137. void
  4138. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  4139. void
  4140. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  4141. void set_basic_auth(const std::string &username, const std::string &password);
  4142. void set_bearer_token_auth(const std::string &token);
  4143. void set_proxy(const std::string &host, int port);
  4144. void set_proxy_basic_auth(const std::string &username,
  4145. const std::string &password);
  4146. void set_proxy_bearer_token_auth(const std::string &token);
  4147. void set_no_proxy(const std::vector<std::string> &patterns);
  4148. #ifdef CPPHTTPLIB_SSL_ENABLED
  4149. struct PemMemory {
  4150. const char *cert_pem;
  4151. size_t cert_pem_len;
  4152. const char *key_pem;
  4153. size_t key_pem_len;
  4154. const char *private_key_password;
  4155. };
  4156. explicit WebSocketClient(const std::string &scheme_host_port_path,
  4157. const PemMemory &pem, const Headers &headers = {});
  4158. void set_ca_cert_path(const std::string &ca_cert_file_path,
  4159. const std::string &ca_cert_dir_path = std::string());
  4160. void set_ca_cert_store(tls::ca_store_t store);
  4161. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  4162. void enable_server_certificate_verification(bool enabled);
  4163. void enable_server_hostname_verification(bool enabled);
  4164. void enable_system_ca(bool enabled);
  4165. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  4166. void set_session_verifier(
  4167. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  4168. void set_proxy_digest_auth(const std::string &username,
  4169. const std::string &password);
  4170. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  4171. void enable_windows_certificate_verification(bool enabled);
  4172. #endif
  4173. #endif
  4174. private:
  4175. void shutdown_and_close();
  4176. std::pair<time_t, time_t> handshake_timeout() const;
  4177. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  4178. int &ssl_error, uint64_t &ssl_backend_error);
  4179. void prepare_default_headers(Request &req);
  4180. bool is_proxy_enabled() const;
  4181. bool create_and_connect_socket(Error &error);
  4182. bool send_proxy_connect(Request &req, Response &proxy_res, Error &error);
  4183. bool connect_with_proxy(Response &proxy_res, Error &error);
  4184. std::string host_;
  4185. int port_;
  4186. std::string path_;
  4187. Headers headers_;
  4188. std::string subprotocol_;
  4189. bool is_valid_ = false;
  4190. socket_t sock_ = INVALID_SOCKET;
  4191. std::unique_ptr<WebSocket> ws_;
  4192. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  4193. time_t read_timeout_usec_ = 0;
  4194. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  4195. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  4196. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  4197. time_t websocket_ping_interval_sec_ =
  4198. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  4199. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  4200. int address_family_ = AF_UNSPEC;
  4201. bool tcp_nodelay_ = CPPHTTPLIB_WEBSOCKET_TCP_NODELAY;
  4202. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  4203. SocketOptions socket_options_ = nullptr;
  4204. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  4205. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  4206. std::string interface_;
  4207. // Hostname to connection target map. The value is an IP literal or another
  4208. // hostname; only the connection target changes, never the identity.
  4209. std::map<std::string, std::string> addr_map_;
  4210. // Hostname to CONNECT target map, used only through a proxy.
  4211. std::map<std::string, std::string> tunnel_addr_map_;
  4212. std::string basic_auth_username_;
  4213. std::string basic_auth_password_;
  4214. std::string bearer_token_auth_token_;
  4215. std::string proxy_host_;
  4216. int proxy_port_ = -1;
  4217. std::string proxy_basic_auth_username_;
  4218. std::string proxy_basic_auth_password_;
  4219. std::string proxy_bearer_token_auth_token_;
  4220. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  4221. #ifdef CPPHTTPLIB_SSL_ENABLED
  4222. bool is_ssl_ = false;
  4223. tls::ctx_t tls_ctx_ = nullptr;
  4224. tls::session_t tls_session_ = nullptr;
  4225. std::string ca_cert_file_path_;
  4226. std::string ca_cert_dir_path_;
  4227. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  4228. // no certificate, so that a CA that failed to come through fails
  4229. // verification instead of letting the system CAs in.
  4230. bool custom_ca_loaded_ = false;
  4231. bool certs_loaded_ = false;
  4232. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  4233. bool server_certificate_verification_ = true;
  4234. bool server_hostname_verification_ = true;
  4235. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  4236. std::string proxy_digest_auth_username_;
  4237. std::string proxy_digest_auth_password_;
  4238. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  4239. bool enable_windows_cert_verification_ = true;
  4240. bool server_certificate_verifier_set_ = false;
  4241. #endif
  4242. #endif
  4243. };
  4244. template <class Rep, class Period>
  4245. inline void WebSocket::set_read_timeout(
  4246. const std::chrono::duration<Rep, Period> &duration) {
  4247. detail::duration_to_sec_and_usec(
  4248. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4249. }
  4250. template <class Rep, class Period>
  4251. inline void WebSocketClient::set_read_timeout(
  4252. const std::chrono::duration<Rep, Period> &duration) {
  4253. detail::duration_to_sec_and_usec(
  4254. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4255. }
  4256. template <class Rep, class Period>
  4257. inline void WebSocketClient::set_write_timeout(
  4258. const std::chrono::duration<Rep, Period> &duration) {
  4259. detail::duration_to_sec_and_usec(
  4260. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  4261. }
  4262. template <class Rep, class Period>
  4263. inline void WebSocketClient::set_connection_timeout(
  4264. const std::chrono::duration<Rep, Period> &duration) {
  4265. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  4266. set_connection_timeout(sec, usec);
  4267. });
  4268. }
  4269. } // namespace ws
  4270. namespace detail {
  4271. bool write_websocket_frame(Stream &strm, ws::Opcode opcode, const char *data,
  4272. size_t len, bool fin, bool mask);
  4273. } // namespace detail
  4274. // ----------------------------------------------------------------------------
  4275. /*
  4276. * Implementation that will be part of the .cc file if split into .h + .cc.
  4277. */
  4278. namespace stream {
  4279. // stream::Result implementations
  4280. inline Result::Result() : chunk_size_(8192) {}
  4281. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  4282. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  4283. inline Result::Result(Result &&other) noexcept
  4284. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  4285. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  4286. finished_(other.finished_) {
  4287. other.current_size_ = 0;
  4288. other.finished_ = true;
  4289. }
  4290. inline Result &Result::operator=(Result &&other) noexcept {
  4291. if (this != &other) {
  4292. handle_ = std::move(other.handle_);
  4293. buffer_ = std::move(other.buffer_);
  4294. current_size_ = other.current_size_;
  4295. chunk_size_ = other.chunk_size_;
  4296. finished_ = other.finished_;
  4297. other.current_size_ = 0;
  4298. other.finished_ = true;
  4299. }
  4300. return *this;
  4301. }
  4302. inline bool Result::is_valid() const { return handle_.is_valid(); }
  4303. inline Result::operator bool() const { return is_valid(); }
  4304. inline int Result::status() const {
  4305. return handle_.response ? handle_.response->status : -1;
  4306. }
  4307. inline const Headers &Result::headers() const {
  4308. static const Headers empty_headers;
  4309. return handle_.response ? handle_.response->headers : empty_headers;
  4310. }
  4311. inline std::string Result::get_header_value(const std::string &key,
  4312. const char *def) const {
  4313. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  4314. }
  4315. inline bool Result::has_header(const std::string &key) const {
  4316. return handle_.response ? handle_.response->has_header(key) : false;
  4317. }
  4318. inline Error Result::error() const { return handle_.error; }
  4319. inline Error Result::read_error() const { return handle_.get_read_error(); }
  4320. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  4321. inline bool Result::next() {
  4322. if (!handle_.is_valid() || finished_) { return false; }
  4323. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4324. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4325. if (n > 0) {
  4326. current_size_ = static_cast<size_t>(n);
  4327. return true;
  4328. }
  4329. current_size_ = 0;
  4330. finished_ = true;
  4331. return false;
  4332. }
  4333. inline const char *Result::data() const { return buffer_.data(); }
  4334. inline size_t Result::size() const { return current_size_; }
  4335. inline std::string Result::read_all() {
  4336. std::string result;
  4337. while (next()) {
  4338. result.append(data(), size());
  4339. }
  4340. return result;
  4341. }
  4342. } // namespace stream
  4343. namespace detail {
  4344. inline SSEParser::SSEParser(EventHandler on_event, IdHandler on_id,
  4345. RetryHandler on_retry, size_t max_event_length)
  4346. : on_event_(std::move(on_event)), on_id_(std::move(on_id)),
  4347. on_retry_(std::move(on_retry)), max_event_length_(max_event_length) {}
  4348. inline bool SSEParser::parse(const char *buf, size_t n) {
  4349. // What is left in the buffer has no line ending
  4350. auto search_pos = buffer_.size();
  4351. buffer_.append(buf, n);
  4352. // A line ends with \r\n, \n or \r per the SSE spec
  4353. size_t line_start = 0;
  4354. size_t eol_pos;
  4355. while ((eol_pos = buffer_.find_first_of("\r\n", search_pos)) !=
  4356. std::string::npos) {
  4357. auto line = buffer_.substr(line_start, eol_pos - line_start);
  4358. line_start = eol_pos + 1;
  4359. search_pos = line_start;
  4360. // The \n of a \r\n may arrive in a later chunk than its \r
  4361. auto is_lf_of_crlf = after_cr_ && line.empty() && buffer_[eol_pos] == '\n';
  4362. after_cr_ = buffer_[eol_pos] == '\r';
  4363. if (is_lf_of_crlf) { continue; }
  4364. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4365. if (first_line_) {
  4366. first_line_ = false;
  4367. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4368. }
  4369. parse_line(line);
  4370. }
  4371. // Keep unprocessed data in buffer
  4372. buffer_.erase(0, line_start);
  4373. return max_event_length_ == 0 ||
  4374. buffer_.size() + msg_.data.size() <= max_event_length_;
  4375. }
  4376. inline void SSEParser::parse_line(const std::string &line) {
  4377. // Blank line signals end of event
  4378. if (line.empty()) {
  4379. // The id counts for Last-Event-ID even for an event that has no data. An
  4380. // empty id clears it.
  4381. if (has_id_ && on_id_) { on_id_(msg_.id); }
  4382. // An event without a data field is not dispatched
  4383. if (has_data_ && on_event_) { on_event_(msg_); }
  4384. msg_.clear();
  4385. has_data_ = false;
  4386. has_id_ = false;
  4387. return;
  4388. }
  4389. // Lines starting with ':' are comments (ignored)
  4390. if (line[0] == ':') { return; }
  4391. // Find the colon separator
  4392. auto colon_pos = line.find(':');
  4393. auto field = line.substr(0, colon_pos);
  4394. std::string value;
  4395. // Value starts after colon, skip optional single space
  4396. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4397. auto value_start = colon_pos + 1;
  4398. if (line[value_start] == ' ') { value_start++; }
  4399. value = line.substr(value_start);
  4400. }
  4401. // Handle known fields
  4402. if (field == "event") {
  4403. // An empty event type is dispatched as "message" per the SSE spec
  4404. msg_.event = value.empty() ? std::string("message") : std::move(value);
  4405. } else if (field == "data") {
  4406. // Multiple data lines are concatenated with newlines
  4407. if (has_data_) { msg_.data += "\n"; }
  4408. msg_.data += value;
  4409. has_data_ = true;
  4410. } else if (field == "id") {
  4411. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4412. // valid (clears the last event ID)
  4413. if (fields::is_field_value(value)) {
  4414. msg_.id = value;
  4415. has_id_ = true;
  4416. }
  4417. } else if (field == "retry") {
  4418. // Parse retry interval in milliseconds
  4419. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4420. if (is_numeric(value)) {
  4421. int v = 0;
  4422. auto res = from_chars(value.data(), value.data() + value.size(), v);
  4423. if (res.ec == std::errc{} && on_retry_) { on_retry_(v); }
  4424. }
  4425. }
  4426. // Unknown fields are ignored per SSE spec
  4427. }
  4428. } // namespace detail
  4429. namespace sse {
  4430. // SSEMessage implementations
  4431. inline SSEMessage::SSEMessage() : event("message") {}
  4432. inline void SSEMessage::clear() {
  4433. event = "message";
  4434. data.clear();
  4435. id.clear();
  4436. }
  4437. // SSEClient implementations
  4438. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4439. : client_(client), path_(path) {}
  4440. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4441. const Headers &headers)
  4442. : client_(client), path_(path), headers_(headers) {}
  4443. inline SSEClient::~SSEClient() { stop(); }
  4444. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4445. on_message_ = std::move(handler);
  4446. return *this;
  4447. }
  4448. inline SSEClient &SSEClient::on_event(const std::string &type,
  4449. MessageHandler handler) {
  4450. event_handlers_[type] = std::move(handler);
  4451. return *this;
  4452. }
  4453. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4454. on_open_ = std::move(handler);
  4455. return *this;
  4456. }
  4457. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4458. on_error_ = std::move(handler);
  4459. return *this;
  4460. }
  4461. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4462. reconnect_interval_ms_ = ms;
  4463. return *this;
  4464. }
  4465. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4466. max_reconnect_attempts_ = n;
  4467. return *this;
  4468. }
  4469. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4470. std::lock_guard<std::mutex> lock(headers_mutex_);
  4471. headers_ = headers;
  4472. return *this;
  4473. }
  4474. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4475. inline std::string SSEClient::last_event_id() const {
  4476. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4477. return last_event_id_;
  4478. }
  4479. inline void SSEClient::start() {
  4480. running_.store(true);
  4481. run_event_loop();
  4482. }
  4483. inline void SSEClient::start_async() {
  4484. running_.store(true);
  4485. async_thread_ = std::thread([this]() { run_event_loop(); });
  4486. }
  4487. inline void SSEClient::stop() {
  4488. running_.store(false);
  4489. client_.stop(); // Cancel any pending operations
  4490. if (async_thread_.joinable()) { async_thread_.join(); }
  4491. }
  4492. inline void SSEClient::run_event_loop() {
  4493. auto reconnect_count = 0;
  4494. while (running_.load()) {
  4495. // Build headers, including Last-Event-ID if we have one
  4496. Headers request_headers;
  4497. {
  4498. std::lock_guard<std::mutex> lock(headers_mutex_);
  4499. request_headers = headers_;
  4500. }
  4501. if (!last_event_id_.empty()) {
  4502. request_headers.emplace("Last-Event-ID", last_event_id_);
  4503. }
  4504. // Open streaming connection. An event stream has no end, so each event is
  4505. // bounded instead of the whole body.
  4506. auto handle = client_.open_stream("GET", path_, {}, request_headers);
  4507. handle.body_reader_.payload_max_length = 0;
  4508. // stop() ends a read that is waiting for the next event
  4509. if (handle.stream_) {
  4510. handle.stream_->set_read_interrupt([this] { return !running_.load(); });
  4511. }
  4512. stream::Result result{std::move(handle)};
  4513. // Connection error handling
  4514. if (!result) {
  4515. connected_.store(false);
  4516. if (on_error_) { on_error_(result.error()); }
  4517. if (!should_reconnect(reconnect_count)) { break; }
  4518. wait_for_reconnect();
  4519. reconnect_count++;
  4520. continue;
  4521. }
  4522. if (result.status() != StatusCode::OK_200) {
  4523. connected_.store(false);
  4524. if (on_error_) { on_error_(Error::Connection); }
  4525. // For certain errors, don't reconnect.
  4526. // Note: 401 is intentionally absent so that handlers can refresh
  4527. // credentials via set_headers() and let the client reconnect.
  4528. if (result.status() == StatusCode::NoContent_204 ||
  4529. result.status() == StatusCode::NotFound_404 ||
  4530. result.status() == StatusCode::Forbidden_403) {
  4531. break;
  4532. }
  4533. if (!should_reconnect(reconnect_count)) { break; }
  4534. wait_for_reconnect();
  4535. reconnect_count++;
  4536. continue;
  4537. }
  4538. // Connection successful
  4539. connected_.store(true);
  4540. reconnect_count = 0;
  4541. if (on_open_) { on_open_(); }
  4542. // Event receiving loop
  4543. detail::SSEParser parser(
  4544. [this](const SSEMessage &msg) { dispatch_event(msg); },
  4545. [this](const std::string &id) {
  4546. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4547. last_event_id_ = id;
  4548. },
  4549. [this](int retry_ms) { reconnect_interval_ms_ = retry_ms; });
  4550. auto event_too_long = false;
  4551. while (running_.load() && result.next()) {
  4552. if (!parser.parse(result.data(), result.size())) {
  4553. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4554. event_too_long = true;
  4555. break;
  4556. }
  4557. }
  4558. // Connection ended
  4559. connected_.store(false);
  4560. // Reconnecting would only get the same event again
  4561. if (!running_.load() || event_too_long) { break; }
  4562. // Check for read errors
  4563. if (result.has_read_error()) {
  4564. if (on_error_) { on_error_(result.read_error()); }
  4565. }
  4566. if (!should_reconnect(reconnect_count)) { break; }
  4567. wait_for_reconnect();
  4568. reconnect_count++;
  4569. }
  4570. connected_.store(false);
  4571. }
  4572. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4573. // Check for specific event type handler first
  4574. auto it = event_handlers_.find(msg.event);
  4575. if (it != event_handlers_.end()) {
  4576. it->second(msg);
  4577. return;
  4578. }
  4579. // Fall back to generic message handler
  4580. if (on_message_) { on_message_(msg); }
  4581. }
  4582. inline bool SSEClient::should_reconnect(int count) const {
  4583. if (!running_.load()) { return false; }
  4584. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4585. return count < max_reconnect_attempts_;
  4586. }
  4587. inline void SSEClient::wait_for_reconnect() {
  4588. // Use small increments to check running_ flag frequently.
  4589. // Always wait at least one increment, so that a zero interval (e.g.
  4590. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4591. const auto step_ms = 100;
  4592. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4593. auto waited = 0;
  4594. while (running_.load() && waited < interval_ms) {
  4595. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4596. waited += step_ms;
  4597. }
  4598. }
  4599. } // namespace sse
  4600. #ifdef CPPHTTPLIB_SSL_ENABLED
  4601. /*
  4602. * TLS abstraction layer - internal function declarations
  4603. * These are implementation details and not part of the public API.
  4604. */
  4605. namespace tls {
  4606. // Client context
  4607. ctx_t create_client_context();
  4608. void free_context(ctx_t ctx);
  4609. bool set_min_version(ctx_t ctx, Version version);
  4610. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4611. bool load_ca_file(ctx_t ctx, const char *file_path);
  4612. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4613. bool load_system_certs(ctx_t ctx);
  4614. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4615. const char *password);
  4616. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4617. const char *key_path, const char *password);
  4618. // Server context
  4619. ctx_t create_server_context();
  4620. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4621. const char *password);
  4622. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4623. const char *key_path, const char *password);
  4624. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4625. void set_verify_client(ctx_t ctx, bool require);
  4626. // Session management
  4627. session_t create_session(ctx_t ctx, socket_t sock);
  4628. void free_session(session_t session);
  4629. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4630. // Handshake (non-blocking capable)
  4631. TlsError connect(session_t session);
  4632. TlsError accept(session_t session);
  4633. // Handshake with timeout (blocking until timeout, or until interrupted)
  4634. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4635. time_t timeout_usec, TlsError *err,
  4636. const std::function<bool()> &interrupted = nullptr);
  4637. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4638. time_t timeout_usec, TlsError *err);
  4639. // I/O (non-blocking capable)
  4640. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4641. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4642. int pending(const_session_t session);
  4643. void shutdown(session_t session, bool graceful);
  4644. // Connection state
  4645. bool is_peer_closed(session_t session, socket_t sock);
  4646. // Certificate verification
  4647. cert_t get_peer_cert(const_session_t session);
  4648. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4649. // do not use them after free_session(), as with get_peer_cert().
  4650. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4651. void free_cert(cert_t cert);
  4652. // Matches the host against the subjectAltName entries only, never the Common
  4653. // Name (RFC 9525).
  4654. bool verify_hostname(cert_t cert, const char *hostname);
  4655. uint64_t hostname_mismatch_code();
  4656. long get_verify_result(const_session_t session);
  4657. // Certificate introspection
  4658. std::string get_cert_subject_cn(cert_t cert);
  4659. std::string get_cert_issuer_name(cert_t cert);
  4660. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4661. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4662. std::string get_cert_serial(cert_t cert);
  4663. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4664. const char *get_sni(const_session_t session);
  4665. // CA store management
  4666. ca_store_t create_ca_store(const char *pem, size_t len);
  4667. void free_ca_store(ca_store_t store);
  4668. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4669. // Free each with free_cert(), and do not use them once the context's CA
  4670. // certificates change.
  4671. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4672. std::vector<std::string> get_ca_names(ctx_t ctx);
  4673. // Dynamic certificate update (for servers)
  4674. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4675. const char *password);
  4676. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4677. // Certificate verification callback
  4678. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4679. long get_verify_error(const_session_t session);
  4680. std::string verify_error_string(long error_code);
  4681. // TlsError information
  4682. uint64_t peek_error();
  4683. uint64_t get_error();
  4684. std::string error_string(uint64_t code);
  4685. } // namespace tls
  4686. #endif // CPPHTTPLIB_SSL_ENABLED
  4687. /*
  4688. * Group 1: detail namespace - Non-SSL utilities
  4689. */
  4690. namespace detail {
  4691. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4692. const void *optval, socklen_t optlen) {
  4693. return setsockopt(sock, level, optname,
  4694. #ifdef _WIN32
  4695. reinterpret_cast<const char *>(optval),
  4696. #else
  4697. optval,
  4698. #endif
  4699. optlen) == 0;
  4700. }
  4701. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4702. time_t sec, time_t usec) {
  4703. #ifdef _WIN32
  4704. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4705. #else
  4706. timeval timeout;
  4707. timeout.tv_sec = static_cast<long>(sec);
  4708. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4709. #endif
  4710. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4711. }
  4712. inline bool is_hex(char c, int &v) {
  4713. if (is_ascii_digit(c)) {
  4714. v = c - '0';
  4715. return true;
  4716. } else if ('A' <= c && c <= 'F') {
  4717. v = c - 'A' + 10;
  4718. return true;
  4719. } else if ('a' <= c && c <= 'f') {
  4720. v = c - 'a' + 10;
  4721. return true;
  4722. }
  4723. return false;
  4724. }
  4725. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4726. int &val) {
  4727. if (i >= s.size()) { return false; }
  4728. val = 0;
  4729. for (; cnt; i++, cnt--) {
  4730. if (!s[i]) { return false; }
  4731. auto v = 0;
  4732. if (is_hex(s[i], v)) {
  4733. val = val * 16 + v;
  4734. } else {
  4735. return false;
  4736. }
  4737. }
  4738. return true;
  4739. }
  4740. inline std::string from_i_to_hex(size_t n) {
  4741. static const auto charset = "0123456789abcdef";
  4742. std::string ret;
  4743. do {
  4744. ret = charset[n & 15] + ret;
  4745. n >>= 4;
  4746. } while (n > 0);
  4747. return ret;
  4748. }
  4749. // A round trip rather than `n <= SIZE_MAX`, which is always true on 64-bit
  4750. // builds and trips -Wtautological-type-limit-compare.
  4751. inline bool fits_in_size_t(uint64_t n) {
  4752. return static_cast<uint64_t>(static_cast<size_t>(n)) == n;
  4753. }
  4754. inline std::string compute_etag(const FileStat &fs,
  4755. const std::string &suffix = std::string()) {
  4756. if (!fs.is_file()) { return std::string(); }
  4757. // If mtime cannot be determined (negative value indicates an error
  4758. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4759. // value like 0 could collide with a real file that legitimately has
  4760. // mtime == 0 (epoch) and lead to misleading validators.
  4761. auto mtime_raw = fs.mtime();
  4762. if (mtime_raw < 0) { return std::string(); }
  4763. auto mtime = static_cast<size_t>(mtime_raw);
  4764. auto size = fs.size();
  4765. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4766. from_i_to_hex(size) + suffix + "\"";
  4767. }
  4768. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4769. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4770. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4771. inline std::string file_mtime_to_http_date(time_t mtime) {
  4772. if (mtime < 0) { return std::string(); }
  4773. struct tm tm_buf;
  4774. #ifdef _WIN32
  4775. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4776. #else
  4777. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4778. #endif
  4779. char buf[64];
  4780. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4781. return std::string();
  4782. }
  4783. return std::string(buf);
  4784. }
  4785. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4786. inline time_t parse_http_date(const std::string &date_str) {
  4787. struct tm tm_buf;
  4788. // Create a classic locale object once for all parsing attempts
  4789. const std::locale classic_locale = std::locale::classic();
  4790. // Try to parse using std::get_time (C++11, cross-platform)
  4791. auto try_parse = [&](const char *fmt) -> bool {
  4792. std::istringstream ss(date_str);
  4793. ss.imbue(classic_locale);
  4794. memset(&tm_buf, 0, sizeof(tm_buf));
  4795. ss >> std::get_time(&tm_buf, fmt);
  4796. return !ss.fail();
  4797. };
  4798. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4799. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4800. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4801. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4802. // asctime format: "Sun Nov 6 08:49:37 1994"
  4803. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4804. return static_cast<time_t>(-1);
  4805. }
  4806. }
  4807. }
  4808. #ifdef _WIN32
  4809. return _mkgmtime(&tm_buf);
  4810. #elif defined _AIX
  4811. return mktime(&tm_buf);
  4812. #else
  4813. return timegm(&tm_buf);
  4814. #endif
  4815. }
  4816. inline bool is_weak_etag(const std::string &s) {
  4817. // Check if the string is a weak ETag (starts with 'W/"')
  4818. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4819. }
  4820. inline bool is_strong_etag(const std::string &s) {
  4821. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4822. // chars)
  4823. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4824. }
  4825. inline size_t to_utf8(int code, char *buff) {
  4826. if (code < 0x0080) {
  4827. buff[0] = static_cast<char>(code & 0x7F);
  4828. return 1;
  4829. } else if (code < 0x0800) {
  4830. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4831. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4832. return 2;
  4833. } else if (code < 0xD800) {
  4834. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4835. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4836. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4837. return 3;
  4838. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4839. return 0;
  4840. } else if (code < 0x10000) {
  4841. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4842. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4843. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4844. return 3;
  4845. } else if (code < 0x110000) {
  4846. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4847. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4848. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4849. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4850. return 4;
  4851. }
  4852. // NOTREACHED
  4853. return 0;
  4854. }
  4855. } // namespace detail
  4856. namespace ws {
  4857. namespace impl {
  4858. inline bool is_valid_utf8(const std::string &s) {
  4859. size_t i = 0;
  4860. auto n = s.size();
  4861. while (i < n) {
  4862. auto c = static_cast<unsigned char>(s[i]);
  4863. size_t len;
  4864. uint32_t cp;
  4865. if (c < 0x80) {
  4866. i++;
  4867. continue;
  4868. } else if ((c & 0xE0) == 0xC0) {
  4869. len = 2;
  4870. cp = c & 0x1F;
  4871. } else if ((c & 0xF0) == 0xE0) {
  4872. len = 3;
  4873. cp = c & 0x0F;
  4874. } else if ((c & 0xF8) == 0xF0) {
  4875. len = 4;
  4876. cp = c & 0x07;
  4877. } else {
  4878. return false;
  4879. }
  4880. if (i + len > n) { return false; }
  4881. for (size_t j = 1; j < len; j++) {
  4882. auto b = static_cast<unsigned char>(s[i + j]);
  4883. if ((b & 0xC0) != 0x80) { return false; }
  4884. cp = (cp << 6) | (b & 0x3F);
  4885. }
  4886. // Overlong encoding check
  4887. if (len == 2 && cp < 0x80) { return false; }
  4888. if (len == 3 && cp < 0x800) { return false; }
  4889. if (len == 4 && cp < 0x10000) { return false; }
  4890. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4891. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4892. if (cp > 0x10FFFF) { return false; }
  4893. i += len;
  4894. }
  4895. return true;
  4896. }
  4897. } // namespace impl
  4898. } // namespace ws
  4899. namespace detail {
  4900. // NOTE: This code came up with the following stackoverflow post:
  4901. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4902. inline std::string base64_encode(const std::string &in) {
  4903. static const auto lookup =
  4904. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4905. std::string out;
  4906. out.reserve(in.size());
  4907. // Unsigned: the accumulator is never masked, so with a signed int the
  4908. // `val << 8` below overflows once enough bytes are folded in (undefined
  4909. // behaviour before C++20). Only the low bits are ever emitted, so the
  4910. // wrap-around of an unsigned accumulator does not affect the output.
  4911. uint32_t val = 0;
  4912. auto valb = -6;
  4913. for (auto c : in) {
  4914. val = (val << 8) + static_cast<uint8_t>(c);
  4915. valb += 8;
  4916. while (valb >= 0) {
  4917. out.push_back(lookup[(val >> valb) & 0x3F]);
  4918. valb -= 6;
  4919. }
  4920. }
  4921. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4922. while (out.size() % 4) {
  4923. out.push_back('=');
  4924. }
  4925. return out;
  4926. }
  4927. inline std::string sha1(const std::string &input) {
  4928. // RFC 3174 SHA-1 implementation
  4929. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4930. return (x << n) | (x >> (32 - n));
  4931. };
  4932. uint32_t h0 = 0x67452301;
  4933. uint32_t h1 = 0xEFCDAB89;
  4934. uint32_t h2 = 0x98BADCFE;
  4935. uint32_t h3 = 0x10325476;
  4936. uint32_t h4 = 0xC3D2E1F0;
  4937. // Pre-processing: adding padding bits
  4938. std::string msg = input;
  4939. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4940. msg.push_back(static_cast<char>(0x80u));
  4941. while (msg.size() % 64 != 56) {
  4942. msg.push_back(0);
  4943. }
  4944. // Append original length in bits as 64-bit big-endian
  4945. for (int i = 56; i >= 0; i -= 8) {
  4946. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4947. }
  4948. // Process each 512-bit chunk
  4949. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4950. uint32_t w[80];
  4951. for (size_t i = 0; i < 16; i++) {
  4952. w[i] =
  4953. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4954. << 24) |
  4955. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4956. << 16) |
  4957. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4958. << 8) |
  4959. (static_cast<uint32_t>(
  4960. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4961. }
  4962. for (int i = 16; i < 80; i++) {
  4963. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4964. }
  4965. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4966. for (int i = 0; i < 80; i++) {
  4967. uint32_t f, k;
  4968. if (i < 20) {
  4969. f = (b & c) | ((~b) & d);
  4970. k = 0x5A827999;
  4971. } else if (i < 40) {
  4972. f = b ^ c ^ d;
  4973. k = 0x6ED9EBA1;
  4974. } else if (i < 60) {
  4975. f = (b & c) | (b & d) | (c & d);
  4976. k = 0x8F1BBCDC;
  4977. } else {
  4978. f = b ^ c ^ d;
  4979. k = 0xCA62C1D6;
  4980. }
  4981. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4982. e = d;
  4983. d = c;
  4984. c = left_rotate(b, 30);
  4985. b = a;
  4986. a = temp;
  4987. }
  4988. h0 += a;
  4989. h1 += b;
  4990. h2 += c;
  4991. h3 += d;
  4992. h4 += e;
  4993. }
  4994. // Produce the final hash as a 20-byte binary string
  4995. std::string hash(20, '\0');
  4996. for (size_t i = 0; i < 4; i++) {
  4997. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4998. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4999. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  5000. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  5001. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  5002. }
  5003. return hash;
  5004. }
  5005. inline std::string websocket_accept_key(const std::string &client_key) {
  5006. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  5007. return base64_encode(sha1(client_key + magic));
  5008. }
  5009. inline bool is_websocket_upgrade(const Request &req) {
  5010. if (req.method != "GET") { return false; }
  5011. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  5012. // list of protocols and asks recipients to match each name
  5013. // case-insensitively, so look for the token rather than compare the whole
  5014. // field value.
  5015. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  5016. // Check Connection: Upgrade
  5017. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  5018. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  5019. // RFC 6455 Section 4.2.1
  5020. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  5021. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  5022. return false;
  5023. }
  5024. static const std::string b64chars =
  5025. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  5026. for (size_t i = 0; i < 22; i++) {
  5027. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  5028. }
  5029. // Check Sec-WebSocket-Version: 13
  5030. auto version = req.get_header_value("Sec-WebSocket-Version");
  5031. if (version != "13") { return false; }
  5032. return true;
  5033. }
  5034. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  5035. inline void fill_random_bytes(unsigned char *out, size_t n) {
  5036. thread_local std::random_device rd;
  5037. size_t filled = 0;
  5038. while (filled < n) {
  5039. auto v = rd();
  5040. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  5041. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  5042. }
  5043. }
  5044. }
  5045. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  5046. const char *data, size_t len, bool fin,
  5047. bool mask) {
  5048. // The header (FIN + opcode, MASK + length, the extended length, the mask
  5049. // key: 14 bytes at most) goes out in one write with the payload's first
  5050. // chunk, so that under TCP_NODELAY a small frame is one segment, not three.
  5051. uint8_t header[14];
  5052. size_t header_len = 0;
  5053. header[header_len++] = static_cast<uint8_t>(
  5054. (fin ? 0x80 : 0x00) | (static_cast<uint8_t>(opcode) & 0x0F));
  5055. uint8_t mask_bit = mask ? 0x80 : 0x00;
  5056. if (len < 126) {
  5057. header[header_len++] = static_cast<uint8_t>(len) | mask_bit;
  5058. } else if (len <= 0xFFFF) {
  5059. header[header_len++] = 126 | mask_bit;
  5060. header[header_len++] = static_cast<uint8_t>((len >> 8) & 0xFF);
  5061. header[header_len++] = static_cast<uint8_t>(len & 0xFF);
  5062. } else {
  5063. header[header_len++] = 127 | mask_bit;
  5064. for (int i = 7; i >= 0; i--) {
  5065. header[header_len++] =
  5066. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  5067. }
  5068. }
  5069. uint8_t mask_key[4] = {0};
  5070. if (mask) {
  5071. fill_random_bytes(mask_key, sizeof(mask_key));
  5072. std::copy(mask_key, mask_key + 4, header + header_len);
  5073. header_len += 4;
  5074. }
  5075. // `n` bytes of the payload from `offset`, masked if they are to be, at `out`
  5076. auto put = [&](char *out, size_t offset, size_t n) {
  5077. for (size_t i = 0; i < n; i++) {
  5078. out[i] = mask ? data[offset + i] ^
  5079. static_cast<char>(mask_key[(offset + i) % 4])
  5080. : data[offset + i];
  5081. }
  5082. };
  5083. const size_t chunk_size = 4096;
  5084. size_t first = (std::min)(len, chunk_size);
  5085. std::vector<char> buf(header_len + first);
  5086. std::copy(header, header + header_len, buf.begin());
  5087. put(buf.data() + header_len, 0, first);
  5088. if (!write_data(strm, buf.data(), buf.size())) { return false; }
  5089. // The rest, masked a chunk at a time, or else as it is
  5090. if (!mask) {
  5091. return first == len || write_data(strm, data + first, len - first);
  5092. }
  5093. for (size_t offset = first; offset < len; offset += chunk_size) {
  5094. size_t n = (std::min)(chunk_size, len - offset);
  5095. put(buf.data(), offset, n);
  5096. if (!write_data(strm, buf.data(), n)) { return false; }
  5097. }
  5098. return true;
  5099. }
  5100. } // namespace detail
  5101. namespace ws {
  5102. namespace impl {
  5103. inline void FrameReader::reset() {
  5104. have_ = 0;
  5105. need_ = 2;
  5106. sized_ = false;
  5107. len_ = 0;
  5108. payload_.clear();
  5109. }
  5110. // Stream::read may return less than asked for -- it hands back whatever its
  5111. // buffer already holds -- so each part of the frame is read in a loop, a byte
  5112. // at a time if that is how it comes. (When read() fails it always records why,
  5113. // so the error belongs to this call and not to an earlier one.)
  5114. inline FrameRead FrameReader::read(Stream &strm, Opcode &opcode,
  5115. std::string &payload, bool &fin,
  5116. bool expect_masked, size_t max_len) {
  5117. // A timeout keeps what was read; anything else ends the frame
  5118. auto stopped = [&]() {
  5119. if (strm.get_error() == Error::Timeout) { return FrameRead::Timeout; }
  5120. reset();
  5121. return FrameRead::Fail;
  5122. };
  5123. auto fail = [&]() {
  5124. reset();
  5125. return FrameRead::Fail;
  5126. };
  5127. while (have_ < need_) {
  5128. auto n = strm.read(reinterpret_cast<char *>(head_) + have_, need_ - have_);
  5129. if (n <= 0) { return stopped(); }
  5130. have_ += static_cast<size_t>(n);
  5131. if (have_ < 2 || need_ > 2) { continue; }
  5132. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  5133. if (head_[0] & 0x70) { return fail(); }
  5134. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  5135. // MUST have a payload length of 125 bytes or less
  5136. auto len7 = head_[1] & 0x7F;
  5137. if ((head_[0] & 0x08) && (!(head_[0] & 0x80) || len7 > 125)) {
  5138. return fail();
  5139. }
  5140. auto masked = (head_[1] & 0x80) != 0;
  5141. if (masked != expect_masked) { return fail(); }
  5142. // The extended length and the mask key follow
  5143. need_ = 2 + (len7 == 126 ? 2 : len7 == 127 ? 8 : 0) + (masked ? 4 : 0);
  5144. }
  5145. if (!sized_) {
  5146. uint64_t len = head_[1] & 0x7F;
  5147. if (len == 126) {
  5148. len = (static_cast<uint64_t>(head_[2]) << 8) | head_[3];
  5149. } else if (len == 127) {
  5150. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  5151. if (head_[2] & 0x80) { return fail(); }
  5152. len = 0;
  5153. for (size_t i = 2; i < 10; i++) {
  5154. len = (len << 8) | head_[i];
  5155. }
  5156. }
  5157. // A max_len of 0 means no limit, as payload_max_length does, and a length
  5158. // size_t cannot hold (32-bit builds) is refused either way.
  5159. if ((max_len > 0 && len > max_len) || !detail::fits_in_size_t(len)) {
  5160. return fail();
  5161. }
  5162. len_ = static_cast<size_t>(len);
  5163. sized_ = true;
  5164. }
  5165. // Grow the payload only as it arrives, since a header alone can announce
  5166. // max_len bytes that never come.
  5167. while (payload_.size() < len_) {
  5168. auto offset = payload_.size();
  5169. auto n = (std::min)(len_ - offset, CPPHTTPLIB_RECV_BUFSIZ);
  5170. payload_.resize(offset + n);
  5171. auto got = strm.read(&payload_[offset], n);
  5172. if (got <= 0) {
  5173. payload_.resize(offset);
  5174. return stopped();
  5175. }
  5176. payload_.resize(offset + static_cast<size_t>(got));
  5177. }
  5178. if (head_[1] & 0x80) {
  5179. const auto *mask_key = head_ + need_ - 4;
  5180. for (size_t i = 0; i < payload_.size(); i++) {
  5181. payload_[i] ^= static_cast<char>(mask_key[i % 4]);
  5182. }
  5183. }
  5184. fin = (head_[0] & 0x80) != 0;
  5185. opcode = static_cast<Opcode>(head_[0] & 0x0F);
  5186. payload = std::move(payload_);
  5187. reset();
  5188. return FrameRead::Ok;
  5189. }
  5190. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  5191. std::string &payload, bool &fin,
  5192. bool expect_masked, size_t max_len) {
  5193. FrameReader reader;
  5194. auto r = reader.read(strm, opcode, payload, fin, expect_masked, max_len);
  5195. return r == FrameRead::Timeout && reader.begun() ? FrameRead::Fail : r;
  5196. }
  5197. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  5198. // be sent followed by a UTF-8 reason.
  5199. inline bool is_valid_close_payload(const std::string &payload) {
  5200. if (payload.empty()) { return true; }
  5201. if (payload.size() < 2) { return false; }
  5202. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  5203. static_cast<uint8_t>(payload[1]);
  5204. auto may_be_sent = (1000 <= code && code <= 1003) ||
  5205. (1007 <= code && code <= 1014) ||
  5206. (3000 <= code && code <= 4999);
  5207. return may_be_sent && is_valid_utf8(payload.substr(2));
  5208. }
  5209. } // namespace impl
  5210. } // namespace ws
  5211. namespace detail {
  5212. // A path a mount point serves: absolute, with no empty segment except a
  5213. // trailing '/', no segment ending in '.' or a space (which covers "." and
  5214. // ".." and names Windows trims into another file's name) and, on Windows, no
  5215. // ':' (which names an NTFS stream, so "a.txt::$DATA" is a.txt), so the file
  5216. // served is the one that req.path names to the handlers that ran before it.
  5217. inline bool is_valid_path(const std::string &path) {
  5218. if (path.empty() || path[0] != '/') { return false; }
  5219. auto beg = size_t{1};
  5220. for (auto i = beg; i <= path.size(); i++) {
  5221. if (i < path.size() && path[i] != '/') {
  5222. if (path[i] == '\0' || path[i] == '\\') { return false; }
  5223. #ifdef _WIN32
  5224. if (path[i] == ':') { return false; }
  5225. #endif
  5226. continue;
  5227. }
  5228. auto len = i - beg;
  5229. if ((len == 0 && i < path.size()) ||
  5230. (len > 0 && (path[i - 1] == '.' || path[i - 1] == ' '))) {
  5231. return false;
  5232. }
  5233. beg = i + 1;
  5234. }
  5235. return true;
  5236. }
  5237. inline bool canonicalize_path(const char *path, std::string &resolved) {
  5238. #if defined(_WIN32)
  5239. // Resolve junctions and symlinks, as realpath() does
  5240. auto wpath = u8string_to_wstring(path);
  5241. if (wpath.empty()) { return false; }
  5242. CREATEFILE2_EXTENDED_PARAMETERS params{};
  5243. params.dwSize = sizeof(params);
  5244. params.dwFileFlags = FILE_FLAG_BACKUP_SEMANTICS; // Needed to open a directory
  5245. auto h = ::CreateFile2(wpath.c_str(), 0,
  5246. FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
  5247. OPEN_EXISTING, &params);
  5248. if (h == INVALID_HANDLE_VALUE) { return false; }
  5249. auto guard = scope_exit([&]() { ::CloseHandle(h); });
  5250. std::wstring wbuf(MAX_PATH, L'\0');
  5251. auto len = ::GetFinalPathNameByHandleW(
  5252. h, &wbuf[0], static_cast<DWORD>(wbuf.size()), FILE_NAME_NORMALIZED);
  5253. if (len >= wbuf.size()) {
  5254. wbuf.resize(len);
  5255. len = ::GetFinalPathNameByHandleW(
  5256. h, &wbuf[0], static_cast<DWORD>(wbuf.size()), FILE_NAME_NORMALIZED);
  5257. }
  5258. if (len == 0 || len >= wbuf.size()) { return false; }
  5259. auto n = ::WideCharToMultiByte(CP_UTF8, 0, wbuf.data(), static_cast<int>(len),
  5260. nullptr, 0, nullptr, nullptr);
  5261. if (n <= 0) { return false; }
  5262. resolved.assign(static_cast<size_t>(n), '\0');
  5263. ::WideCharToMultiByte(CP_UTF8, 0, wbuf.data(), static_cast<int>(len),
  5264. &resolved[0], n, nullptr, nullptr);
  5265. #elif defined(PATH_MAX)
  5266. char buf[PATH_MAX];
  5267. if (realpath(path, buf) == nullptr) { return false; }
  5268. resolved = buf;
  5269. #else
  5270. auto buf = realpath(path, nullptr);
  5271. auto guard = scope_exit([&]() { std::free(buf); });
  5272. if (buf == nullptr) { return false; }
  5273. resolved = buf;
  5274. #endif
  5275. return true;
  5276. }
  5277. inline bool is_path_within_base(const std::string &resolved_path,
  5278. const std::string &resolved_base) {
  5279. #if defined(_WIN32)
  5280. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  5281. resolved_base.size()) == 0;
  5282. #else
  5283. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  5284. resolved_base.size()) == 0;
  5285. #endif
  5286. }
  5287. inline FileStat::FileStat(const std::string &path) {
  5288. #if defined(_WIN32)
  5289. auto wpath = u8string_to_wstring(path.c_str());
  5290. ret_ = _wstat(wpath.c_str(), &st_);
  5291. #else
  5292. ret_ = stat(path.c_str(), &st_);
  5293. #endif
  5294. }
  5295. inline bool FileStat::is_file() const {
  5296. return ret_ >= 0 && S_ISREG(st_.st_mode);
  5297. }
  5298. inline bool FileStat::is_dir() const {
  5299. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  5300. }
  5301. inline time_t FileStat::mtime() const {
  5302. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  5303. : static_cast<time_t>(-1);
  5304. }
  5305. inline size_t FileStat::size() const {
  5306. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  5307. }
  5308. inline std::string encode_path(const std::string &s) {
  5309. std::string result;
  5310. result.reserve(s.size());
  5311. for (size_t i = 0; s[i]; i++) {
  5312. switch (s[i]) {
  5313. case ' ': result += "%20"; break;
  5314. case '+': result += "%2B"; break;
  5315. case '\'': result += "%27"; break;
  5316. case ',': result += "%2C"; break;
  5317. // case ':': result += "%3A"; break; // ok? probably...
  5318. case ';': result += "%3B"; break;
  5319. default:
  5320. auto c = static_cast<uint8_t>(s[i]);
  5321. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  5322. // in a request-target as-is.
  5323. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  5324. result += '%';
  5325. char hex[4];
  5326. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  5327. assert(len == 2);
  5328. result.append(hex, static_cast<size_t>(len));
  5329. } else {
  5330. result += s[i];
  5331. }
  5332. break;
  5333. }
  5334. }
  5335. return result;
  5336. }
  5337. inline std::string file_extension(const std::string &path) {
  5338. auto i = path.size();
  5339. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  5340. i--;
  5341. }
  5342. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  5343. return std::string();
  5344. }
  5345. return path.substr(i);
  5346. }
  5347. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  5348. template <typename T>
  5349. inline bool parse_header(const char *beg, const char *end, T fn);
  5350. template <typename T>
  5351. inline bool parse_header(const char *beg, const char *end, T fn) {
  5352. // Skip trailing spaces and tabs.
  5353. while (beg < end && is_space_or_tab(end[-1])) {
  5354. end--;
  5355. }
  5356. auto p = beg;
  5357. while (p < end && *p != ':') {
  5358. p++;
  5359. }
  5360. auto name = std::string(beg, p);
  5361. if (!detail::fields::is_field_name(name)) { return false; }
  5362. if (p == end) { return false; }
  5363. auto key_end = p;
  5364. if (*p++ != ':') { return false; }
  5365. while (p < end && is_space_or_tab(*p)) {
  5366. p++;
  5367. }
  5368. if (p <= end) {
  5369. auto key_len = key_end - beg;
  5370. if (!key_len) { return false; }
  5371. auto key = std::string(beg, key_end);
  5372. auto val = std::string(p, end);
  5373. if (!detail::fields::is_field_value(val)) { return false; }
  5374. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5375. // percent-decoded by the recipient. Applications that need to interpret a
  5376. // value as a URI component should call httplib::decode_uri_component()
  5377. // (or decode_path_component()) explicitly.
  5378. fn(key, val);
  5379. return true;
  5380. }
  5381. return false;
  5382. }
  5383. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5384. const Headers &src_headers) {
  5385. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5386. // transfer coding is complete when a chunk with a chunk-size of zero is
  5387. // received, possibly followed by a trailer section, and finally terminated by
  5388. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5389. //
  5390. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5391. // doesn't care for the existence of the final CRLF. In other words, it seems
  5392. // to be ok whether the final CRLF exists or not in the chunked data.
  5393. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5394. //
  5395. // According to the reference code in RFC 9112, cpp-httplib now allows
  5396. // chunked transfer coding data without the final CRLF.
  5397. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5398. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5399. "transfer-encoding",
  5400. "content-length",
  5401. "host",
  5402. "authorization",
  5403. "www-authenticate",
  5404. "proxy-authenticate",
  5405. "proxy-authorization",
  5406. "cookie",
  5407. "set-cookie",
  5408. "cache-control",
  5409. "expect",
  5410. "max-forwards",
  5411. "pragma",
  5412. "range",
  5413. "te",
  5414. "age",
  5415. "expires",
  5416. "date",
  5417. "location",
  5418. "retry-after",
  5419. "vary",
  5420. "warning",
  5421. "content-encoding",
  5422. "content-type",
  5423. "content-range",
  5424. "trailer"};
  5425. case_ignore::unordered_set<std::string> declared_trailers;
  5426. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5427. if (!trailer_header.empty()) {
  5428. // split() trims each token and skips empty ones, so the name arrives ready
  5429. // to look up.
  5430. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5431. ',', [&](const char *b, const char *e) {
  5432. // A legitimate message declares only a handful of trailers. Cap the
  5433. // set so a peer cannot grow it without bound: an oversized set only
  5434. // arises from an attempt to force many colliding names into
  5435. // quadratic lookups (case_ignore::hash is unkeyed).
  5436. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5437. return;
  5438. }
  5439. std::string key(b, e);
  5440. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5441. declared_trailers.insert(key);
  5442. }
  5443. });
  5444. }
  5445. size_t trailer_header_count = 0;
  5446. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5447. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5448. // Count every received trailer field, not only the declared ones stored in
  5449. // dest, so undeclared fields cannot keep this loop running past the limit.
  5450. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5451. constexpr auto line_terminator_len = 2;
  5452. auto line_beg = line_reader.ptr();
  5453. auto line_end =
  5454. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5455. if (!parse_header(line_beg, line_end,
  5456. [&](const std::string &key, const std::string &val) {
  5457. if (declared_trailers.find(key) !=
  5458. declared_trailers.end()) {
  5459. dest.emplace(key, val);
  5460. }
  5461. })) {
  5462. return false;
  5463. }
  5464. trailer_header_count++;
  5465. if (!line_reader.getline()) { return false; }
  5466. }
  5467. return true;
  5468. }
  5469. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5470. size_t right) {
  5471. while (b + left < e && is_space_or_tab(b[left])) {
  5472. left++;
  5473. }
  5474. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5475. right--;
  5476. }
  5477. return std::make_pair(left, right);
  5478. }
  5479. inline std::string trim_copy(const std::string &s) {
  5480. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5481. return s.substr(r.first, r.second - r.first);
  5482. }
  5483. inline std::string trim_double_quotes_copy(const std::string &s) {
  5484. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5485. return s.substr(1, s.size() - 2);
  5486. }
  5487. return s;
  5488. }
  5489. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  5490. // here, as browsers send any other backslash, such as one in a Windows path,
  5491. // as it is.
  5492. inline std::string unquote_param(const std::string &s) {
  5493. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  5494. std::string out;
  5495. for (size_t i = 1; i + 1 < s.size(); i++) {
  5496. if (s[i] == '\\' && i + 2 < s.size() &&
  5497. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  5498. i++;
  5499. }
  5500. out += s[i];
  5501. }
  5502. return out;
  5503. }
  5504. inline void
  5505. divide(const char *data, std::size_t size, char d,
  5506. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5507. fn) {
  5508. const auto it = std::find(data, data + size, d);
  5509. const auto found = static_cast<std::size_t>(it != data + size);
  5510. const auto lhs_data = data;
  5511. const auto lhs_size = static_cast<std::size_t>(it - data);
  5512. const auto rhs_data = it + found;
  5513. const auto rhs_size = size - lhs_size - found;
  5514. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5515. }
  5516. inline void
  5517. divide(const std::string &str, char d,
  5518. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5519. fn) {
  5520. divide(str.data(), str.size(), d, std::move(fn));
  5521. }
  5522. inline void split(const char *b, const char *e, char d,
  5523. std::function<void(const char *, const char *)> fn) {
  5524. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5525. }
  5526. inline void split(const char *b, const char *e, char d, size_t m,
  5527. std::function<void(const char *, const char *)> fn) {
  5528. size_t i = 0;
  5529. size_t beg = 0;
  5530. size_t count = 1;
  5531. while (e ? (b + i < e) : (b[i] != '\0')) {
  5532. if (b[i] == d && count < m) {
  5533. auto r = trim(b, e, beg, i);
  5534. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5535. beg = i + 1;
  5536. count++;
  5537. }
  5538. i++;
  5539. }
  5540. if (i) {
  5541. auto r = trim(b, e, beg, i);
  5542. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5543. }
  5544. }
  5545. // Same contract as split(), except that a delimiter inside a quoted-string is
  5546. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5547. // quoted-string, and ';' and '=' are legal characters inside one.
  5548. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5549. std::function<void(const char *, const char *)> fn) {
  5550. size_t i = 0;
  5551. size_t beg = 0;
  5552. size_t count = 1;
  5553. auto in_quotes = false;
  5554. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5555. while (has(i)) {
  5556. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5557. // A quoted-pair, whose second character does not end the string.
  5558. i++;
  5559. } else if (b[i] == '"') {
  5560. in_quotes = !in_quotes;
  5561. } else if (b[i] == d && !in_quotes && count < m) {
  5562. auto r = trim(b, e, beg, i);
  5563. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5564. beg = i + 1;
  5565. count++;
  5566. }
  5567. i++;
  5568. }
  5569. if (i) {
  5570. auto r = trim(b, e, beg, i);
  5571. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5572. }
  5573. }
  5574. inline void split_unquoted(const char *b, const char *e, char d,
  5575. std::function<void(const char *, const char *)> fn) {
  5576. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5577. std::move(fn));
  5578. }
  5579. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5580. // key a token, so the first '=' is the separator even when the value is a
  5581. // quoted-string carrying more of them.
  5582. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5583. std::string &val) {
  5584. divide(
  5585. b, static_cast<std::size_t>(e - b), '=',
  5586. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5587. const auto kr = trim(kb, kb + klen, 0, klen);
  5588. key.assign(kb + kr.first, kb + kr.second);
  5589. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5590. val.assign(vb + vr.first, vb + vr.second);
  5591. });
  5592. }
  5593. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5594. std::function<bool(const char *, const char *)> fn) {
  5595. size_t i = 0;
  5596. size_t beg = 0;
  5597. size_t count = 1;
  5598. while (e ? (b + i < e) : (b[i] != '\0')) {
  5599. if (b[i] == d && count < m) {
  5600. auto r = trim(b, e, beg, i);
  5601. if (r.first < r.second) {
  5602. auto found = fn(&b[r.first], &b[r.second]);
  5603. if (found) { return true; }
  5604. }
  5605. beg = i + 1;
  5606. count++;
  5607. }
  5608. i++;
  5609. }
  5610. if (i) {
  5611. auto r = trim(b, e, beg, i);
  5612. if (r.first < r.second) {
  5613. auto found = fn(&b[r.first], &b[r.second]);
  5614. if (found) { return true; }
  5615. }
  5616. }
  5617. return false;
  5618. }
  5619. inline bool split_find(const char *b, const char *e, char d,
  5620. std::function<bool(const char *, const char *)> fn) {
  5621. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5622. std::move(fn));
  5623. }
  5624. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5625. size_t fixed_buffer_size)
  5626. : strm_(strm), fixed_buffer_(fixed_buffer),
  5627. fixed_buffer_size_(fixed_buffer_size) {}
  5628. inline const char *stream_line_reader::ptr() const {
  5629. if (growable_buffer_.empty()) {
  5630. return fixed_buffer_;
  5631. } else {
  5632. return growable_buffer_.data();
  5633. }
  5634. }
  5635. inline size_t stream_line_reader::size() const {
  5636. if (growable_buffer_.empty()) {
  5637. return fixed_buffer_used_size_;
  5638. } else {
  5639. return growable_buffer_.size();
  5640. }
  5641. }
  5642. inline bool stream_line_reader::end_with_crlf() const {
  5643. auto end = ptr() + size();
  5644. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5645. }
  5646. inline bool stream_line_reader::getline() {
  5647. fixed_buffer_used_size_ = 0;
  5648. growable_buffer_.clear();
  5649. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5650. char prev_byte = 0;
  5651. #endif
  5652. for (size_t i = 0;; i++) {
  5653. // Fast path: whatever the stream has already buffered can be scanned for
  5654. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5655. // call, a bounds check and a one-byte copy per character of the request.
  5656. size_t buffered_size = 0;
  5657. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5658. auto take = buffered_size;
  5659. auto terminated = false;
  5660. for (size_t at = 0; at < buffered_size;) {
  5661. auto nl = static_cast<const char *>(
  5662. memchr(buffered + at, '\n', buffered_size - at));
  5663. if (!nl) { break; }
  5664. auto pos = static_cast<size_t>(nl - buffered);
  5665. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5666. take = pos + 1;
  5667. terminated = true;
  5668. break;
  5669. #else
  5670. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5671. // be the last byte of an earlier chunk, hence prev_byte.
  5672. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5673. take = pos + 1;
  5674. terminated = true;
  5675. break;
  5676. }
  5677. at = pos + 1;
  5678. #endif
  5679. }
  5680. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5681. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5682. prev_byte = buffered[take - 1];
  5683. #endif
  5684. append(buffered, take);
  5685. strm_.consume_buffered(take);
  5686. i += take;
  5687. if (terminated) { return true; }
  5688. continue;
  5689. }
  5690. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5691. // Treat exceptionally long lines as an error to
  5692. // prevent infinite loops/memory exhaustion
  5693. return false;
  5694. }
  5695. char byte;
  5696. auto n = strm_.read(&byte, 1);
  5697. if (n < 0) {
  5698. return false;
  5699. } else if (n == 0) {
  5700. if (i == 0) {
  5701. return false;
  5702. } else {
  5703. break;
  5704. }
  5705. }
  5706. append(byte);
  5707. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5708. if (byte == '\n') { break; }
  5709. #else
  5710. if (prev_byte == '\r' && byte == '\n') { break; }
  5711. prev_byte = byte;
  5712. #endif
  5713. }
  5714. return true;
  5715. }
  5716. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5717. inline void stream_line_reader::append(const char *data, size_t size) {
  5718. // Once the line has outgrown the fixed buffer everything must keep going to
  5719. // the growable one, even if a later chunk would have fit. Without the
  5720. // emptiness check a short append after a long one would land in the fixed
  5721. // buffer, which ptr() and size() no longer look at, and be lost.
  5722. if (growable_buffer_.empty() &&
  5723. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5724. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5725. fixed_buffer_used_size_ += size;
  5726. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5727. } else {
  5728. // Unlike the per-character overload, this can be the very first append of
  5729. // the line, so the fixed buffer may hold nothing and carry no terminator
  5730. // yet. assign() takes an explicit length and does not need one.
  5731. if (growable_buffer_.empty()) {
  5732. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5733. }
  5734. growable_buffer_.append(data, size);
  5735. }
  5736. }
  5737. inline mmap::mmap(const char *path) { open(path); }
  5738. inline mmap::~mmap() { close(); }
  5739. inline bool mmap::open(const char *path) {
  5740. close();
  5741. #if defined(_WIN32)
  5742. auto wpath = u8string_to_wstring(path);
  5743. if (wpath.empty()) { return false; }
  5744. hFile_ =
  5745. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5746. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5747. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5748. LARGE_INTEGER size{};
  5749. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5750. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5751. // See:
  5752. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5753. if (!fits_in_size_t(static_cast<uint64_t>(size.QuadPart))) { return false; }
  5754. size_ = static_cast<size_t>(size.QuadPart);
  5755. hMapping_ =
  5756. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5757. // Special treatment for an empty file...
  5758. if (hMapping_ == NULL && size_ == 0) {
  5759. close();
  5760. is_open_empty_file = true;
  5761. return true;
  5762. }
  5763. if (hMapping_ == NULL) {
  5764. close();
  5765. return false;
  5766. }
  5767. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5768. if (addr_ == nullptr) {
  5769. close();
  5770. return false;
  5771. }
  5772. #else
  5773. // O_NONBLOCK so that opening a FIFO does not wait for a writer.
  5774. fd_ = ::open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
  5775. if (fd_ == -1) { return false; }
  5776. // Only a regular file has a size to serve, unlike a directory or a device.
  5777. struct stat sb;
  5778. if (fstat(fd_, &sb) == -1 || !S_ISREG(sb.st_mode) ||
  5779. !fits_in_size_t(static_cast<uint64_t>(sb.st_size))) {
  5780. close();
  5781. return false;
  5782. }
  5783. size_ = static_cast<size_t>(sb.st_size);
  5784. #endif
  5785. return true;
  5786. }
  5787. inline bool mmap::is_open() const {
  5788. #if defined(_WIN32)
  5789. return is_open_empty_file ? true : addr_ != nullptr;
  5790. #else
  5791. return fd_ != -1;
  5792. #endif
  5793. }
  5794. inline size_t mmap::size() const { return size_; }
  5795. inline void mmap::close() {
  5796. #if defined(_WIN32)
  5797. if (addr_) {
  5798. ::UnmapViewOfFile(addr_);
  5799. addr_ = nullptr;
  5800. }
  5801. if (hMapping_) {
  5802. ::CloseHandle(hMapping_);
  5803. hMapping_ = NULL;
  5804. }
  5805. if (hFile_ != INVALID_HANDLE_VALUE) {
  5806. ::CloseHandle(hFile_);
  5807. hFile_ = INVALID_HANDLE_VALUE;
  5808. }
  5809. is_open_empty_file = false;
  5810. #else
  5811. if (fd_ != -1) {
  5812. ::close(fd_);
  5813. fd_ = -1;
  5814. }
  5815. #endif
  5816. size_ = 0;
  5817. }
  5818. inline int close_socket(socket_t sock) noexcept {
  5819. #ifdef _WIN32
  5820. return closesocket(sock);
  5821. #else
  5822. return close(sock);
  5823. #endif
  5824. }
  5825. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5826. ssize_t res = 0;
  5827. while (true) {
  5828. res = fn();
  5829. if (res < 0 && errno == EINTR) {
  5830. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5831. continue;
  5832. }
  5833. break;
  5834. }
  5835. return res;
  5836. }
  5837. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5838. if (offset >= size_) { return 0; }
  5839. len = (std::min)(len, size_ - offset);
  5840. #if defined(_WIN32)
  5841. // Windows does not let a mapped file be truncated.
  5842. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5843. return len;
  5844. #else
  5845. auto n = handle_EINTR(
  5846. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5847. return n > 0 ? static_cast<size_t>(n) : 0;
  5848. #endif
  5849. }
  5850. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5851. return handle_EINTR([&]() {
  5852. return recv(sock,
  5853. #ifdef _WIN32
  5854. static_cast<char *>(ptr), static_cast<int>(size),
  5855. #else
  5856. ptr, size,
  5857. #endif
  5858. flags);
  5859. });
  5860. }
  5861. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5862. int flags) {
  5863. return handle_EINTR([&]() {
  5864. return send(sock,
  5865. #ifdef _WIN32
  5866. static_cast<const char *>(ptr), static_cast<int>(size),
  5867. #else
  5868. ptr, size,
  5869. #endif
  5870. flags);
  5871. });
  5872. }
  5873. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5874. #ifdef _WIN32
  5875. return ::WSAPoll(fds, nfds, timeout);
  5876. #else
  5877. return ::poll(fds, nfds, timeout);
  5878. #endif
  5879. }
  5880. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5881. time_t usec) {
  5882. struct pollfd pfd;
  5883. pfd.fd = sock;
  5884. pfd.events = events;
  5885. pfd.revents = 0;
  5886. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5887. // "return immediately", which callers here rely on to probe a socket.
  5888. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5889. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5890. }
  5891. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5892. return select_impl(sock, POLLIN, sec, usec);
  5893. }
  5894. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5895. return select_impl(sock, POLLOUT, sec, usec);
  5896. }
  5897. // The point sec and usec from now, for select_until(). A negative sec, or one
  5898. // past what the clock reaches, never comes.
  5899. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5900. time_t usec) {
  5901. auto now = std::chrono::steady_clock::now();
  5902. auto never = (std::chrono::steady_clock::time_point::max)();
  5903. if (sec < 0 ||
  5904. sec >= std::chrono::duration_cast<std::chrono::seconds>(never - now)
  5905. .count()) {
  5906. return never;
  5907. }
  5908. return now + std::chrono::seconds(sec) + std::chrono::microseconds(usec);
  5909. }
  5910. // Waits only for the time left until deadline, so that all the waits of one
  5911. // TLS handshake come out of a single timeout. With interrupted, it waits in
  5912. // slices and gives up once interrupted() returns true, as a local shutdown()
  5913. // would not wake the wait on Windows.
  5914. inline ssize_t
  5915. select_until(socket_t sock, short events,
  5916. std::chrono::steady_clock::time_point deadline,
  5917. const std::function<bool()> &interrupted = nullptr) {
  5918. if (!interrupted) {
  5919. if (deadline == (std::chrono::steady_clock::time_point::max)()) {
  5920. return select_impl(sock, events, -1, 0);
  5921. }
  5922. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5923. deadline - std::chrono::steady_clock::now())
  5924. .count();
  5925. if (left <= 0) { return 0; }
  5926. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5927. static_cast<time_t>(left % 1000000));
  5928. }
  5929. const auto slice = std::chrono::microseconds(100000);
  5930. while (!interrupted()) {
  5931. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5932. deadline - std::chrono::steady_clock::now());
  5933. auto last = left < slice;
  5934. // poll() takes whole milliseconds, so round the last wait up to keep it
  5935. // from ending before the deadline.
  5936. auto wait_usec = last ? (std::max)((left.count() + 999) / 1000 * 1000,
  5937. static_cast<decltype(left.count())>(0))
  5938. : slice.count();
  5939. auto ret = select_impl(sock, events, 0, static_cast<time_t>(wait_usec));
  5940. if (ret != 0 || last) { return ret; }
  5941. }
  5942. return 0;
  5943. }
  5944. // select_impl(), but waits in slices and gives up once interrupted() returns
  5945. // true
  5946. inline ssize_t select_interruptible(socket_t sock, short events, time_t sec,
  5947. time_t usec,
  5948. const std::function<bool()> &interrupted) {
  5949. if (!interrupted) { return select_impl(sock, events, sec, usec); }
  5950. return select_until(sock, events, deadline_after(sec, usec), interrupted);
  5951. }
  5952. inline ssize_t
  5953. select_read_interruptible(socket_t sock, time_t sec, time_t usec,
  5954. const std::function<bool()> &interrupted) {
  5955. return select_interruptible(sock, POLLIN, sec, usec, interrupted);
  5956. }
  5957. // Waits for a connect in progress, which ends as Error::Canceled once
  5958. // interrupted() returns true
  5959. inline Error
  5960. wait_until_socket_is_ready(socket_t sock, time_t sec, time_t usec,
  5961. const std::function<bool()> &interrupted = nullptr) {
  5962. auto ret =
  5963. select_interruptible(sock, POLLIN | POLLOUT, sec, usec, interrupted);
  5964. if (ret == 0) {
  5965. return interrupted && interrupted() ? Error::Canceled
  5966. : Error::ConnectionTimeout;
  5967. }
  5968. if (ret < 0) { return Error::Connection; }
  5969. // A failed connect reports its error here, whatever events poll() returned
  5970. auto error = 0;
  5971. socklen_t len = sizeof(error);
  5972. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5973. reinterpret_cast<char *>(&error), &len);
  5974. return res >= 0 && !error ? Error::Success : Error::Connection;
  5975. }
  5976. inline bool is_socket_alive(socket_t sock) {
  5977. const auto val = detail::select_read(sock, 0, 0);
  5978. if (val == 0) {
  5979. return true;
  5980. } else if (val < 0 && errno == EBADF) {
  5981. return false;
  5982. }
  5983. char buf[1];
  5984. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5985. }
  5986. class SocketStream final : public Stream {
  5987. public:
  5988. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5989. time_t write_timeout_sec, time_t write_timeout_usec,
  5990. time_t max_timeout_msec = 0,
  5991. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5992. (std::chrono::steady_clock::time_point::min)());
  5993. ~SocketStream() override;
  5994. bool is_readable() const override;
  5995. bool wait_readable() const override;
  5996. bool wait_writable() const override;
  5997. bool is_peer_alive() const override;
  5998. ssize_t read(char *ptr, size_t size) override;
  5999. ssize_t write(const char *ptr, size_t size) override;
  6000. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  6001. void get_local_ip_and_port(std::string &ip, int &port) const override;
  6002. socket_t socket() const override;
  6003. time_t duration() const override;
  6004. void set_read_timeout(time_t sec, time_t usec = 0) override;
  6005. void set_max_timeout(time_t msec) override;
  6006. void set_read_interrupt(std::function<bool()> interrupted) override;
  6007. const char *buffered_data(size_t &size) const override;
  6008. void consume_buffered(size_t size) override;
  6009. // The caller has just seen this socket become readable. Lets the next read
  6010. // skip its own readiness wait, which would otherwise ask the kernel a
  6011. // question that was answered a moment ago. Consumed by that read.
  6012. void set_readable_hint() { readable_hint_ = true; }
  6013. private:
  6014. bool ensure_readable();
  6015. socket_t sock_;
  6016. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  6017. // thread while a read is in flight -- that is the point of it, for a caller
  6018. // holding one connection and wanting control back to send on it.
  6019. std::atomic<time_t> read_timeout_sec_;
  6020. std::atomic<time_t> read_timeout_usec_;
  6021. time_t write_timeout_sec_;
  6022. time_t write_timeout_usec_;
  6023. time_t max_timeout_msec_;
  6024. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  6025. std::function<bool()> read_interrupted_;
  6026. std::vector<char> read_buff_;
  6027. size_t read_buff_off_ = 0;
  6028. size_t read_buff_content_size_ = 0;
  6029. bool readable_hint_ = false;
  6030. static const size_t read_buff_size_ = 1024l * 4;
  6031. };
  6032. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  6033. time_t keep_alive_timeout_sec) {
  6034. using namespace std::chrono;
  6035. const auto interval_usec =
  6036. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  6037. // Avoid expensive `steady_clock::now()` call for the first time
  6038. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  6039. const auto start = steady_clock::now() - microseconds{interval_usec};
  6040. const auto timeout = seconds{keep_alive_timeout_sec};
  6041. while (true) {
  6042. if (svr_sock == INVALID_SOCKET) {
  6043. break; // Server socket is closed
  6044. }
  6045. auto val = select_read(sock, 0, interval_usec);
  6046. if (val < 0) {
  6047. break; // Ssocket error
  6048. } else if (val == 0) {
  6049. if (steady_clock::now() - start > timeout) {
  6050. break; // Timeout
  6051. }
  6052. } else {
  6053. return true; // Ready for read
  6054. }
  6055. }
  6056. return false;
  6057. }
  6058. // `has_buffered_request` reports whether the connection's stream already holds
  6059. // bytes of the next request. A client may pipeline its requests (RFC 9112
  6060. // 9.3.2), so reading one request can pull the start of the next one into the
  6061. // stream's buffer; that request must be served without waiting for the socket
  6062. // to become readable again, since its bytes are no longer on the socket.
  6063. // `callback` is told whether keep_alive() has just seen the socket go readable.
  6064. template <typename P, typename T>
  6065. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  6066. socket_t sock,
  6067. size_t keep_alive_max_count,
  6068. time_t keep_alive_timeout_sec,
  6069. P has_buffered_request, T callback) {
  6070. auto ret = false;
  6071. // A keep_alive_max_count of 0 sets no limit.
  6072. for (size_t served = 0;
  6073. keep_alive_max_count == 0 || served < keep_alive_max_count; served++) {
  6074. auto socket_readable = false;
  6075. if (!has_buffered_request()) {
  6076. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  6077. socket_readable = true;
  6078. }
  6079. auto close_connection = served + 1 == keep_alive_max_count;
  6080. auto connection_closed = false;
  6081. ret = callback(socket_readable, close_connection, connection_closed);
  6082. if (!ret || connection_closed) { break; }
  6083. }
  6084. return ret;
  6085. }
  6086. template <typename T>
  6087. inline bool
  6088. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  6089. size_t keep_alive_max_count,
  6090. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  6091. time_t read_timeout_usec, time_t write_timeout_sec,
  6092. time_t write_timeout_usec, T callback) {
  6093. // One stream per connection: its read buffer can already hold the start of
  6094. // the next, pipelined request.
  6095. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  6096. write_timeout_sec, write_timeout_usec);
  6097. return process_server_socket_core(
  6098. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  6099. [&]() { return strm.is_readable(); },
  6100. [&](bool socket_readable, bool close_connection,
  6101. bool &connection_closed) {
  6102. if (socket_readable) { strm.set_readable_hint(); }
  6103. return callback(strm, close_connection, connection_closed);
  6104. });
  6105. }
  6106. inline bool process_client_socket(
  6107. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  6108. time_t write_timeout_sec, time_t write_timeout_usec,
  6109. time_t max_timeout_msec,
  6110. std::chrono::time_point<std::chrono::steady_clock> start_time,
  6111. std::function<bool(Stream &)> callback) {
  6112. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  6113. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  6114. start_time);
  6115. return callback(strm);
  6116. }
  6117. inline int shutdown_socket(socket_t sock) noexcept {
  6118. #ifdef _WIN32
  6119. return shutdown(sock, SD_BOTH);
  6120. #else
  6121. return shutdown(sock, SHUT_RDWR);
  6122. #endif
  6123. }
  6124. // Half-closes the write side and drains any in-flight/queued bytes before
  6125. // the final shutdown+close. Closing with unread data in the receive queue
  6126. // (or bytes arriving after the receive side is closed) makes the stack send
  6127. // an abortive RST instead of a graceful FIN, which can make the peer see the
  6128. // response as a failed read even though it was fully written.
  6129. inline void drain_and_close_socket(socket_t sock) noexcept {
  6130. #ifdef _WIN32
  6131. shutdown(sock, SD_SEND);
  6132. #else
  6133. shutdown(sock, SHUT_WR);
  6134. #endif
  6135. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6136. size_t total = 0;
  6137. const auto deadline = std::chrono::steady_clock::now() +
  6138. std::chrono::milliseconds(100); // bound #1
  6139. while (total < size_t(1024u * 1024u)) { // bound #2
  6140. const auto remaining =
  6141. std::chrono::duration_cast<std::chrono::microseconds>(
  6142. deadline - std::chrono::steady_clock::now())
  6143. .count();
  6144. if (remaining <= 0) { break; }
  6145. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  6146. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  6147. if (n <= 0) { break; }
  6148. total += static_cast<size_t>(n);
  6149. }
  6150. shutdown_socket(sock);
  6151. close_socket(sock);
  6152. }
  6153. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  6154. if (s.size() > 1 && s[0] == '\0') {
  6155. auto ret = s;
  6156. ret[0] = '@';
  6157. return ret;
  6158. }
  6159. return s;
  6160. }
  6161. inline std::string
  6162. unescape_abstract_namespace_unix_domain(const std::string &s) {
  6163. if (s.size() > 1 && s[0] == '@') {
  6164. auto ret = s;
  6165. ret[0] = '\0';
  6166. return ret;
  6167. }
  6168. return s;
  6169. }
  6170. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  6171. const struct addrinfo *hints,
  6172. struct addrinfo **res, time_t timeout_sec) {
  6173. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  6174. if (timeout_sec <= 0) {
  6175. // No timeout specified, use standard getaddrinfo
  6176. return getaddrinfo(node, service, hints, res);
  6177. }
  6178. #ifdef _WIN32
  6179. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  6180. OVERLAPPED overlapped = {};
  6181. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  6182. if (!event) { return EAI_FAIL; }
  6183. overlapped.hEvent = event;
  6184. PADDRINFOEXW result_addrinfo = nullptr;
  6185. HANDLE cancel_handle = nullptr;
  6186. ADDRINFOEXW hints_ex = {};
  6187. if (hints) {
  6188. hints_ex.ai_flags = hints->ai_flags;
  6189. hints_ex.ai_family = hints->ai_family;
  6190. hints_ex.ai_socktype = hints->ai_socktype;
  6191. hints_ex.ai_protocol = hints->ai_protocol;
  6192. }
  6193. auto wnode = u8string_to_wstring(node);
  6194. auto wservice = u8string_to_wstring(service);
  6195. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  6196. hints ? &hints_ex : nullptr, &result_addrinfo,
  6197. nullptr, &overlapped, nullptr, &cancel_handle);
  6198. if (ret == WSA_IO_PENDING) {
  6199. auto wait_result =
  6200. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  6201. if (wait_result == WAIT_TIMEOUT) {
  6202. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  6203. ::CloseHandle(event);
  6204. return EAI_AGAIN;
  6205. }
  6206. DWORD bytes_returned;
  6207. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  6208. &bytes_returned, FALSE)) {
  6209. ::CloseHandle(event);
  6210. return ::WSAGetLastError();
  6211. }
  6212. }
  6213. ::CloseHandle(event);
  6214. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  6215. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  6216. return 0;
  6217. }
  6218. return ret;
  6219. #elif TARGET_OS_MAC && defined(__clang__)
  6220. if (!node) { return EAI_NONAME; }
  6221. // macOS implementation using CFHost API for asynchronous DNS resolution
  6222. CFStringRef hostname_ref = CFStringCreateWithCString(
  6223. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  6224. if (!hostname_ref) { return EAI_MEMORY; }
  6225. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  6226. CFRelease(hostname_ref);
  6227. if (!host_ref) { return EAI_MEMORY; }
  6228. // Set up context for callback
  6229. struct CFHostContext {
  6230. bool completed = false;
  6231. bool success = false;
  6232. CFArrayRef addresses = nullptr;
  6233. std::mutex mutex;
  6234. std::condition_variable cv;
  6235. } context;
  6236. CFHostClientContext client_context;
  6237. memset(&client_context, 0, sizeof(client_context));
  6238. client_context.info = &context;
  6239. // Set callback
  6240. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  6241. const CFStreamError *error, void *info) {
  6242. auto ctx = static_cast<CFHostContext *>(info);
  6243. std::lock_guard<std::mutex> lock(ctx->mutex);
  6244. if (error && error->error != 0) {
  6245. ctx->success = false;
  6246. } else {
  6247. Boolean hasBeenResolved;
  6248. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  6249. if (ctx->addresses && hasBeenResolved) {
  6250. CFRetain(ctx->addresses);
  6251. ctx->success = true;
  6252. } else {
  6253. ctx->success = false;
  6254. }
  6255. }
  6256. ctx->completed = true;
  6257. ctx->cv.notify_one();
  6258. };
  6259. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  6260. CFRelease(host_ref);
  6261. return EAI_SYSTEM;
  6262. }
  6263. // Schedule on run loop
  6264. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  6265. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6266. // Start resolution
  6267. CFStreamError stream_error;
  6268. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  6269. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6270. CFRelease(host_ref);
  6271. return EAI_FAIL;
  6272. }
  6273. // Wait for completion with timeout
  6274. auto timeout_time =
  6275. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  6276. bool timed_out = false;
  6277. {
  6278. std::unique_lock<std::mutex> lock(context.mutex);
  6279. while (!context.completed) {
  6280. auto now = std::chrono::steady_clock::now();
  6281. if (now >= timeout_time) {
  6282. timed_out = true;
  6283. break;
  6284. }
  6285. // Run the runloop for a short time
  6286. lock.unlock();
  6287. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  6288. lock.lock();
  6289. }
  6290. }
  6291. // Clean up
  6292. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6293. CFHostSetClient(host_ref, nullptr, nullptr);
  6294. if (timed_out || !context.completed) {
  6295. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  6296. CFRelease(host_ref);
  6297. return EAI_AGAIN;
  6298. }
  6299. if (!context.success || !context.addresses) {
  6300. CFRelease(host_ref);
  6301. return EAI_NODATA;
  6302. }
  6303. // Convert CFArray to addrinfo
  6304. CFIndex count = CFArrayGetCount(context.addresses);
  6305. if (count == 0) {
  6306. CFRelease(context.addresses);
  6307. CFRelease(host_ref);
  6308. return EAI_NODATA;
  6309. }
  6310. struct addrinfo *result_addrinfo = nullptr;
  6311. struct addrinfo **current = &result_addrinfo;
  6312. for (CFIndex i = 0; i < count; i++) {
  6313. CFDataRef addr_data =
  6314. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  6315. if (!addr_data) continue;
  6316. const struct sockaddr *sockaddr_ptr =
  6317. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  6318. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  6319. // Allocate addrinfo structure
  6320. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  6321. if (!*current) {
  6322. freeaddrinfo(result_addrinfo);
  6323. CFRelease(context.addresses);
  6324. CFRelease(host_ref);
  6325. return EAI_MEMORY;
  6326. }
  6327. memset(*current, 0, sizeof(struct addrinfo));
  6328. // Set up addrinfo fields
  6329. (*current)->ai_family = sockaddr_ptr->sa_family;
  6330. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  6331. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  6332. (*current)->ai_addrlen = sockaddr_len;
  6333. // Copy sockaddr
  6334. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  6335. if (!(*current)->ai_addr) {
  6336. freeaddrinfo(result_addrinfo);
  6337. CFRelease(context.addresses);
  6338. CFRelease(host_ref);
  6339. return EAI_MEMORY;
  6340. }
  6341. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  6342. // Set port if service is specified
  6343. if (service && *service) {
  6344. int port = 0;
  6345. if (parse_port(service, strlen(service), port)) {
  6346. if (sockaddr_ptr->sa_family == AF_INET) {
  6347. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  6348. ->sin_port = htons(static_cast<uint16_t>(port));
  6349. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  6350. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  6351. ->sin6_port = htons(static_cast<uint16_t>(port));
  6352. }
  6353. }
  6354. }
  6355. current = &((*current)->ai_next);
  6356. }
  6357. CFRelease(context.addresses);
  6358. CFRelease(host_ref);
  6359. *res = result_addrinfo;
  6360. return 0;
  6361. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  6362. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  6363. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  6364. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  6365. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  6366. // the resolver worker still references the stack-local gaicb. The cancel
  6367. // path therefore waits (gai_suspend with no timeout) for the worker to
  6368. // actually finish before letting the stack frame go. The trade-off is that
  6369. // a wedged DNS server can hold this thread for the system resolver timeout
  6370. // (~30s by default) past the caller's connection timeout.
  6371. struct gaicb request{};
  6372. struct gaicb *requests[1] = {&request};
  6373. struct sigevent sevp{};
  6374. struct timespec timeout{timeout_sec, 0};
  6375. request.ar_name = node;
  6376. request.ar_service = service;
  6377. request.ar_request = hints;
  6378. sevp.sigev_notify = SIGEV_NONE;
  6379. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  6380. if (rc != 0) { return rc; }
  6381. auto cleanup = scope_exit([&] {
  6382. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  6383. });
  6384. int wait_result = gai_suspend(requests, 1, &timeout);
  6385. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  6386. int gai_result = gai_error(&request);
  6387. if (gai_result == 0) {
  6388. *res = request.ar_result;
  6389. request.ar_result = nullptr;
  6390. return 0;
  6391. }
  6392. return gai_result;
  6393. }
  6394. gai_cancel(&request);
  6395. while (gai_error(&request) == EAI_INPROGRESS) {
  6396. gai_suspend(requests, 1, nullptr);
  6397. }
  6398. return wait_result;
  6399. #else
  6400. // Fallback implementation using thread-based timeout for other Unix systems.
  6401. struct GetAddrInfoState {
  6402. ~GetAddrInfoState() {
  6403. if (info) { freeaddrinfo(info); }
  6404. }
  6405. std::mutex mutex;
  6406. std::condition_variable result_cv;
  6407. bool completed = false;
  6408. int result = EAI_SYSTEM;
  6409. std::string node;
  6410. std::string service;
  6411. struct addrinfo hints;
  6412. struct addrinfo *info = nullptr;
  6413. };
  6414. // Allocate on the heap, so the resolver thread can keep using the data.
  6415. auto state = std::make_shared<GetAddrInfoState>();
  6416. if (node) { state->node = node; }
  6417. state->service = service;
  6418. state->hints = *hints;
  6419. std::thread resolve_thread([state]() {
  6420. auto thread_result =
  6421. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6422. &state->info);
  6423. std::lock_guard<std::mutex> lock(state->mutex);
  6424. state->result = thread_result;
  6425. state->completed = true;
  6426. state->result_cv.notify_one();
  6427. });
  6428. // Wait for completion or timeout
  6429. std::unique_lock<std::mutex> lock(state->mutex);
  6430. auto finished =
  6431. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6432. [&] { return state->completed; });
  6433. if (finished) {
  6434. // Operation completed within timeout
  6435. resolve_thread.join();
  6436. *res = state->info;
  6437. state->info = nullptr; // Pass ownership to caller
  6438. return state->result;
  6439. } else {
  6440. // Timeout occurred
  6441. resolve_thread.detach(); // Let the thread finish in background
  6442. return EAI_AGAIN; // Return timeout error
  6443. }
  6444. #endif
  6445. #else
  6446. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6447. return getaddrinfo(node, service, hints, res);
  6448. #endif
  6449. }
  6450. template <typename BindOrConnect>
  6451. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6452. int address_family, int socket_flags, bool tcp_nodelay,
  6453. bool ipv6_v6only, SocketOptions socket_options,
  6454. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6455. // Get address info
  6456. const char *node = nullptr;
  6457. struct addrinfo hints;
  6458. struct addrinfo *result;
  6459. memset(&hints, 0, sizeof(struct addrinfo));
  6460. hints.ai_socktype = SOCK_STREAM;
  6461. hints.ai_protocol = IPPROTO_IP;
  6462. if (!ip.empty()) {
  6463. node = ip.c_str();
  6464. // Ask getaddrinfo to convert IP in c-string to address
  6465. hints.ai_family = AF_UNSPEC;
  6466. hints.ai_flags = AI_NUMERICHOST;
  6467. } else {
  6468. if (!host.empty()) { node = host.c_str(); }
  6469. hints.ai_family = address_family;
  6470. hints.ai_flags = socket_flags;
  6471. }
  6472. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6473. if (hints.ai_family == AF_UNIX) {
  6474. const auto addrlen = host.length();
  6475. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6476. #ifdef SOCK_CLOEXEC
  6477. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6478. hints.ai_protocol);
  6479. #else
  6480. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6481. #endif
  6482. if (sock != INVALID_SOCKET) {
  6483. sockaddr_un addr{};
  6484. addr.sun_family = AF_UNIX;
  6485. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6486. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6487. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6488. hints.ai_addrlen = static_cast<socklen_t>(
  6489. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6490. #ifndef SOCK_CLOEXEC
  6491. #ifndef _WIN32
  6492. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6493. #endif
  6494. #endif
  6495. if (socket_options) { socket_options(sock); }
  6496. #ifdef _WIN32
  6497. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6498. // remove the option.
  6499. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6500. #endif
  6501. bool dummy;
  6502. if (!bind_or_connect(sock, hints, dummy)) {
  6503. close_socket(sock);
  6504. sock = INVALID_SOCKET;
  6505. }
  6506. }
  6507. return sock;
  6508. }
  6509. #endif
  6510. auto service = std::to_string(port);
  6511. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6512. timeout_sec)) {
  6513. #if defined __linux__ && !defined __ANDROID__
  6514. res_init();
  6515. #endif
  6516. return INVALID_SOCKET;
  6517. }
  6518. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6519. for (auto rp = result; rp; rp = rp->ai_next) {
  6520. // Create a socket
  6521. #ifdef _WIN32
  6522. auto sock =
  6523. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6524. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6525. /**
  6526. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6527. * and above the socket creation fails on older Windows Systems.
  6528. *
  6529. * Let's try to create a socket the old way in this case.
  6530. *
  6531. * Reference:
  6532. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6533. *
  6534. * WSA_FLAG_NO_HANDLE_INHERIT:
  6535. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6536. * SP1, and later
  6537. *
  6538. */
  6539. if (sock == INVALID_SOCKET) {
  6540. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6541. }
  6542. #else
  6543. #ifdef SOCK_CLOEXEC
  6544. auto sock =
  6545. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6546. #else
  6547. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6548. #endif
  6549. #endif
  6550. if (sock == INVALID_SOCKET) { continue; }
  6551. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6552. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6553. close_socket(sock);
  6554. continue;
  6555. }
  6556. #endif
  6557. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6558. if (rp->ai_family == AF_INET6) {
  6559. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6560. }
  6561. if (socket_options) { socket_options(sock); }
  6562. // bind or connect
  6563. auto quit = false;
  6564. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6565. close_socket(sock);
  6566. if (quit) { break; }
  6567. }
  6568. return INVALID_SOCKET;
  6569. }
  6570. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6571. #ifdef _WIN32
  6572. auto flags = nonblocking ? 1UL : 0UL;
  6573. ioctlsocket(sock, FIONBIO, &flags);
  6574. #else
  6575. auto flags = fcntl(sock, F_GETFL, 0);
  6576. fcntl(sock, F_SETFL,
  6577. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6578. #endif
  6579. }
  6580. inline bool is_connection_error() {
  6581. #ifdef _WIN32
  6582. return WSAGetLastError() != WSAEWOULDBLOCK;
  6583. #else
  6584. return errno != EINPROGRESS;
  6585. #endif
  6586. }
  6587. // accept() failed because the process or the network stack is temporarily out
  6588. // of resources. The listening socket is still usable, so back off briefly and
  6589. // try again.
  6590. inline bool is_accept_resource_error() {
  6591. #ifdef _WIN32
  6592. auto err = WSAGetLastError();
  6593. return err == WSAEMFILE || err == WSAENOBUFS;
  6594. #else
  6595. auto err = errno;
  6596. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6597. #endif
  6598. }
  6599. // accept() failed for a reason that says nothing about the listening socket:
  6600. // the pending connection went away before it could be accepted, or the call
  6601. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6602. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6603. // connection that way.
  6604. inline bool is_accept_transient_error() {
  6605. #ifdef _WIN32
  6606. auto err = WSAGetLastError();
  6607. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6608. err == WSAECONNABORTED;
  6609. #else
  6610. auto err = errno;
  6611. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6612. err == ECONNABORTED;
  6613. #endif
  6614. }
  6615. inline bool create_socket_pair(socket_t sv[2]) {
  6616. #ifdef _WIN32
  6617. auto listener = create_socket(
  6618. std::string(), "127.0.0.1", 0, AF_INET, 0, false, false, nullptr,
  6619. [](socket_t sock, struct addrinfo &ai, bool &) {
  6620. return ::bind(sock, ai.ai_addr, static_cast<int>(ai.ai_addrlen)) == 0 &&
  6621. ::listen(sock, 1) == 0;
  6622. });
  6623. if (listener == INVALID_SOCKET) { return false; }
  6624. socket_t a = INVALID_SOCKET;
  6625. socket_t b = INVALID_SOCKET;
  6626. sockaddr_in addr{};
  6627. auto addr_len = static_cast<int>(sizeof(addr));
  6628. if (::getsockname(listener, reinterpret_cast<sockaddr *>(&addr), &addr_len) ==
  6629. 0) {
  6630. a = create_socket(std::string(), "127.0.0.1", ntohs(addr.sin_port), AF_INET,
  6631. 0, true, false, nullptr,
  6632. [](socket_t sock, struct addrinfo &ai, bool &) {
  6633. return ::connect(sock, ai.ai_addr,
  6634. static_cast<int>(ai.ai_addrlen)) == 0;
  6635. });
  6636. // Unlike accept(), this keeps the listener's no-inherit flag.
  6637. if (a != INVALID_SOCKET) {
  6638. b = WSAAccept(listener, nullptr, nullptr, nullptr, 0);
  6639. }
  6640. }
  6641. close_socket(listener);
  6642. // Any local process could connect while the listener was open, so make sure
  6643. // that the connection we accepted is the one we made.
  6644. if (b != INVALID_SOCKET) {
  6645. sockaddr_in local{}, peer{};
  6646. auto local_len = static_cast<int>(sizeof(local));
  6647. auto peer_len = static_cast<int>(sizeof(peer));
  6648. if (::getsockname(a, reinterpret_cast<sockaddr *>(&local), &local_len) !=
  6649. 0 ||
  6650. ::getpeername(b, reinterpret_cast<sockaddr *>(&peer), &peer_len) != 0 ||
  6651. local.sin_port != peer.sin_port ||
  6652. local.sin_addr.s_addr != peer.sin_addr.s_addr) {
  6653. close_socket(b);
  6654. b = INVALID_SOCKET;
  6655. }
  6656. }
  6657. if (b == INVALID_SOCKET) {
  6658. if (a != INVALID_SOCKET) { close_socket(a); }
  6659. return false;
  6660. }
  6661. sv[0] = a;
  6662. sv[1] = b;
  6663. return true;
  6664. #else
  6665. #ifdef SOCK_CLOEXEC
  6666. return ::socketpair(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0, sv) == 0;
  6667. #else
  6668. if (::socketpair(AF_UNIX, SOCK_STREAM, 0, sv) != 0) { return false; }
  6669. fcntl(sv[0], F_SETFD, FD_CLOEXEC);
  6670. fcntl(sv[1], F_SETFD, FD_CLOEXEC);
  6671. return true;
  6672. #endif
  6673. #endif
  6674. }
  6675. inline PollerWaker::~PollerWaker() {
  6676. if (pair_fd_ != INVALID_SOCKET) { close_socket(pair_fd_); }
  6677. if (fd_ != INVALID_SOCKET) { close_socket(fd_); }
  6678. }
  6679. inline bool PollerWaker::open() {
  6680. // wake() must not block its caller, and drain() must not block the poller.
  6681. #ifdef __linux__
  6682. fd_ = eventfd(0, EFD_NONBLOCK | EFD_CLOEXEC);
  6683. return fd_ != INVALID_SOCKET;
  6684. #else
  6685. socket_t sv[2];
  6686. if (!create_socket_pair(sv)) { return false; }
  6687. fd_ = sv[0];
  6688. pair_fd_ = sv[1];
  6689. set_nonblocking(fd_, true);
  6690. set_nonblocking(pair_fd_, true);
  6691. return true;
  6692. #endif
  6693. }
  6694. inline void PollerWaker::wake() noexcept {
  6695. if (pending_.exchange(true)) { return; }
  6696. #ifdef __linux__
  6697. const uint64_t one = 1;
  6698. auto r = write(fd_, &one, sizeof(one));
  6699. (void)r;
  6700. #else
  6701. const char c = 1;
  6702. send_socket(pair_fd_, &c, 1, CPPHTTPLIB_SEND_FLAGS);
  6703. #endif
  6704. }
  6705. inline void PollerWaker::drain() noexcept {
  6706. // While pending_ is set, at most one wake is unread, and one read takes it.
  6707. #ifdef __linux__
  6708. uint64_t count;
  6709. auto r = read(fd_, &count, sizeof(count));
  6710. (void)r;
  6711. #else
  6712. char buf[64];
  6713. read_socket(fd_, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  6714. #endif
  6715. // Only after the read: cleared before it, a wake() in between would be read
  6716. // here and leave pending_ set with nothing to read. One skipped during the
  6717. // read is fine, as the caller checks what it was woken for afterwards.
  6718. pending_ = false;
  6719. }
  6720. inline std::unique_ptr<Poller> PollPoller::create() {
  6721. std::unique_ptr<PollPoller> poller(new PollPoller());
  6722. if (!poller->waker_.open()) { return nullptr; }
  6723. struct pollfd pfd;
  6724. pfd.fd = poller->waker_.fd();
  6725. pfd.events = POLLIN;
  6726. pfd.revents = 0;
  6727. poller->fds_.push_back(pfd);
  6728. poller->tokens_.push_back(0);
  6729. return std::unique_ptr<Poller>(poller.release());
  6730. }
  6731. inline bool PollPoller::arm(socket_t fd, Token token) {
  6732. assert(index_.find(fd) == index_.end());
  6733. struct pollfd pfd;
  6734. pfd.fd = fd;
  6735. pfd.events = POLLIN;
  6736. pfd.revents = 0;
  6737. index_[fd] = fds_.size();
  6738. fds_.push_back(pfd);
  6739. tokens_.push_back(token);
  6740. return true;
  6741. }
  6742. inline void PollPoller::disarm(socket_t fd) {
  6743. auto it = index_.find(fd);
  6744. if (it != index_.end()) { remove_at(it->second); }
  6745. }
  6746. // Fills the hole with the last entry, so that arm() and disarm() are O(1).
  6747. inline void PollPoller::remove_at(size_t index) {
  6748. assert(index > 0 && index < fds_.size());
  6749. auto last = fds_.size() - 1;
  6750. index_.erase(fds_[index].fd);
  6751. if (index != last) {
  6752. fds_[index] = fds_[last];
  6753. tokens_[index] = tokens_[last];
  6754. index_[fds_[index].fd] = index;
  6755. }
  6756. fds_.pop_back();
  6757. tokens_.pop_back();
  6758. }
  6759. inline bool PollPoller::wait(int timeout_ms, std::vector<Token> &ready) {
  6760. ready.clear();
  6761. auto n = handle_EINTR([&]() {
  6762. return poll_wrapper(fds_.data(), static_cast<nfds_t>(fds_.size()),
  6763. timeout_ms);
  6764. });
  6765. if (n <= 0) { return false; }
  6766. auto woken = fds_[0].revents != 0;
  6767. if (woken) {
  6768. n--;
  6769. waker_.drain();
  6770. }
  6771. // Walk backwards: remove_at() moves the last entry, already seen, into the
  6772. // freed slot.
  6773. for (auto i = fds_.size(); n > 0 && i-- > 1;) {
  6774. auto revents = fds_[i].revents;
  6775. if (revents == 0) { continue; }
  6776. n--;
  6777. assert(!(revents & POLLNVAL)); // closed while armed
  6778. if (!(revents & POLLNVAL)) { ready.push_back(tokens_[i]); }
  6779. remove_at(i);
  6780. }
  6781. return woken;
  6782. }
  6783. #ifdef __linux__
  6784. inline std::unique_ptr<Poller> EpollPoller::create() {
  6785. std::unique_ptr<EpollPoller> poller(new EpollPoller());
  6786. poller->epfd_ = epoll_create1(EPOLL_CLOEXEC);
  6787. if (poller->epfd_ < 0 || !poller->waker_.open()) { return nullptr; }
  6788. epoll_event ev{};
  6789. ev.events = EPOLLIN; // level-triggered: it stays readable until drained
  6790. ev.data.u64 = poller->waker_.token();
  6791. if (epoll_ctl(poller->epfd_, EPOLL_CTL_ADD, poller->waker_.fd(), &ev) != 0) {
  6792. return nullptr;
  6793. }
  6794. poller->events_.resize(256);
  6795. return std::unique_ptr<Poller>(poller.release());
  6796. }
  6797. inline EpollPoller::~EpollPoller() {
  6798. if (epfd_ >= 0) { close(epfd_); }
  6799. }
  6800. inline bool EpollPoller::arm(socket_t fd, Token token) {
  6801. epoll_event ev{};
  6802. ev.events = EPOLLIN | EPOLLONESHOT;
  6803. ev.data.u64 = token;
  6804. // A delivered descriptor stays registered, only disabled, so modify it.
  6805. // One that was closed in between, or never armed, has to be added.
  6806. return epoll_ctl(epfd_, EPOLL_CTL_MOD, fd, &ev) == 0 ||
  6807. (errno == ENOENT && epoll_ctl(epfd_, EPOLL_CTL_ADD, fd, &ev) == 0);
  6808. }
  6809. inline void EpollPoller::disarm(socket_t fd) {
  6810. epoll_ctl(epfd_, EPOLL_CTL_DEL, fd, nullptr);
  6811. }
  6812. inline bool EpollPoller::wait(int timeout_ms, std::vector<Token> &ready) {
  6813. ready.clear();
  6814. auto n = handle_EINTR([&]() {
  6815. return epoll_wait(epfd_, events_.data(), static_cast<int>(events_.size()),
  6816. timeout_ms);
  6817. });
  6818. auto woken = false;
  6819. for (auto i = 0; i < n; i++) {
  6820. auto token = static_cast<Token>(events_[static_cast<size_t>(i)].data.u64);
  6821. if (token == waker_.token()) {
  6822. woken = true;
  6823. waker_.drain();
  6824. } else {
  6825. ready.push_back(token);
  6826. }
  6827. }
  6828. return woken;
  6829. }
  6830. #endif
  6831. #ifdef CPPHTTPLIB_KQUEUE_POLLER
  6832. inline std::unique_ptr<Poller> KqueuePoller::create() {
  6833. std::unique_ptr<KqueuePoller> poller(new KqueuePoller());
  6834. poller->kq_ = kqueue();
  6835. if (poller->kq_ < 0) { return nullptr; }
  6836. fcntl(poller->kq_, F_SETFD, FD_CLOEXEC);
  6837. if (!poller->waker_.open()) { return nullptr; }
  6838. // Level-triggered: it stays readable until drained.
  6839. struct kevent ev;
  6840. EV_SET(&ev, poller->waker_.fd(), EVFILT_READ, EV_ADD, 0, 0,
  6841. reinterpret_cast<void *>(poller->waker_.token()));
  6842. if (kevent(poller->kq_, &ev, 1, nullptr, 0, nullptr) != 0) { return nullptr; }
  6843. poller->events_.resize(256);
  6844. return std::unique_ptr<Poller>(poller.release());
  6845. }
  6846. inline KqueuePoller::~KqueuePoller() {
  6847. if (kq_ >= 0) { close(kq_); }
  6848. }
  6849. inline bool KqueuePoller::arm(socket_t fd, Token token) {
  6850. // EV_ONESHOT deletes the event once it is delivered.
  6851. struct kevent ev;
  6852. EV_SET(&ev, fd, EVFILT_READ, EV_ADD | EV_ONESHOT, 0, 0,
  6853. reinterpret_cast<void *>(token));
  6854. return kevent(kq_, &ev, 1, nullptr, 0, nullptr) == 0;
  6855. }
  6856. inline void KqueuePoller::disarm(socket_t fd) {
  6857. struct kevent ev;
  6858. EV_SET(&ev, fd, EVFILT_READ, EV_DELETE, 0, 0, nullptr);
  6859. kevent(kq_, &ev, 1, nullptr, 0, nullptr);
  6860. }
  6861. inline bool KqueuePoller::wait(int timeout_ms, std::vector<Token> &ready) {
  6862. ready.clear();
  6863. struct timespec ts;
  6864. ts.tv_sec = timeout_ms / 1000;
  6865. ts.tv_nsec = static_cast<long>(timeout_ms % 1000) * 1000000;
  6866. auto n = handle_EINTR([&]() {
  6867. return kevent(kq_, nullptr, 0, events_.data(),
  6868. static_cast<int>(events_.size()),
  6869. timeout_ms < 0 ? nullptr : &ts);
  6870. });
  6871. auto woken = false;
  6872. for (auto i = 0; i < n; i++) {
  6873. auto token = reinterpret_cast<Token>(events_[static_cast<size_t>(i)].udata);
  6874. if (token == waker_.token()) {
  6875. woken = true;
  6876. waker_.drain();
  6877. } else {
  6878. ready.push_back(token);
  6879. }
  6880. }
  6881. return woken;
  6882. }
  6883. #endif
  6884. inline std::unique_ptr<Poller> make_poller() {
  6885. #if defined(__linux__)
  6886. auto poller = EpollPoller::create();
  6887. if (poller) { return poller; }
  6888. #elif defined(CPPHTTPLIB_KQUEUE_POLLER)
  6889. auto poller = KqueuePoller::create();
  6890. if (poller) { return poller; }
  6891. #endif
  6892. return PollPoller::create();
  6893. }
  6894. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6895. struct addrinfo hints;
  6896. struct addrinfo *result;
  6897. memset(&hints, 0, sizeof(struct addrinfo));
  6898. hints.ai_family = AF_UNSPEC;
  6899. hints.ai_socktype = SOCK_STREAM;
  6900. hints.ai_protocol = 0;
  6901. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6902. return false;
  6903. }
  6904. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6905. auto ret = false;
  6906. for (auto rp = result; rp; rp = rp->ai_next) {
  6907. const auto &ai = *rp;
  6908. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6909. ret = true;
  6910. break;
  6911. }
  6912. }
  6913. return ret;
  6914. }
  6915. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6916. #define USE_IF2IP
  6917. #endif
  6918. #ifdef USE_IF2IP
  6919. inline std::string if2ip(int address_family, const std::string &ifn) {
  6920. struct ifaddrs *ifap;
  6921. getifaddrs(&ifap);
  6922. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6923. std::string addr_candidate;
  6924. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6925. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6926. (AF_UNSPEC == address_family ||
  6927. ifa->ifa_addr->sa_family == address_family)) {
  6928. if (ifa->ifa_addr->sa_family == AF_INET) {
  6929. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6930. char buf[INET_ADDRSTRLEN];
  6931. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6932. return std::string(buf, INET_ADDRSTRLEN);
  6933. }
  6934. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6935. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6936. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6937. char buf[INET6_ADDRSTRLEN] = {};
  6938. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6939. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6940. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6941. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6942. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6943. } else {
  6944. return std::string(buf, INET6_ADDRSTRLEN);
  6945. }
  6946. }
  6947. }
  6948. }
  6949. }
  6950. }
  6951. return addr_candidate;
  6952. }
  6953. #endif
  6954. inline socket_t
  6955. create_client_socket(const std::string &host, const std::string &ip, int port,
  6956. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6957. SocketOptions socket_options,
  6958. time_t connection_timeout_sec,
  6959. time_t connection_timeout_usec, time_t read_timeout_sec,
  6960. time_t read_timeout_usec, time_t write_timeout_sec,
  6961. time_t write_timeout_usec, const std::string &intf,
  6962. Error &error, const std::function<bool()> &interrupted) {
  6963. auto sock = create_socket(
  6964. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6965. std::move(socket_options),
  6966. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6967. if (!intf.empty()) {
  6968. #ifdef USE_IF2IP
  6969. auto ip_from_if = if2ip(address_family, intf);
  6970. if (ip_from_if.empty()) { ip_from_if = intf; }
  6971. if (!bind_ip_address(sock2, ip_from_if)) {
  6972. error = Error::BindIPAddress;
  6973. return false;
  6974. }
  6975. #endif
  6976. }
  6977. set_nonblocking(sock2, true);
  6978. auto ret =
  6979. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6980. if (ret < 0) {
  6981. if (is_connection_error()) {
  6982. error = Error::Connection;
  6983. return false;
  6984. }
  6985. error =
  6986. wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6987. connection_timeout_usec, interrupted);
  6988. if (error != Error::Success) {
  6989. if (error == Error::ConnectionTimeout || error == Error::Canceled) {
  6990. quit = true;
  6991. }
  6992. return false;
  6993. }
  6994. }
  6995. set_nonblocking(sock2, false);
  6996. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6997. read_timeout_usec);
  6998. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6999. write_timeout_usec);
  7000. error = Error::Success;
  7001. return true;
  7002. },
  7003. connection_timeout_sec); // Pass DNS timeout
  7004. if (sock != INVALID_SOCKET) {
  7005. error = Error::Success;
  7006. } else {
  7007. if (error == Error::Success) { error = Error::Connection; }
  7008. }
  7009. return sock;
  7010. }
  7011. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  7012. socklen_t addr_len, std::string &ip, int &port) {
  7013. if (addr.ss_family == AF_INET) {
  7014. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  7015. } else if (addr.ss_family == AF_INET6) {
  7016. port =
  7017. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  7018. } else {
  7019. return false;
  7020. }
  7021. std::array<char, NI_MAXHOST> ipstr{};
  7022. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  7023. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  7024. 0, NI_NUMERICHOST)) {
  7025. return false;
  7026. }
  7027. ip = ipstr.data();
  7028. return true;
  7029. }
  7030. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  7031. struct sockaddr_storage addr;
  7032. socklen_t addr_len = sizeof(addr);
  7033. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  7034. &addr_len)) {
  7035. get_ip_and_port(addr, addr_len, ip, port);
  7036. }
  7037. }
  7038. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  7039. struct sockaddr_storage addr;
  7040. socklen_t addr_len = sizeof(addr);
  7041. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  7042. &addr_len)) {
  7043. #ifndef _WIN32
  7044. if (addr.ss_family == AF_UNIX) {
  7045. #if defined(__linux__)
  7046. struct ucred ucred;
  7047. socklen_t len = sizeof(ucred);
  7048. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  7049. port = ucred.pid;
  7050. }
  7051. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  7052. pid_t pid;
  7053. socklen_t len = sizeof(pid);
  7054. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  7055. port = pid;
  7056. }
  7057. #endif
  7058. return;
  7059. }
  7060. #endif
  7061. get_ip_and_port(addr, addr_len, ip, port);
  7062. }
  7063. }
  7064. inline std::string
  7065. find_content_type(const std::string &path,
  7066. const std::map<std::string, std::string> &user_data,
  7067. const std::string &default_content_type) {
  7068. // Extensions are matched regardless of case, as web servers do
  7069. auto ext = case_ignore::to_lower(file_extension(path));
  7070. auto it = user_data.find(ext);
  7071. if (it != user_data.end()) { return it->second; }
  7072. static const struct {
  7073. const char *ext;
  7074. const char *type;
  7075. } types[] = {
  7076. {"css", "text/css"},
  7077. {"csv", "text/csv"},
  7078. {"htm", "text/html"},
  7079. {"html", "text/html"},
  7080. {"js", "text/javascript"},
  7081. {"mjs", "text/javascript"},
  7082. {"txt", "text/plain"},
  7083. {"vtt", "text/vtt"},
  7084. {"apng", "image/apng"},
  7085. {"avif", "image/avif"},
  7086. {"bmp", "image/bmp"},
  7087. {"gif", "image/gif"},
  7088. {"png", "image/png"},
  7089. {"svg", "image/svg+xml"},
  7090. {"webp", "image/webp"},
  7091. {"ico", "image/x-icon"},
  7092. {"tif", "image/tiff"},
  7093. {"tiff", "image/tiff"},
  7094. {"jpg", "image/jpeg"},
  7095. {"jpeg", "image/jpeg"},
  7096. {"mp4", "video/mp4"},
  7097. {"mpeg", "video/mpeg"},
  7098. {"webm", "video/webm"},
  7099. {"mp3", "audio/mp3"},
  7100. {"mpga", "audio/mpeg"},
  7101. {"weba", "audio/webm"},
  7102. {"wav", "audio/wave"},
  7103. {"otf", "font/otf"},
  7104. {"ttf", "font/ttf"},
  7105. {"woff", "font/woff"},
  7106. {"woff2", "font/woff2"},
  7107. {"7z", "application/x-7z-compressed"},
  7108. {"atom", "application/atom+xml"},
  7109. {"pdf", "application/pdf"},
  7110. {"json", "application/json"},
  7111. {"rss", "application/rss+xml"},
  7112. {"tar", "application/x-tar"},
  7113. {"xht", "application/xhtml+xml"},
  7114. {"xhtml", "application/xhtml+xml"},
  7115. {"xslt", "application/xslt+xml"},
  7116. {"xml", "application/xml"},
  7117. {"gz", "application/gzip"},
  7118. {"zip", "application/zip"},
  7119. {"wasm", "application/wasm"},
  7120. };
  7121. for (const auto &t : types) {
  7122. if (ext == t.ext) { return t.type; }
  7123. }
  7124. return default_content_type;
  7125. }
  7126. inline std::string
  7127. extract_media_type(const std::string &content_type,
  7128. std::map<std::string, std::string> *params = nullptr) {
  7129. // Extract type/subtype from Content-Type value (RFC 2045)
  7130. // e.g. "application/json; charset=utf-8" -> "application/json"
  7131. auto media_type = content_type;
  7132. auto semicolon_pos = media_type.find(';');
  7133. if (semicolon_pos != std::string::npos) {
  7134. auto param_str = media_type.substr(semicolon_pos + 1);
  7135. media_type = media_type.substr(0, semicolon_pos);
  7136. if (params) {
  7137. // Parse parameters: key=value pairs separated by ';'
  7138. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  7139. [&](const char *b, const char *e) {
  7140. std::string key;
  7141. std::string val;
  7142. divide_param_pair(b, e, key, val);
  7143. // Parameter names are case-insensitive (RFC 9110
  7144. // §5.6.6)
  7145. if (!key.empty()) {
  7146. params->emplace(case_ignore::to_lower(trim_copy(key)),
  7147. unquote_param(val));
  7148. }
  7149. });
  7150. }
  7151. }
  7152. // Trim whitespace from media type
  7153. return trim_copy(media_type);
  7154. }
  7155. inline bool can_compress_content_type(const std::string &content_type) {
  7156. // Media types are case-insensitive (RFC 9110 §8.3.1)
  7157. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  7158. static const char *const compressible[] = {
  7159. "image/svg+xml",
  7160. "application/javascript",
  7161. "application/x-javascript",
  7162. "application/json",
  7163. "application/ld+json",
  7164. "application/xml",
  7165. "application/xhtml+xml",
  7166. "application/rss+xml",
  7167. "application/atom+xml",
  7168. "application/xslt+xml",
  7169. "application/protobuf",
  7170. };
  7171. for (auto type : compressible) {
  7172. if (mime_type == type) { return true; }
  7173. }
  7174. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  7175. }
  7176. inline bool parse_quality(const char *b, const char *e, std::string &token,
  7177. double &quality) {
  7178. quality = 1.0;
  7179. token.clear();
  7180. // Split on first ';': left = token name, right = parameters
  7181. const char *params_b = nullptr;
  7182. std::size_t params_len = 0;
  7183. divide(
  7184. b, static_cast<std::size_t>(e - b), ';',
  7185. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  7186. auto r = trim(lb, lb + llen, 0, llen);
  7187. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  7188. params_b = rb;
  7189. params_len = rlen;
  7190. });
  7191. if (token.empty()) { return false; }
  7192. if (params_len == 0) { return true; }
  7193. // Scan parameters for q= (stops on first match)
  7194. bool invalid = false;
  7195. split_find(params_b, params_b + params_len, ';',
  7196. (std::numeric_limits<size_t>::max)(),
  7197. [&](const char *pb, const char *pe) -> bool {
  7198. // Match exactly "q=" or "Q=" (not "query=" etc.)
  7199. auto len = static_cast<size_t>(pe - pb);
  7200. if (len < 2) { return false; }
  7201. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  7202. return false;
  7203. }
  7204. // Trim the value portion
  7205. auto r = trim(pb, pe, 2, len);
  7206. if (r.first >= r.second) {
  7207. invalid = true;
  7208. return true;
  7209. }
  7210. double v = 0.0;
  7211. auto res = from_chars(pb + r.first, pb + r.second, v);
  7212. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  7213. v < 0.0 || v > 1.0) {
  7214. invalid = true;
  7215. return true;
  7216. }
  7217. quality = v;
  7218. return true;
  7219. });
  7220. return !invalid;
  7221. }
  7222. inline EncodingType encoding_type(const Request &req,
  7223. const std::string &content_type) {
  7224. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  7225. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  7226. if (s.empty()) { return EncodingType::None; }
  7227. // Single-pass: iterate tokens and track the best supported encoding.
  7228. // Server preference breaks ties (br > gzip > zstd).
  7229. EncodingType best = EncodingType::None;
  7230. double best_q = 0.0; // q=0 means "not acceptable"
  7231. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  7232. auto priority = [](EncodingType t) -> int {
  7233. switch (t) {
  7234. case EncodingType::Brotli: return 0;
  7235. case EncodingType::Gzip: return 1;
  7236. case EncodingType::Zstd: return 2;
  7237. default: return 3;
  7238. }
  7239. };
  7240. std::string name;
  7241. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7242. double quality = 1.0;
  7243. if (!parse_quality(b, e, name, quality)) { return; }
  7244. if (quality <= 0.0) { return; }
  7245. EncodingType type = EncodingType::None;
  7246. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7247. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  7248. #endif
  7249. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7250. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  7251. type = EncodingType::Gzip;
  7252. }
  7253. #endif
  7254. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7255. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  7256. type = EncodingType::Zstd;
  7257. }
  7258. #endif
  7259. if (type == EncodingType::None) { return; }
  7260. // Higher q-value wins; for equal q, server preference breaks ties
  7261. if (quality > best_q ||
  7262. (quality == best_q && priority(type) < priority(best))) {
  7263. best_q = quality;
  7264. best = type;
  7265. }
  7266. });
  7267. return best;
  7268. }
  7269. // `content_type` is taken separately because a file-backed response has not
  7270. // been given one yet when its coding has to be decided.
  7271. inline EncodingType encoding_type(const Request &req, const Response &res,
  7272. const std::string &content_type) {
  7273. // The response already names a content coding of its own: a handler serving
  7274. // a body it encoded itself (pre-compressed static assets, say), or a mount
  7275. // point whose headers name the coding its files are stored in. Applying one
  7276. // on top of that would double-encode the body and append a second
  7277. // `Content-Encoding` field line.
  7278. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  7279. return encoding_type(req, content_type);
  7280. }
  7281. inline EncodingType encoding_type(const Request &req, const Response &res) {
  7282. return encoding_type(req, res, res.get_header_value("Content-Type"));
  7283. }
  7284. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  7285. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7286. if (type == EncodingType::Gzip) {
  7287. return detail::make_unique<gzip_compressor>();
  7288. }
  7289. #endif
  7290. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7291. if (type == EncodingType::Brotli) {
  7292. return detail::make_unique<brotli_compressor>();
  7293. }
  7294. #endif
  7295. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7296. if (type == EncodingType::Zstd) {
  7297. return detail::make_unique<zstd_compressor>();
  7298. }
  7299. #endif
  7300. (void)type;
  7301. return nullptr;
  7302. }
  7303. inline const char *encoding_name(EncodingType type) {
  7304. switch (type) {
  7305. case EncodingType::Gzip: return "gzip";
  7306. case EncodingType::Brotli: return "br";
  7307. case EncodingType::Zstd: return "zstd";
  7308. default: return "";
  7309. }
  7310. }
  7311. inline bool nocompressor::compress(const char *data, size_t data_length,
  7312. bool /*last*/, Callback callback) {
  7313. if (!data_length) { return true; }
  7314. return callback(data, data_length);
  7315. }
  7316. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7317. inline gzip_compressor::gzip_compressor() {
  7318. std::memset(&strm_, 0, sizeof(strm_));
  7319. strm_.zalloc = Z_NULL;
  7320. strm_.zfree = Z_NULL;
  7321. strm_.opaque = Z_NULL;
  7322. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  7323. Z_DEFAULT_STRATEGY) == Z_OK;
  7324. }
  7325. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  7326. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  7327. bool last, Callback callback) {
  7328. assert(is_valid_);
  7329. do {
  7330. constexpr size_t max_avail_in =
  7331. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  7332. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  7333. (std::min)(data_length, max_avail_in));
  7334. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  7335. data_length -= strm_.avail_in;
  7336. data += strm_.avail_in;
  7337. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  7338. auto ret = Z_OK;
  7339. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7340. do {
  7341. strm_.avail_out = static_cast<uInt>(buff.size());
  7342. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  7343. ret = deflate(&strm_, flush);
  7344. if (ret == Z_STREAM_ERROR) { return false; }
  7345. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  7346. return false;
  7347. }
  7348. } while (strm_.avail_out == 0);
  7349. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  7350. (flush == Z_NO_FLUSH && ret == Z_OK));
  7351. assert(strm_.avail_in == 0);
  7352. } while (data_length > 0);
  7353. return true;
  7354. }
  7355. inline gzip_decompressor::gzip_decompressor() {
  7356. std::memset(&strm_, 0, sizeof(strm_));
  7357. strm_.zalloc = Z_NULL;
  7358. strm_.zfree = Z_NULL;
  7359. strm_.opaque = Z_NULL;
  7360. // 15 is the value of wbits, which should be at the maximum possible value
  7361. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  7362. // that the stream type should be automatically detected either gzip or
  7363. // deflate.
  7364. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  7365. }
  7366. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  7367. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  7368. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  7369. Callback callback) {
  7370. assert(is_valid_);
  7371. auto ret = Z_OK;
  7372. do {
  7373. constexpr size_t max_avail_in =
  7374. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  7375. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  7376. (std::min)(data_length, max_avail_in));
  7377. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  7378. data_length -= strm_.avail_in;
  7379. data += strm_.avail_in;
  7380. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7381. while (strm_.avail_in > 0 && ret == Z_OK) {
  7382. strm_.avail_out = static_cast<uInt>(buff.size());
  7383. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  7384. ret = inflate(&strm_, Z_NO_FLUSH);
  7385. assert(ret != Z_STREAM_ERROR);
  7386. switch (ret) {
  7387. case Z_NEED_DICT:
  7388. case Z_DATA_ERROR:
  7389. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  7390. }
  7391. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  7392. return false;
  7393. }
  7394. }
  7395. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  7396. } while (data_length > 0);
  7397. return true;
  7398. }
  7399. #endif
  7400. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7401. inline brotli_compressor::brotli_compressor() {
  7402. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  7403. }
  7404. inline brotli_compressor::~brotli_compressor() {
  7405. BrotliEncoderDestroyInstance(state_);
  7406. }
  7407. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  7408. bool last, Callback callback) {
  7409. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7410. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  7411. auto available_in = data_length;
  7412. auto next_in = reinterpret_cast<const uint8_t *>(data);
  7413. for (;;) {
  7414. if (last) {
  7415. if (BrotliEncoderIsFinished(state_)) { break; }
  7416. } else {
  7417. if (!available_in) { break; }
  7418. }
  7419. auto available_out = buff.size();
  7420. auto next_out = buff.data();
  7421. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  7422. &available_out, &next_out, nullptr)) {
  7423. return false;
  7424. }
  7425. auto output_bytes = buff.size() - available_out;
  7426. if (output_bytes) {
  7427. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  7428. }
  7429. }
  7430. return true;
  7431. }
  7432. inline brotli_decompressor::brotli_decompressor() {
  7433. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  7434. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  7435. : BROTLI_DECODER_RESULT_ERROR;
  7436. }
  7437. inline brotli_decompressor::~brotli_decompressor() {
  7438. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  7439. }
  7440. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  7441. inline bool brotli_decompressor::decompress(const char *data,
  7442. size_t data_length,
  7443. Callback callback) {
  7444. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  7445. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  7446. return 0;
  7447. }
  7448. auto next_in = reinterpret_cast<const uint8_t *>(data);
  7449. size_t avail_in = data_length;
  7450. size_t total_out;
  7451. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  7452. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7453. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  7454. char *next_out = buff.data();
  7455. size_t avail_out = buff.size();
  7456. decoder_r = BrotliDecoderDecompressStream(
  7457. decoder_s, &avail_in, &next_in, &avail_out,
  7458. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  7459. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  7460. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  7461. }
  7462. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  7463. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  7464. }
  7465. #endif
  7466. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7467. inline zstd_compressor::zstd_compressor() {
  7468. ctx_ = ZSTD_createCCtx();
  7469. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  7470. }
  7471. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  7472. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  7473. bool last, Callback callback) {
  7474. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7475. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  7476. ZSTD_inBuffer input = {data, data_length, 0};
  7477. bool finished;
  7478. do {
  7479. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  7480. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  7481. if (ZSTD_isError(remaining)) { return false; }
  7482. if (!callback(buff.data(), output.pos)) { return false; }
  7483. finished = last ? (remaining == 0) : (input.pos == input.size);
  7484. } while (!finished);
  7485. return true;
  7486. }
  7487. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  7488. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  7489. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  7490. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  7491. Callback callback) {
  7492. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7493. ZSTD_inBuffer input = {data, data_length, 0};
  7494. while (input.pos < input.size) {
  7495. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  7496. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  7497. if (ZSTD_isError(remaining)) { return false; }
  7498. if (!callback(buff.data(), output.pos)) { return false; }
  7499. }
  7500. return true;
  7501. }
  7502. #endif
  7503. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  7504. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  7505. // unknown coding, and its payload would be handed back still compressed.
  7506. inline bool is_zlib_encoding(const std::string &encoding) {
  7507. return case_ignore::equal(encoding, "gzip") ||
  7508. case_ignore::equal(encoding, "deflate");
  7509. }
  7510. inline bool is_brotli_encoding(const std::string &encoding) {
  7511. return case_ignore::equal(encoding, "br");
  7512. }
  7513. inline bool is_zstd_encoding(const std::string &encoding) {
  7514. return case_ignore::equal(encoding, "zstd");
  7515. }
  7516. // Returns true if the content coding is one cpp-httplib is able to decompress
  7517. // when the corresponding support is compiled in.
  7518. inline bool is_known_content_encoding(const std::string &encoding) {
  7519. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  7520. is_zstd_encoding(encoding);
  7521. }
  7522. inline std::unique_ptr<decompressor>
  7523. create_decompressor(const std::string &encoding) {
  7524. std::unique_ptr<decompressor> decompressor;
  7525. if (is_zlib_encoding(encoding)) {
  7526. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7527. decompressor = detail::make_unique<gzip_decompressor>();
  7528. #endif
  7529. } else if (is_brotli_encoding(encoding)) {
  7530. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7531. decompressor = detail::make_unique<brotli_decompressor>();
  7532. #endif
  7533. } else if (is_zstd_encoding(encoding)) {
  7534. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7535. decompressor = detail::make_unique<zstd_decompressor>();
  7536. #endif
  7537. }
  7538. return decompressor;
  7539. }
  7540. // Returns the best available compressor and its Content-Encoding name.
  7541. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  7542. inline std::pair<std::unique_ptr<compressor>, const char *>
  7543. create_compressor() {
  7544. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7545. return {detail::make_unique<brotli_compressor>(), "br"};
  7546. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  7547. return {detail::make_unique<gzip_compressor>(), "gzip"};
  7548. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  7549. return {detail::make_unique<zstd_compressor>(), "zstd"};
  7550. #else
  7551. return {nullptr, nullptr};
  7552. #endif
  7553. }
  7554. inline bool is_prohibited_header_name(const std::string &name) {
  7555. // Field names are case-insensitive (RFC 9110 §5.1)
  7556. return case_ignore::equal(name, "REMOTE_ADDR") ||
  7557. case_ignore::equal(name, "REMOTE_PORT") ||
  7558. case_ignore::equal(name, "LOCAL_ADDR") ||
  7559. case_ignore::equal(name, "LOCAL_PORT");
  7560. }
  7561. inline bool has_header(const Headers &headers, const std::string &key) {
  7562. if (is_prohibited_header_name(key)) { return false; }
  7563. return headers.find(key) != headers.end();
  7564. }
  7565. inline const char *get_header_value(const Headers &headers,
  7566. const std::string &key, const char *def,
  7567. size_t id) {
  7568. if (is_prohibited_header_name(key)) {
  7569. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  7570. std::string msg = "Prohibited header name '" + key + "' is specified.";
  7571. throw std::invalid_argument(msg);
  7572. #else
  7573. return "";
  7574. #endif
  7575. }
  7576. auto rng = headers.equal_range(key);
  7577. auto it = bounded_next(rng.first, id, rng.second);
  7578. if (it != rng.second) { return it->second.c_str(); }
  7579. return def;
  7580. }
  7581. inline size_t get_header_value_count(const Headers &headers,
  7582. const std::string &key) {
  7583. return headers.count(key);
  7584. }
  7585. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  7586. // list may be sent as several field lines, and the combined field value is
  7587. // those values joined by commas in the order they were received. Callers that
  7588. // parse such a list must work on the combined value; reading only the first
  7589. // occurrence silently drops whatever the later field lines carry.
  7590. inline std::string get_combined_header_value(const Headers &headers,
  7591. const std::string &key) {
  7592. std::string combined;
  7593. auto rng = headers.equal_range(key);
  7594. for (auto it = rng.first; it != rng.second; ++it) {
  7595. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  7596. // elements, so an empty field line must not contribute a bare comma to the
  7597. // combined value.
  7598. if (it->second.empty()) { continue; }
  7599. if (!combined.empty()) { combined += ", "; }
  7600. combined += it->second;
  7601. }
  7602. return combined;
  7603. }
  7604. inline bool has_header_token(const Headers &headers, const std::string &key,
  7605. const std::string &token) {
  7606. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  7607. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  7608. // several lines. Match complete tokens rather than searching the raw value,
  7609. // so that a value such as "notupgrade" is not read as the token "upgrade".
  7610. auto rng = headers.equal_range(key);
  7611. for (auto it = rng.first; it != rng.second; ++it) {
  7612. const auto &value = it->second;
  7613. if (split_find(value.data(), value.data() + value.size(), ',',
  7614. [&](const char *b, const char *e) {
  7615. return case_ignore::equal(std::string(b, e), token);
  7616. })) {
  7617. return true;
  7618. }
  7619. }
  7620. return false;
  7621. }
  7622. template <typename Map>
  7623. inline typename Map::mapped_type
  7624. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  7625. auto rng = m.equal_range(key);
  7626. auto it = bounded_next(rng.first, id, rng.second);
  7627. if (it != rng.second) { return it->second; }
  7628. return typename Map::mapped_type();
  7629. }
  7630. inline void set_header(Headers &headers, const std::string &key,
  7631. const std::string &val) {
  7632. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  7633. }
  7634. // Drops the fields set_header() would refuse, from headers an application can
  7635. // fill directly: CR/LF in one would split the message.
  7636. inline void erase_invalid_fields(Headers &headers) {
  7637. for (auto it = headers.begin(); it != headers.end();) {
  7638. if (fields::is_field_valid(it->first, it->second)) {
  7639. ++it;
  7640. } else {
  7641. it = headers.erase(it);
  7642. }
  7643. }
  7644. }
  7645. inline bool read_headers(Stream &strm, Headers &headers) {
  7646. const auto bufsiz = 2048;
  7647. char buf[bufsiz];
  7648. stream_line_reader line_reader(strm, buf, bufsiz);
  7649. size_t header_count = 0;
  7650. for (;;) {
  7651. if (!line_reader.getline()) { return false; }
  7652. // Check if the line ends with CRLF.
  7653. auto line_terminator_len = 2;
  7654. if (line_reader.end_with_crlf()) {
  7655. // Blank line indicates end of headers.
  7656. if (line_reader.size() == 2) { break; }
  7657. } else {
  7658. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7659. // Blank line indicates end of headers.
  7660. if (line_reader.size() == 1) { break; }
  7661. line_terminator_len = 1;
  7662. #else
  7663. continue; // Skip invalid line.
  7664. #endif
  7665. }
  7666. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7667. // Check header count limit
  7668. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  7669. // Exclude line terminator
  7670. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  7671. if (!parse_header(line_reader.ptr(), end,
  7672. [&](const std::string &key, const std::string &val) {
  7673. headers.emplace(key, val);
  7674. })) {
  7675. return false;
  7676. }
  7677. header_count++;
  7678. }
  7679. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7680. // headers that have different values to prevent request smuggling.
  7681. auto cl_range = headers.equal_range("Content-Length");
  7682. if (cl_range.first != cl_range.second) {
  7683. const auto &first_val = cl_range.first->second;
  7684. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7685. if (it->second != first_val) { return false; }
  7686. }
  7687. }
  7688. return true;
  7689. }
  7690. // Parsed by hand: std::regex_match recurses once per character of the reason
  7691. // phrase, which a server can make as long as a whole line.
  7692. inline bool parse_status_line(const char *line, std::string &version,
  7693. int &status, std::string &reason) {
  7694. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7695. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7696. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7697. !is_ascii_digit(line[11])) {
  7698. return false;
  7699. }
  7700. auto p = line + 12;
  7701. auto reason_begin = p;
  7702. if (*p == ' ') {
  7703. reason_begin = ++p;
  7704. p += std::strcspn(p, "\r\n");
  7705. }
  7706. auto reason_end = p;
  7707. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7708. if (*p == '\r') { p++; }
  7709. #else
  7710. if (*p++ != '\r') { return false; }
  7711. #endif
  7712. if (*p++ != '\n' || *p != '\0') { return false; }
  7713. version.assign(line, 8);
  7714. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7715. reason.assign(reason_begin, reason_end);
  7716. return true;
  7717. }
  7718. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7719. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7720. struct WebSocketUpgradeResponse {
  7721. Error error = Error::Success;
  7722. int status = -1;
  7723. Headers headers;
  7724. std::string selected_subprotocol;
  7725. };
  7726. // Reads a response's status line and headers, leaving any body unread. An
  7727. // unparsable status line is no stream error; it just leaves `status` as is.
  7728. inline bool read_response_head(Stream &strm, int &status, Headers &headers) {
  7729. const auto bufsiz = 2048;
  7730. char buf[bufsiz];
  7731. stream_line_reader line_reader(strm, buf, bufsiz);
  7732. if (!line_reader.getline()) { return false; }
  7733. std::string version;
  7734. std::string reason;
  7735. if (!parse_status_line(line_reader.ptr(), version, status, reason)) {
  7736. return true;
  7737. }
  7738. return read_headers(strm, headers);
  7739. }
  7740. inline bool
  7741. read_websocket_upgrade_response(Stream &strm,
  7742. const std::string &expected_accept,
  7743. const std::string &offered_subprotocols,
  7744. WebSocketUpgradeResponse &upgrade) {
  7745. // The headers of a rejection are kept so the caller can see why the server
  7746. // refused the upgrade.
  7747. if (!read_response_head(strm, upgrade.status, upgrade.headers)) {
  7748. upgrade.error = Error::Read;
  7749. return false;
  7750. }
  7751. const auto &headers = upgrade.headers;
  7752. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7753. upgrade.error = Error::WebSocketHandshake;
  7754. return false;
  7755. }
  7756. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7757. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7758. upgrade.error = Error::WebSocketHandshake;
  7759. return false;
  7760. }
  7761. // Verify Connection: Upgrade
  7762. if (!has_header_token(headers, "Connection", "upgrade")) {
  7763. upgrade.error = Error::WebSocketHandshake;
  7764. return false;
  7765. }
  7766. // Verify Sec-WebSocket-Accept header value
  7767. auto it = headers.find("Sec-WebSocket-Accept");
  7768. if (it == headers.end() || it->second != expected_accept) {
  7769. upgrade.error = Error::WebSocketHandshake;
  7770. return false;
  7771. }
  7772. // Extract negotiated subprotocol
  7773. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7774. if (proto_it != headers.end()) {
  7775. upgrade.selected_subprotocol = proto_it->second;
  7776. }
  7777. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7778. if (!upgrade.selected_subprotocol.empty()) {
  7779. auto was_offered = false;
  7780. split(offered_subprotocols.data(),
  7781. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7782. [&](const char *b, const char *e) {
  7783. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7784. was_offered = true;
  7785. }
  7786. });
  7787. if (!was_offered) {
  7788. upgrade.error = Error::WebSocketHandshake;
  7789. return false;
  7790. }
  7791. }
  7792. return true;
  7793. }
  7794. enum class ReadContentResult {
  7795. Success, // Successfully read the content
  7796. PayloadTooLarge, // The content exceeds the specified payload limit
  7797. Error // An error occurred while reading the content
  7798. };
  7799. inline ReadContentResult read_content_with_length(
  7800. Stream &strm, size_t len, DownloadProgress progress,
  7801. ContentReceiverWithProgress out,
  7802. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7803. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7804. detail::BodyReader br;
  7805. br.stream = &strm;
  7806. br.has_content_length = true;
  7807. br.content_length = len;
  7808. br.payload_max_length = payload_max_length;
  7809. br.chunked = false;
  7810. br.bytes_read = 0;
  7811. br.last_error = Error::Success;
  7812. size_t r = 0;
  7813. while (r < len) {
  7814. auto read_len = static_cast<size_t>(len - r);
  7815. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7816. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7817. if (n <= 0) {
  7818. // Check if it was a payload size error
  7819. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7820. return ReadContentResult::PayloadTooLarge;
  7821. }
  7822. return ReadContentResult::Error;
  7823. }
  7824. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7825. return ReadContentResult::Error;
  7826. }
  7827. r += static_cast<size_t>(n);
  7828. if (progress) {
  7829. if (!progress(r, len)) { return ReadContentResult::Error; }
  7830. }
  7831. }
  7832. return ReadContentResult::Success;
  7833. }
  7834. inline ReadContentResult
  7835. read_content_without_length(Stream &strm, size_t payload_max_length,
  7836. ContentReceiverWithProgress out) {
  7837. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7838. size_t r = 0;
  7839. for (;;) {
  7840. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7841. if (n == 0) { return ReadContentResult::Success; }
  7842. if (n < 0) { return ReadContentResult::Error; }
  7843. // Check if adding this data would exceed the payload limit
  7844. if (payload_max_length > 0 &&
  7845. (r > payload_max_length ||
  7846. payload_max_length - r < static_cast<size_t>(n))) {
  7847. return ReadContentResult::PayloadTooLarge;
  7848. }
  7849. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7850. return ReadContentResult::Error;
  7851. }
  7852. r += static_cast<size_t>(n);
  7853. }
  7854. return ReadContentResult::Success;
  7855. }
  7856. template <typename T>
  7857. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7858. size_t payload_max_length,
  7859. ContentReceiverWithProgress out) {
  7860. detail::ChunkedDecoder dec(strm);
  7861. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7862. size_t total_len = 0;
  7863. for (;;) {
  7864. size_t chunk_offset = 0;
  7865. size_t chunk_total = 0;
  7866. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7867. if (n < 0) { return ReadContentResult::Error; }
  7868. if (n == 0) {
  7869. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7870. return ReadContentResult::Error;
  7871. }
  7872. return ReadContentResult::Success;
  7873. }
  7874. if (payload_max_length > 0 &&
  7875. (total_len > payload_max_length ||
  7876. payload_max_length - total_len < static_cast<size_t>(n))) {
  7877. return ReadContentResult::PayloadTooLarge;
  7878. }
  7879. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7880. return ReadContentResult::Error;
  7881. }
  7882. total_len += static_cast<size_t>(n);
  7883. }
  7884. }
  7885. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7886. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7887. // is the final transfer coding. A single field value may list several
  7888. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7889. // several Transfer-Encoding lines, which combine into one comma-separated
  7890. // list in the order the lines were received. Headers preserves that order,
  7891. // so the final coding is the last token of the last line. Match it
  7892. // case-insensitively rather than comparing the whole value against
  7893. // "chunked".
  7894. //
  7895. // Security: reading a chunked message as unframed leaves its body in the
  7896. // socket, where a keep-alive connection parses it as a smuggled request.
  7897. // Server::process_request() answers 400 and closes when the final coding is
  7898. // not chunked, so a request whose framing cannot be determined never
  7899. // reaches the "no body" path.
  7900. auto rng = headers.equal_range("Transfer-Encoding");
  7901. if (rng.first == rng.second) { return false; }
  7902. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7903. // combined list ending in nothing rather than inheriting the line before it.
  7904. std::string last_coding;
  7905. for (auto it = rng.first; it != rng.second; ++it) {
  7906. const auto &value = it->second;
  7907. last_coding.clear();
  7908. split(value.data(), value.data() + value.size(), ',',
  7909. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7910. }
  7911. return case_ignore::equal(last_coding, "chunked");
  7912. }
  7913. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7914. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7915. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7916. return msg.has_header("Transfer-Encoding") &&
  7917. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7918. }
  7919. inline bool has_conflicting_content_length(const Headers &headers) {
  7920. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7921. // Content-Length is framed ambiguously. The body readers here delimit it by
  7922. // the transfer coding and drop Content-Length, while an intermediary may do
  7923. // the reverse, so the two disagree on where the body ends and a reused
  7924. // connection is desynchronised (request/response smuggling). Content-Length:
  7925. // 0 is tolerated for compatibility with existing peers.
  7926. return has_header(headers, "Transfer-Encoding") &&
  7927. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7928. }
  7929. template <typename T, typename U>
  7930. bool prepare_content_receiver(T &x, int &status,
  7931. ContentReceiverWithProgress receiver,
  7932. bool decompress, size_t payload_max_length,
  7933. bool &exceed_payload_max_length, U callback) {
  7934. if (decompress) {
  7935. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7936. std::unique_ptr<decompressor> decompressor;
  7937. if (!encoding.empty()) {
  7938. // A coding we know about but were not built with is an error. An
  7939. // unrecognized coding (including "identity") is left alone and the
  7940. // payload is passed through as-is, since some servers misuse the header,
  7941. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7942. decompressor = detail::create_decompressor(encoding);
  7943. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7944. status = StatusCode::UnsupportedMediaType_415;
  7945. return false;
  7946. }
  7947. }
  7948. if (decompressor) {
  7949. if (decompressor->is_valid()) {
  7950. size_t decompressed_size = 0;
  7951. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7952. size_t off, size_t len) {
  7953. return decompressor->decompress(
  7954. buf, n, [&](const char *buf2, size_t n2) {
  7955. // Guard against zip-bomb: check
  7956. // decompressed size against limit.
  7957. if (payload_max_length > 0 &&
  7958. (decompressed_size >= payload_max_length ||
  7959. n2 > payload_max_length - decompressed_size)) {
  7960. exceed_payload_max_length = true;
  7961. return false;
  7962. }
  7963. decompressed_size += n2;
  7964. return receiver(buf2, n2, off, len);
  7965. });
  7966. };
  7967. return callback(std::move(out));
  7968. } else {
  7969. status = StatusCode::InternalServerError_500;
  7970. return false;
  7971. }
  7972. }
  7973. }
  7974. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7975. size_t len) {
  7976. return receiver(buf, n, off, len);
  7977. };
  7978. return callback(std::move(out));
  7979. }
  7980. template <typename T>
  7981. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7982. DownloadProgress progress,
  7983. ContentReceiverWithProgress receiver, bool decompress) {
  7984. bool exceed_payload_max_length = false;
  7985. return prepare_content_receiver(
  7986. x, status, std::move(receiver), decompress, payload_max_length,
  7987. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7988. auto ret = true;
  7989. // Note: exceed_payload_max_length may also be set by the decompressor
  7990. // wrapper in prepare_content_receiver when the decompressed payload
  7991. // size exceeds the limit.
  7992. if (is_chunked_transfer_encoding(x.headers)) {
  7993. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7994. if (result == ReadContentResult::Success) {
  7995. ret = true;
  7996. } else if (result == ReadContentResult::PayloadTooLarge) {
  7997. exceed_payload_max_length = true;
  7998. ret = false;
  7999. } else {
  8000. ret = false;
  8001. }
  8002. } else if (!has_header(x.headers, "Content-Length")) {
  8003. auto result =
  8004. read_content_without_length(strm, payload_max_length, out);
  8005. if (result == ReadContentResult::Success) {
  8006. ret = true;
  8007. } else if (result == ReadContentResult::PayloadTooLarge) {
  8008. exceed_payload_max_length = true;
  8009. ret = false;
  8010. } else {
  8011. ret = false;
  8012. }
  8013. } else {
  8014. auto is_invalid_value = false;
  8015. auto len = get_header_value_u64(x.headers, "Content-Length",
  8016. (std::numeric_limits<size_t>::max)(),
  8017. 0, is_invalid_value);
  8018. if (is_invalid_value) {
  8019. ret = false;
  8020. } else if (len > 0) {
  8021. auto result = read_content_with_length(
  8022. strm, len, std::move(progress), out, payload_max_length);
  8023. ret = (result == ReadContentResult::Success);
  8024. if (result == ReadContentResult::PayloadTooLarge) {
  8025. exceed_payload_max_length = true;
  8026. }
  8027. }
  8028. }
  8029. if (!ret) {
  8030. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  8031. : StatusCode::BadRequest_400;
  8032. }
  8033. return ret;
  8034. });
  8035. }
  8036. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  8037. const std::string &path) {
  8038. // Neither the method nor the request target may carry CR/LF, SP or other
  8039. // control octets; otherwise a value smuggled into either splits the request
  8040. // line and injects headers or a whole request.
  8041. if (!fields::is_token(method)) { return -1; }
  8042. if (!fields::is_request_target(path)) { return -1; }
  8043. std::string s = method;
  8044. s += ' ';
  8045. s += path;
  8046. s += " HTTP/1.1\r\n";
  8047. return strm.write(s.data(), s.size());
  8048. }
  8049. inline ssize_t write_response_line(Stream &strm, int status) {
  8050. std::string s = "HTTP/1.1 ";
  8051. s += std::to_string(status);
  8052. s += ' ';
  8053. s += httplib::status_message(status);
  8054. s += "\r\n";
  8055. return strm.write(s.data(), s.size());
  8056. }
  8057. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  8058. ssize_t write_len = 0;
  8059. for (const auto &x : headers) {
  8060. std::string s;
  8061. s = x.first;
  8062. s += ": ";
  8063. s += x.second;
  8064. s += "\r\n";
  8065. auto len = strm.write(s.data(), s.size());
  8066. if (len < 0) { return len; }
  8067. write_len += len;
  8068. }
  8069. auto len = strm.write("\r\n");
  8070. if (len < 0) { return len; }
  8071. write_len += len;
  8072. return write_len;
  8073. }
  8074. inline bool write_data(Stream &strm, const char *d, size_t l) {
  8075. size_t offset = 0;
  8076. while (offset < l) {
  8077. auto length = strm.write(d + offset, l - offset);
  8078. if (length < 0) { return false; }
  8079. offset += static_cast<size_t>(length);
  8080. }
  8081. return true;
  8082. }
  8083. template <typename T>
  8084. inline bool write_content_with_progress(Stream &strm,
  8085. const ContentProvider &content_provider,
  8086. size_t offset, size_t length,
  8087. T is_shutting_down,
  8088. const UploadProgress &upload_progress,
  8089. Error &error) {
  8090. size_t end_offset = offset + length;
  8091. size_t start_offset = offset;
  8092. auto ok = true;
  8093. auto finished = false;
  8094. DataSink data_sink;
  8095. data_sink.write = [&](const char *d, size_t l) -> bool {
  8096. if (ok) {
  8097. // Bytes past `length` would follow the framed body, where the peer reads
  8098. // them as the next message. Write only what fits and fail the rest.
  8099. if (l > end_offset - offset) {
  8100. l = end_offset - offset;
  8101. ok = false;
  8102. }
  8103. if (write_data(strm, d, l)) {
  8104. offset += l;
  8105. if (upload_progress && length > 0) {
  8106. size_t current_written = offset - start_offset;
  8107. if (!upload_progress(current_written, length)) {
  8108. ok = false;
  8109. return false;
  8110. }
  8111. }
  8112. } else {
  8113. ok = false;
  8114. }
  8115. }
  8116. return ok;
  8117. };
  8118. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  8119. // The body is framed by `length`, so a provider that reports itself done
  8120. // early has truncated it. Record that and let the short-body check below
  8121. // fail the write, rather than calling the provider again forever.
  8122. data_sink.done = [&]() { finished = true; };
  8123. while (offset < end_offset && !finished && !is_shutting_down()) {
  8124. auto last_offset = offset;
  8125. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  8126. error = Error::Write;
  8127. return false;
  8128. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  8129. error = Error::Canceled;
  8130. return false;
  8131. } else if (!ok) {
  8132. error = Error::Write;
  8133. return false;
  8134. }
  8135. // A provider that reports success without writing anything and without
  8136. // reporting itself done gets handed the same offset and length again on
  8137. // the next pass, so it would spin here for as long as the peer stays
  8138. // connected. Treat making no progress as a short body, like done() early.
  8139. if (!finished && offset == last_offset) {
  8140. error = Error::Write;
  8141. return false;
  8142. }
  8143. }
  8144. if (offset < end_offset) { // done() called early, or is_shutting_down()
  8145. error = Error::Write;
  8146. return false;
  8147. }
  8148. error = Error::Success;
  8149. return true;
  8150. }
  8151. template <typename T>
  8152. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  8153. size_t offset, size_t length, T is_shutting_down,
  8154. Error &error) {
  8155. return write_content_with_progress<T>(strm, content_provider, offset, length,
  8156. is_shutting_down, nullptr, error);
  8157. }
  8158. template <typename T>
  8159. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  8160. size_t offset, size_t length,
  8161. const T &is_shutting_down) {
  8162. auto error = Error::Success;
  8163. return write_content(strm, content_provider, offset, length, is_shutting_down,
  8164. error);
  8165. }
  8166. template <typename T>
  8167. inline bool
  8168. write_content_without_length(Stream &strm,
  8169. const ContentProvider &content_provider,
  8170. const T &is_shutting_down) {
  8171. size_t offset = 0;
  8172. auto data_available = true;
  8173. auto ok = true;
  8174. DataSink data_sink;
  8175. data_sink.write = [&](const char *d, size_t l) -> bool {
  8176. if (ok) {
  8177. offset += l;
  8178. if (!write_data(strm, d, l)) { ok = false; }
  8179. }
  8180. return ok;
  8181. };
  8182. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  8183. data_sink.done = [&](void) { data_available = false; };
  8184. while (data_available && !is_shutting_down()) {
  8185. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  8186. return false;
  8187. } else if (!content_provider(offset, 0, data_sink)) {
  8188. return false;
  8189. } else if (!ok) {
  8190. return false;
  8191. }
  8192. }
  8193. return !data_available; // true only if done() was called, false if shutting
  8194. // down
  8195. }
  8196. // Runs a known-length content provider to completion and compresses what it
  8197. // writes into `out`, chunk by chunk, without holding the identity form.
  8198. inline bool compress_content_provider(const ContentProvider &content_provider,
  8199. size_t length, compressor &cmp,
  8200. std::string &out) {
  8201. size_t offset = 0;
  8202. auto ok = true;
  8203. auto finished = false;
  8204. DataSink data_sink;
  8205. auto append = [&](const char *data, size_t data_len) {
  8206. out.append(data, data_len);
  8207. return true;
  8208. };
  8209. data_sink.write = [&](const char *d, size_t l) -> bool {
  8210. if (!ok) { return false; }
  8211. offset += l;
  8212. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  8213. return ok;
  8214. };
  8215. // The body is framed by `length`, so a provider that reports itself done
  8216. // early has truncated it; the short-body check below turns that into a
  8217. // failure rather than calling the provider again forever.
  8218. data_sink.done = [&]() { finished = true; };
  8219. while (offset < length && !finished) {
  8220. auto prev_offset = offset;
  8221. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  8222. return false;
  8223. }
  8224. // No Stream to block on here, so a provider that keeps returning true
  8225. // without writing would spin. Treat a pass that made no progress as a
  8226. // failure.
  8227. if (offset == prev_offset) { return false; }
  8228. }
  8229. if (offset != length) { return false; }
  8230. return cmp.compress(nullptr, 0, true, append);
  8231. }
  8232. // Serves `m` as the response body. `set_content_provider()` clears the coding
  8233. // and the file flag, so recording them has to come after; keeping all of it
  8234. // here means a third file-serving path cannot get that order wrong.
  8235. inline void set_file_content_provider(Response &res,
  8236. const std::shared_ptr<mmap> &m,
  8237. const std::string &content_type,
  8238. EncodingType encoding) {
  8239. // One read and one write move up to this much of the file at a time.
  8240. auto buf = std::make_shared<std::vector<char>>(
  8241. (std::min)(m->size(), size_t(256 * 1024)));
  8242. res.set_content_provider(
  8243. m->size(), content_type,
  8244. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  8245. // Never read past the file, which ends the response early if it has
  8246. // shrunk since it was opened.
  8247. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  8248. if (n == 0) { return false; }
  8249. sink.write(buf->data(), n);
  8250. return true;
  8251. });
  8252. res.is_file_content_provider_ = true;
  8253. res.content_coding_ = encoding;
  8254. }
  8255. template <typename T, typename U>
  8256. inline bool
  8257. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  8258. const T &is_shutting_down, U &compressor, Error &error) {
  8259. size_t offset = 0;
  8260. auto data_available = true;
  8261. auto ok = true;
  8262. DataSink data_sink;
  8263. data_sink.write = [&](const char *d, size_t l) -> bool {
  8264. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  8265. // to hand over is ordinary (an empty buffer popped off a queue), and a
  8266. // zero-length chunk is the terminator, so it must not be emitted here.
  8267. if (ok && l > 0) {
  8268. offset += l;
  8269. std::string payload;
  8270. if (compressor.compress(d, l, false,
  8271. [&](const char *data, size_t data_len) {
  8272. payload.append(data, data_len);
  8273. return true;
  8274. })) {
  8275. if (!payload.empty()) {
  8276. // Emit chunked response header and footer for each chunk
  8277. auto chunk =
  8278. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  8279. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  8280. }
  8281. } else {
  8282. ok = false;
  8283. }
  8284. }
  8285. return ok;
  8286. };
  8287. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  8288. auto done_with_trailer = [&](const Headers *trailer) {
  8289. if (!ok) { return; }
  8290. data_available = false;
  8291. std::string payload;
  8292. if (!compressor.compress(nullptr, 0, true,
  8293. [&](const char *data, size_t data_len) {
  8294. payload.append(data, data_len);
  8295. return true;
  8296. })) {
  8297. ok = false;
  8298. return;
  8299. }
  8300. if (!payload.empty()) {
  8301. // Emit chunked response header and footer for each chunk
  8302. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  8303. if (!write_data(strm, chunk.data(), chunk.size())) {
  8304. ok = false;
  8305. return;
  8306. }
  8307. }
  8308. constexpr const char done_marker[] = "0\r\n";
  8309. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  8310. // Trailer
  8311. if (trailer) {
  8312. for (const auto &kv : *trailer) {
  8313. // Skip fields with invalid names or values to prevent response
  8314. // splitting via CR/LF injection, matching set_header().
  8315. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  8316. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  8317. if (!write_data(strm, field_line.data(), field_line.size())) {
  8318. ok = false;
  8319. }
  8320. }
  8321. }
  8322. constexpr const char crlf[] = "\r\n";
  8323. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  8324. };
  8325. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  8326. data_sink.done_with_trailer = [&](const Headers &trailer) {
  8327. done_with_trailer(&trailer);
  8328. };
  8329. while (data_available && !is_shutting_down()) {
  8330. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  8331. error = Error::Write;
  8332. return false;
  8333. } else if (!content_provider(offset, 0, data_sink)) {
  8334. error = Error::Canceled;
  8335. return false;
  8336. } else if (!ok) {
  8337. error = Error::Write;
  8338. return false;
  8339. }
  8340. }
  8341. if (data_available) { // exited due to is_shutting_down(), not done()
  8342. error = Error::Write;
  8343. return false;
  8344. }
  8345. error = Error::Success;
  8346. return true;
  8347. }
  8348. template <typename T, typename U>
  8349. inline bool write_content_chunked(Stream &strm,
  8350. const ContentProvider &content_provider,
  8351. const T &is_shutting_down, U &compressor) {
  8352. auto error = Error::Success;
  8353. return write_content_chunked(strm, content_provider, is_shutting_down,
  8354. compressor, error);
  8355. }
  8356. template <typename T>
  8357. inline bool redirect(T &cli, Request &req, Response &res,
  8358. const std::string &path, const std::string &location,
  8359. Error &error) {
  8360. Request new_req = req;
  8361. new_req.path = path;
  8362. new_req.params.clear();
  8363. new_req.redirect_count_ -= 1;
  8364. if (res.status == StatusCode::SeeOther_303 &&
  8365. (req.method != "GET" && req.method != "HEAD")) {
  8366. new_req.method = "GET";
  8367. new_req.body.clear();
  8368. new_req.headers.clear();
  8369. new_req.content_length_ = 0;
  8370. new_req.content_provider_ = nullptr;
  8371. new_req.is_chunked_content_provider_ = false;
  8372. }
  8373. Response new_res;
  8374. auto ret = cli.send(new_req, new_res, error);
  8375. if (ret) {
  8376. req = std::move(new_req);
  8377. res = std::move(new_res);
  8378. if (res.location.empty()) { res.location = location; }
  8379. }
  8380. return ret;
  8381. }
  8382. inline std::string params_to_query_str(const Params &params) {
  8383. std::string query;
  8384. for (auto it = params.begin(); it != params.end(); ++it) {
  8385. if (it != params.begin()) { query += '&'; }
  8386. query += encode_query_component(it->first);
  8387. query += '=';
  8388. query += encode_query_component(it->second);
  8389. }
  8390. return query;
  8391. }
  8392. // Splits one "key=value" span of a query string at its first '='. A span with
  8393. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  8394. // "?flag" keeps its name.
  8395. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  8396. std::string &val) {
  8397. divide(b, static_cast<std::size_t>(e - b), '=',
  8398. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  8399. std::size_t rhs_size) {
  8400. key.assign(lhs_data, lhs_size);
  8401. val.assign(rhs_data, rhs_size);
  8402. });
  8403. }
  8404. inline void parse_query_text(const char *data, std::size_t size,
  8405. Params &params) {
  8406. std::set<std::string> cache;
  8407. split(data, data + size, '&', [&](const char *b, const char *e) {
  8408. std::string kv(b, e);
  8409. if (cache.find(kv) != cache.end()) { return; }
  8410. cache.insert(std::move(kv));
  8411. std::string key;
  8412. std::string val;
  8413. divide_query_pair(b, e, key, val);
  8414. if (!key.empty()) {
  8415. params.emplace(decode_query_component(key), decode_query_component(val));
  8416. }
  8417. });
  8418. }
  8419. inline void parse_query_text(const std::string &s, Params &params) {
  8420. parse_query_text(s.data(), s.size(), params);
  8421. }
  8422. // Normalize a query string by decoding and re-encoding each key/value pair
  8423. // while preserving the original parameter order. This avoids double-encoding
  8424. // and ensures consistent encoding. It works on the raw string rather than
  8425. // parsing into Params and re-serializing, because that round trip cannot
  8426. // reproduce the input: params_to_query_str() always emits '=', so a bare
  8427. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  8428. // duplicated pairs.
  8429. inline std::string normalize_query_string(const std::string &query) {
  8430. std::string result;
  8431. split(query.data(), query.data() + query.size(), '&',
  8432. [&](const char *b, const char *e) {
  8433. std::string key;
  8434. std::string val;
  8435. divide_query_pair(b, e, key, val);
  8436. if (!key.empty()) {
  8437. auto dec_key = decode_query_component(key);
  8438. auto dec_val = decode_query_component(val);
  8439. if (!result.empty()) { result += '&'; }
  8440. result += encode_query_component(dec_key);
  8441. if (!val.empty() || std::find(b, e, '=') != e) {
  8442. result += '=';
  8443. result += encode_query_component(dec_val);
  8444. }
  8445. }
  8446. });
  8447. return result;
  8448. }
  8449. // The query of a client's path: what follows '?', up to the fragment.
  8450. inline std::string query_of(const std::string &path) {
  8451. auto fragment_pos = path.find('#');
  8452. auto query_pos = path.find('?');
  8453. return query_pos < fragment_pos
  8454. ? path.substr(query_pos + 1, fragment_pos - query_pos - 1)
  8455. : std::string();
  8456. }
  8457. // Build the request target that goes on the wire from a caller-supplied path.
  8458. // Shared by the buffered send path and the streaming API so that both put the
  8459. // same bytes in the request line for the same input.
  8460. inline std::string encode_request_target(const std::string &uri,
  8461. bool path_encode) {
  8462. // The fragment stays with the client (RFC 9110 §7.1).
  8463. auto target = uri.substr(0, uri.find('#'));
  8464. // `substr(0, npos)` yields the whole string, which is what the no-query
  8465. // case needs.
  8466. auto query_pos = target.find('?');
  8467. auto path_part = target.substr(0, query_pos);
  8468. std::string query_part;
  8469. if (query_pos != std::string::npos) {
  8470. query_part = target.substr(query_pos + 1);
  8471. }
  8472. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  8473. if (!query_part.empty()) {
  8474. // When path encoding is disabled the caller has supplied an already-encoded
  8475. // target and expects the exact bytes to be sent on the wire, so skip
  8476. // normalization for the query too. Normalizing would decode-then-re-encode
  8477. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  8478. // which a strict RFC 3986 server decodes back as `+`, not a space).
  8479. if (path_encode) {
  8480. auto normalized = normalize_query_string(query_part);
  8481. if (!normalized.empty()) {
  8482. result += '?';
  8483. result += normalized;
  8484. }
  8485. } else {
  8486. result += '?';
  8487. result += query_part;
  8488. }
  8489. }
  8490. return result;
  8491. }
  8492. inline bool parse_multipart_boundary(const std::string &content_type,
  8493. std::string &boundary) {
  8494. std::map<std::string, std::string> params;
  8495. extract_media_type(content_type, &params);
  8496. auto it = params.find("boundary");
  8497. if (it == params.end()) { return false; }
  8498. boundary = it->second;
  8499. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  8500. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  8501. // bytes costs a nearly full comparison at nearly every position: the
  8502. // boundary's length multiplies the worst-case cost of scanning a body.
  8503. return !boundary.empty() && boundary.size() <= 70;
  8504. }
  8505. inline void parse_disposition_params(const std::string &s, Params &params) {
  8506. std::set<std::string> cache;
  8507. split_unquoted(
  8508. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  8509. std::string kv(b, e);
  8510. if (cache.find(kv) != cache.end()) { return; }
  8511. cache.insert(kv);
  8512. std::string key;
  8513. std::string val;
  8514. divide_param_pair(b, e, key, val);
  8515. if (!key.empty()) {
  8516. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  8517. }
  8518. });
  8519. }
  8520. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8521. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  8522. #else
  8523. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  8524. #endif
  8525. auto is_valid = [](const std::string &str) {
  8526. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  8527. };
  8528. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  8529. const auto pos = static_cast<size_t>(6);
  8530. const auto len = static_cast<size_t>(s.size() - 6);
  8531. auto all_valid_ranges = true;
  8532. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  8533. if (!all_valid_ranges) { return; }
  8534. const auto it = std::find(b, e, '-');
  8535. if (it == e) {
  8536. all_valid_ranges = false;
  8537. return;
  8538. }
  8539. const auto lhs = std::string(b, it);
  8540. const auto rhs = std::string(it + 1, e);
  8541. if (!is_valid(lhs) || !is_valid(rhs)) {
  8542. all_valid_ranges = false;
  8543. return;
  8544. }
  8545. ssize_t first = -1;
  8546. if (!lhs.empty()) {
  8547. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  8548. // would turn the range into a suffix range.
  8549. auto res =
  8550. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  8551. if (res.ec != std::errc{}) {
  8552. all_valid_ranges = false;
  8553. return;
  8554. }
  8555. }
  8556. ssize_t last = -1;
  8557. if (!rhs.empty()) {
  8558. // An overflowing last-byte-pos is past any content length, so keeping
  8559. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  8560. ssize_t v;
  8561. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  8562. if (res.ec == std::errc{}) { last = v; }
  8563. }
  8564. if ((first == -1 && last == -1) ||
  8565. (first != -1 && last != -1 && first > last)) {
  8566. all_valid_ranges = false;
  8567. return;
  8568. }
  8569. ranges.emplace_back(first, last);
  8570. });
  8571. return all_valid_ranges && !ranges.empty();
  8572. }
  8573. return false;
  8574. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8575. }
  8576. #else
  8577. } catch (...) { return false; }
  8578. #endif
  8579. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  8580. inline std::string remove_quoted_strings(const std::string &s) {
  8581. std::string out;
  8582. auto in_quotes = false;
  8583. for (size_t i = 0; i < s.size(); i++) {
  8584. if (s[i] == '"') {
  8585. in_quotes = !in_quotes;
  8586. } else if (!in_quotes) {
  8587. out += s[i];
  8588. } else if (s[i] == '\\') {
  8589. i++;
  8590. }
  8591. }
  8592. return out;
  8593. }
  8594. inline bool parse_accept_header(const std::string &s,
  8595. std::vector<std::string> &content_types) {
  8596. // Parameter values are not used here, so a quoted-string is dropped rather
  8597. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  8598. if (s.find('"') != std::string::npos) {
  8599. return parse_accept_header(remove_quoted_strings(s), content_types);
  8600. }
  8601. content_types.clear();
  8602. // Empty string is considered valid (no preference)
  8603. if (s.empty()) { return true; }
  8604. struct AcceptEntry {
  8605. std::string media_type;
  8606. double quality;
  8607. int order;
  8608. };
  8609. std::vector<AcceptEntry> entries;
  8610. int order = 0;
  8611. bool has_invalid_entry = false;
  8612. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  8613. // has to parse and ignore empty list elements, so a leading, trailing or
  8614. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  8615. // split() skips them, and the header length limit bounds how many a sender
  8616. // can send, so ignoring all of them cannot be used as a denial-of-service
  8617. // vector.
  8618. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  8619. std::string entry(b, e);
  8620. entry = trim_copy(entry);
  8621. AcceptEntry accept_entry;
  8622. accept_entry.order = order++;
  8623. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  8624. accept_entry.media_type, accept_entry.quality)) {
  8625. has_invalid_entry = true;
  8626. return;
  8627. }
  8628. // Remove additional parameters from media type
  8629. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  8630. // Basic validation of media type format
  8631. if (accept_entry.media_type.empty()) {
  8632. has_invalid_entry = true;
  8633. return;
  8634. }
  8635. // Check for basic media type format (should contain '/' or be '*')
  8636. if (accept_entry.media_type != "*" &&
  8637. accept_entry.media_type.find('/') == std::string::npos) {
  8638. has_invalid_entry = true;
  8639. return;
  8640. }
  8641. entries.push_back(std::move(accept_entry));
  8642. });
  8643. // Return false if any invalid entry was found
  8644. if (has_invalid_entry) { return false; }
  8645. // Sort by quality (descending), then by original order (ascending)
  8646. std::sort(entries.begin(), entries.end(),
  8647. [](const AcceptEntry &a, const AcceptEntry &b) {
  8648. if (a.quality != b.quality) {
  8649. return a.quality > b.quality; // Higher quality first
  8650. }
  8651. return a.order < b.order; // Earlier order first for same quality
  8652. });
  8653. // Extract sorted media types
  8654. content_types.reserve(entries.size());
  8655. for (auto &entry : entries) {
  8656. content_types.push_back(std::move(entry.media_type));
  8657. }
  8658. return true;
  8659. }
  8660. class FormDataParser {
  8661. public:
  8662. FormDataParser() = default;
  8663. void set_boundary(std::string &&boundary) {
  8664. boundary_ = std::move(boundary);
  8665. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8666. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8667. }
  8668. bool is_valid() const { return is_valid_; }
  8669. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8670. const ContentReceiver &content_callback) {
  8671. // Once the close delimiter has been seen the rest of the body is epilogue
  8672. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8673. // spread across reads is not copied in only to be erased right away.
  8674. if (state_ == 5) { return true; }
  8675. buf_append(buf, n);
  8676. while (buf_size() > 0) {
  8677. switch (state_) {
  8678. case 0: { // Initial boundary
  8679. auto pos = buf_find(dash_boundary_crlf_);
  8680. if (pos == buf_size()) {
  8681. // Not found yet: keep only a possible partial boundary at the tail so
  8682. // that a body which never contains the boundary cannot grow the
  8683. // buffer (and get rescanned from the start) without bound.
  8684. auto keep = dash_boundary_crlf_.size() - 1;
  8685. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8686. return true;
  8687. }
  8688. buf_erase(pos + dash_boundary_crlf_.size());
  8689. state_ = 1;
  8690. break;
  8691. }
  8692. case 1: { // New entry
  8693. clear_file_info();
  8694. header_searched_ = 0;
  8695. state_ = 2;
  8696. break;
  8697. }
  8698. case 2: { // Headers
  8699. // Resume where the last call stopped looking, so that a line arriving
  8700. // a few bytes at a time is not searched from its start each time.
  8701. auto pos = buf_find(crlf_, header_searched_);
  8702. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8703. while (pos < buf_size()) {
  8704. // Empty line
  8705. if (pos == 0) {
  8706. if (!header_callback(file_)) {
  8707. is_valid_ = false;
  8708. return false;
  8709. }
  8710. buf_erase(crlf_.size());
  8711. state_ = 3;
  8712. break;
  8713. }
  8714. // Check header count limit
  8715. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8716. is_valid_ = false;
  8717. return false;
  8718. }
  8719. header_count_++;
  8720. const auto header = buf_head(pos);
  8721. if (!parse_header(header.data(), header.data() + header.size(),
  8722. [&](const std::string &, const std::string &) {})) {
  8723. is_valid_ = false;
  8724. return false;
  8725. }
  8726. // Parse and emplace space trimmed headers into a map
  8727. if (!parse_header(
  8728. header.data(), header.data() + header.size(),
  8729. [&](const std::string &key, const std::string &val) {
  8730. file_.headers.emplace(key, val);
  8731. })) {
  8732. is_valid_ = false;
  8733. return false;
  8734. }
  8735. constexpr const char header_content_type[] = "Content-Type:";
  8736. if (start_with_case_ignore(header, header_content_type)) {
  8737. file_.content_type =
  8738. trim_copy(header.substr(str_len(header_content_type)));
  8739. } else {
  8740. std::string disposition_params;
  8741. if (parse_content_disposition(header, disposition_params)) {
  8742. Params params;
  8743. parse_disposition_params(disposition_params, params);
  8744. auto it = params.find("name");
  8745. if (it != params.end()) {
  8746. file_.name = it->second;
  8747. } else {
  8748. is_valid_ = false;
  8749. return false;
  8750. }
  8751. it = params.find("filename");
  8752. if (it != params.end()) { file_.filename = it->second; }
  8753. it = params.find("filename*");
  8754. if (it != params.end()) {
  8755. // RFC 5987: only UTF-8 encoding is allowed
  8756. const auto &val = it->second;
  8757. constexpr const char utf8_prefix[] = "UTF-8''";
  8758. constexpr size_t prefix_len = str_len(utf8_prefix);
  8759. if (val.size() > prefix_len &&
  8760. start_with_case_ignore(val, utf8_prefix)) {
  8761. file_.filename = decode_path_component(
  8762. val.substr(prefix_len)); // override...
  8763. } else {
  8764. is_valid_ = false;
  8765. return false;
  8766. }
  8767. }
  8768. }
  8769. }
  8770. buf_erase(pos + crlf_.size());
  8771. pos = buf_find(crlf_);
  8772. }
  8773. if (state_ != 3) {
  8774. // The CR of the CRLF may be the last byte so far.
  8775. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8776. return true;
  8777. }
  8778. break;
  8779. }
  8780. case 3: { // Body
  8781. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8782. auto pos = buf_find(crlf_dash_boundary_);
  8783. if (pos < buf_size()) {
  8784. if (!content_callback(buf_data(), pos)) {
  8785. is_valid_ = false;
  8786. return false;
  8787. }
  8788. buf_erase(pos + crlf_dash_boundary_.size());
  8789. state_ = 4;
  8790. } else {
  8791. auto len = buf_size() - crlf_dash_boundary_.size();
  8792. if (len > 0) {
  8793. if (!content_callback(buf_data(), len)) {
  8794. is_valid_ = false;
  8795. return false;
  8796. }
  8797. buf_erase(len);
  8798. }
  8799. return true;
  8800. }
  8801. break;
  8802. }
  8803. case 4: { // Boundary
  8804. if (crlf_.size() > buf_size()) { return true; }
  8805. if (buf_start_with(crlf_)) {
  8806. buf_erase(crlf_.size());
  8807. state_ = 1;
  8808. } else if (buf_start_with(dash_)) {
  8809. buf_erase(dash_.size());
  8810. is_valid_ = true;
  8811. state_ = 5;
  8812. } else {
  8813. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8814. // accepted after a boundary; RFC 2046 allows transport-padding in
  8815. // between, but this parser has never supported it. Either way the
  8816. // body is already destined to be rejected, so fail now instead of
  8817. // buffering the rest of it. Both are two bytes, so the check above
  8818. // already guarantees enough buffered data to decide.
  8819. is_valid_ = false;
  8820. return false;
  8821. }
  8822. break;
  8823. }
  8824. case 5: { // Epilogue
  8825. buf_erase(buf_size());
  8826. break;
  8827. }
  8828. }
  8829. }
  8830. return true;
  8831. }
  8832. private:
  8833. void clear_file_info() {
  8834. file_.name.clear();
  8835. file_.filename.clear();
  8836. file_.content_type.clear();
  8837. file_.headers.clear();
  8838. header_count_ = 0;
  8839. }
  8840. bool start_with_case_ignore(const std::string &a, const char *b,
  8841. size_t offset = 0) const {
  8842. const auto b_len = strlen(b);
  8843. if (a.size() < offset + b_len) { return false; }
  8844. for (size_t i = 0; i < b_len; i++) {
  8845. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8846. return false;
  8847. }
  8848. }
  8849. return true;
  8850. }
  8851. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8852. // Returns true if header matches, with the params portion in `params_out`.
  8853. bool parse_content_disposition(const std::string &header,
  8854. std::string &params_out) const {
  8855. constexpr const char prefix[] = "Content-Disposition:";
  8856. constexpr size_t prefix_len = str_len(prefix);
  8857. if (!start_with_case_ignore(header, prefix)) { return false; }
  8858. // Skip whitespace after "Content-Disposition:"
  8859. auto pos = prefix_len;
  8860. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8861. pos++;
  8862. }
  8863. // Match "form-data;" (case-insensitive)
  8864. constexpr const char form_data[] = "form-data;";
  8865. constexpr size_t form_data_len = str_len(form_data);
  8866. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8867. pos += form_data_len;
  8868. // Skip whitespace after "form-data;"
  8869. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8870. pos++;
  8871. }
  8872. params_out = header.substr(pos);
  8873. return true;
  8874. }
  8875. const std::string dash_ = "--";
  8876. const std::string crlf_ = "\r\n";
  8877. std::string boundary_;
  8878. std::string dash_boundary_crlf_;
  8879. std::string crlf_dash_boundary_;
  8880. size_t state_ = 0;
  8881. bool is_valid_ = false;
  8882. FormData file_;
  8883. size_t header_count_ = 0;
  8884. size_t header_searched_ = 0;
  8885. // Buffer
  8886. bool start_with(const std::string &a, size_t spos, size_t epos,
  8887. const std::string &b) const {
  8888. if (epos - spos < b.size()) { return false; }
  8889. for (size_t i = 0; i < b.size(); i++) {
  8890. if (a[i + spos] != b[i]) { return false; }
  8891. }
  8892. return true;
  8893. }
  8894. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8895. const char *buf_data() const { return &buf_[buf_spos_]; }
  8896. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8897. bool buf_start_with(const std::string &s) const {
  8898. return start_with(buf_, buf_spos_, buf_epos_, s);
  8899. }
  8900. size_t buf_find(const std::string &s, size_t from = 0) const {
  8901. auto c = s.front();
  8902. size_t off = buf_spos_ + from;
  8903. while (off < buf_epos_) {
  8904. auto pos = off;
  8905. while (true) {
  8906. if (pos == buf_epos_) { return buf_size(); }
  8907. if (buf_[pos] == c) { break; }
  8908. pos++;
  8909. }
  8910. auto remaining_size = buf_epos_ - pos;
  8911. if (s.size() > remaining_size) { return buf_size(); }
  8912. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8913. off = pos + 1;
  8914. }
  8915. return buf_size();
  8916. }
  8917. void buf_append(const char *data, size_t n) {
  8918. auto remaining_size = buf_size();
  8919. if (remaining_size > 0 && buf_spos_ > 0) {
  8920. for (size_t i = 0; i < remaining_size; i++) {
  8921. buf_[i] = buf_[buf_spos_ + i];
  8922. }
  8923. }
  8924. buf_spos_ = 0;
  8925. buf_epos_ = remaining_size;
  8926. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8927. for (size_t i = 0; i < n; i++) {
  8928. buf_[buf_epos_ + i] = data[i];
  8929. }
  8930. buf_epos_ += n;
  8931. }
  8932. void buf_erase(size_t size) { buf_spos_ += size; }
  8933. std::string buf_;
  8934. size_t buf_spos_ = 0;
  8935. size_t buf_epos_ = 0;
  8936. };
  8937. inline std::string random_string(size_t length) {
  8938. constexpr const char data[] =
  8939. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8940. std::string result(length, '\0');
  8941. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8942. for (auto &c : result) {
  8943. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8944. }
  8945. return result;
  8946. }
  8947. inline std::string make_multipart_data_boundary() {
  8948. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8949. }
  8950. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8951. auto valid = true;
  8952. for (size_t i = 0; i < boundary.size(); i++) {
  8953. auto c = boundary[i];
  8954. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8955. valid = false;
  8956. break;
  8957. }
  8958. }
  8959. return valid;
  8960. }
  8961. // Escape a multipart field name/filename following the WHATWG HTML standard
  8962. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  8963. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  8964. // With quoted = false, only CR and LF are escaped; this is for header values
  8965. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  8966. inline std::string escape_multipart_field(const std::string &s,
  8967. bool quoted = true) {
  8968. std::string result;
  8969. result.reserve(s.size());
  8970. for (auto c : s) {
  8971. switch (c) {
  8972. case '"':
  8973. if (quoted) {
  8974. result += "%22";
  8975. } else {
  8976. result += c;
  8977. }
  8978. break;
  8979. case '\\':
  8980. // A lone backslash would escape the character after it (RFC 9110
  8981. // 5.6.4).
  8982. if (quoted) { result += '\\'; }
  8983. result += c;
  8984. break;
  8985. case '\r': result += "%0D"; break;
  8986. case '\n': result += "%0A"; break;
  8987. default: result += c; break;
  8988. }
  8989. }
  8990. return result;
  8991. }
  8992. template <typename T>
  8993. inline std::string
  8994. serialize_multipart_formdata_item_begin(const T &item,
  8995. const std::string &boundary) {
  8996. std::string body = "--" + boundary + "\r\n";
  8997. body += "Content-Disposition: form-data; name=\"" +
  8998. escape_multipart_field(item.name) + "\"";
  8999. if (!item.filename.empty()) {
  9000. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  9001. }
  9002. body += "\r\n";
  9003. if (!item.content_type.empty()) {
  9004. body +=
  9005. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  9006. "\r\n";
  9007. }
  9008. body += "\r\n";
  9009. return body;
  9010. }
  9011. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  9012. inline std::string
  9013. serialize_multipart_formdata_finish(const std::string &boundary) {
  9014. return "--" + boundary + "--\r\n";
  9015. }
  9016. inline std::string
  9017. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  9018. return "multipart/form-data; boundary=" + boundary;
  9019. }
  9020. inline std::string
  9021. serialize_multipart_formdata(const UploadFormDataItems &items,
  9022. const std::string &boundary, bool finish = true) {
  9023. std::string body;
  9024. for (const auto &item : items) {
  9025. body += serialize_multipart_formdata_item_begin(item, boundary);
  9026. body += item.content + serialize_multipart_formdata_item_end();
  9027. }
  9028. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  9029. return body;
  9030. }
  9031. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  9032. const std::string &boundary) {
  9033. size_t total = 0;
  9034. for (const auto &item : items) {
  9035. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  9036. total += item.content.size();
  9037. total += serialize_multipart_formdata_item_end().size();
  9038. }
  9039. total += serialize_multipart_formdata_finish(boundary).size();
  9040. return total;
  9041. }
  9042. struct MultipartSegment {
  9043. const char *data;
  9044. size_t size;
  9045. };
  9046. // NOTE: items must outlive the returned ContentProvider
  9047. // (safe for synchronous use inside Post/Put/Patch)
  9048. inline ContentProvider
  9049. make_multipart_content_provider(const UploadFormDataItems &items,
  9050. const std::string &boundary) {
  9051. // Own the per-item header strings and the finish string
  9052. std::vector<std::string> owned;
  9053. owned.reserve(items.size() + 1);
  9054. for (const auto &item : items)
  9055. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  9056. owned.push_back(serialize_multipart_formdata_finish(boundary));
  9057. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  9058. std::vector<MultipartSegment> segs;
  9059. segs.reserve(items.size() * 3 + 1);
  9060. static const char crlf[] = "\r\n";
  9061. for (size_t i = 0; i < items.size(); i++) {
  9062. segs.push_back({owned[i].data(), owned[i].size()});
  9063. segs.push_back({items[i].content.data(), items[i].content.size()});
  9064. segs.push_back({crlf, 2});
  9065. }
  9066. segs.push_back({owned.back().data(), owned.back().size()});
  9067. struct MultipartState {
  9068. std::vector<std::string> owned;
  9069. std::vector<MultipartSegment> segs;
  9070. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  9071. };
  9072. auto state = std::make_shared<MultipartState>();
  9073. state->owned = std::move(owned);
  9074. // `segs` holds raw pointers into owned strings; std::string move preserves
  9075. // the data pointer, so these pointers remain valid after the move above.
  9076. state->segs = std::move(segs);
  9077. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  9078. // Buffer multiple small segments into fewer, larger writes to avoid
  9079. // excessive TCP packets when there are many form data items (#2410)
  9080. auto &buf = state->buf;
  9081. auto buf_size = buf.size();
  9082. size_t buf_len = 0;
  9083. size_t remaining = length;
  9084. // Find the first segment containing 'offset'
  9085. size_t pos = 0;
  9086. size_t seg_idx = 0;
  9087. for (; seg_idx < state->segs.size(); seg_idx++) {
  9088. const auto &seg = state->segs[seg_idx];
  9089. if (seg.size > 0 && offset - pos < seg.size) { break; }
  9090. pos += seg.size;
  9091. }
  9092. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  9093. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  9094. const auto &seg = state->segs[seg_idx];
  9095. size_t available = seg.size - seg_offset;
  9096. size_t to_copy = (std::min)(available, remaining);
  9097. const char *src = seg.data + seg_offset;
  9098. seg_offset = 0; // only the first segment has a non-zero offset
  9099. while (to_copy > 0) {
  9100. size_t space = buf_size - buf_len;
  9101. size_t chunk = (std::min)(to_copy, space);
  9102. std::memcpy(buf.data() + buf_len, src, chunk);
  9103. buf_len += chunk;
  9104. src += chunk;
  9105. to_copy -= chunk;
  9106. remaining -= chunk;
  9107. if (buf_len == buf_size) {
  9108. if (!sink.write(buf.data(), buf_len)) { return false; }
  9109. buf_len = 0;
  9110. }
  9111. }
  9112. }
  9113. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  9114. return true;
  9115. };
  9116. }
  9117. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  9118. if (ranges.size() <= 1) return;
  9119. // Sort ranges by start position
  9120. std::sort(ranges.begin(), ranges.end(),
  9121. [](const Range &a, const Range &b) { return a.first < b.first; });
  9122. Ranges coalesced;
  9123. coalesced.reserve(ranges.size());
  9124. for (auto &r : ranges) {
  9125. auto first_pos = r.first;
  9126. auto last_pos = r.second;
  9127. // Handle special cases like in range_error
  9128. if (first_pos == -1 && last_pos == -1) {
  9129. first_pos = 0;
  9130. last_pos = static_cast<ssize_t>(content_length);
  9131. }
  9132. if (first_pos == -1) {
  9133. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  9134. last_pos = static_cast<ssize_t>(content_length) - 1;
  9135. }
  9136. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  9137. last_pos = static_cast<ssize_t>(content_length) - 1;
  9138. }
  9139. // Skip invalid ranges
  9140. if (!(0 <= first_pos && first_pos <= last_pos &&
  9141. last_pos < static_cast<ssize_t>(content_length))) {
  9142. continue;
  9143. }
  9144. // Coalesce with previous range if overlapping or adjacent (but not
  9145. // identical)
  9146. if (!coalesced.empty()) {
  9147. auto &prev = coalesced.back();
  9148. // Check if current range overlaps or is adjacent to previous range
  9149. // but don't coalesce identical ranges (allow duplicates)
  9150. if (first_pos <= prev.second + 1 &&
  9151. !(first_pos == prev.first && last_pos == prev.second)) {
  9152. // Extend the previous range
  9153. prev.second = (std::max)(prev.second, last_pos);
  9154. continue;
  9155. }
  9156. }
  9157. // Add new range
  9158. coalesced.emplace_back(first_pos, last_pos);
  9159. }
  9160. ranges = std::move(coalesced);
  9161. }
  9162. inline bool range_error(Request &req, Response &res) {
  9163. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  9164. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  9165. req.ranges.clear();
  9166. if (res.status == StatusCode::PartialContent_206) {
  9167. res.status = StatusCode::OK_200;
  9168. }
  9169. return false;
  9170. }
  9171. ssize_t content_len = static_cast<ssize_t>(
  9172. res.content_length_ ? res.content_length_ : res.body.size());
  9173. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  9174. size_t overwrapping_count = 0;
  9175. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  9176. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  9177. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  9178. // Too many ranges
  9179. if (CPPHTTPLIB_RANGE_MAX_COUNT > 0 &&
  9180. req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) {
  9181. return true;
  9182. }
  9183. for (auto &r : req.ranges) {
  9184. auto &first_pos = r.first;
  9185. auto &last_pos = r.second;
  9186. if (first_pos == -1 && last_pos == -1) {
  9187. first_pos = 0;
  9188. last_pos = content_len;
  9189. }
  9190. // RFC 9110 14.1.2: a suffix-length longer than the representation
  9191. // selects the entire representation.
  9192. if (first_pos == -1) {
  9193. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  9194. last_pos = content_len - 1;
  9195. }
  9196. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  9197. // A client can limit the number of bytes requested without knowing the
  9198. // size of the selected representation. If the last-pos value is absent,
  9199. // or if the value is greater than or equal to the current length of the
  9200. // representation data, the byte range is interpreted as the remainder of
  9201. // the representation (i.e., the server replaces the value of last-pos
  9202. // with a value that is one less than the current length of the selected
  9203. // representation).
  9204. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  9205. if (last_pos == -1 || last_pos >= content_len) {
  9206. last_pos = content_len - 1;
  9207. }
  9208. // Range must be within content length
  9209. if (!(0 <= first_pos && first_pos <= last_pos &&
  9210. last_pos <= content_len - 1)) {
  9211. return true;
  9212. }
  9213. // Request must not have more than two overlapping ranges
  9214. for (const auto &processed_range : processed_ranges) {
  9215. if (!(last_pos < processed_range.first ||
  9216. first_pos > processed_range.second)) {
  9217. overwrapping_count++;
  9218. if (overwrapping_count > 2) { return true; }
  9219. break; // Only count once per range
  9220. }
  9221. }
  9222. processed_ranges.emplace_back(first_pos, last_pos);
  9223. }
  9224. // After validation, coalesce overlapping ranges as per RFC 9110
  9225. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  9226. }
  9227. return false;
  9228. }
  9229. inline std::pair<size_t, size_t>
  9230. get_range_offset_and_length(Range r, size_t content_length) {
  9231. assert(r.first != -1 && r.second != -1);
  9232. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  9233. assert(r.first <= r.second &&
  9234. r.second < static_cast<ssize_t>(content_length));
  9235. (void)(content_length);
  9236. return std::make_pair(static_cast<size_t>(r.first),
  9237. static_cast<size_t>(r.second - r.first) + 1);
  9238. }
  9239. inline std::string make_content_range_header_field(
  9240. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  9241. auto st = offset_and_length.first;
  9242. auto ed = st + offset_and_length.second - 1;
  9243. std::string field = "bytes ";
  9244. field += std::to_string(st);
  9245. field += '-';
  9246. field += std::to_string(ed);
  9247. field += '/';
  9248. field += std::to_string(content_length);
  9249. return field;
  9250. }
  9251. template <typename SToken, typename CToken, typename Content>
  9252. bool process_multipart_ranges_data(const Request &req,
  9253. const std::string &boundary,
  9254. const std::string &content_type,
  9255. size_t content_length, SToken stoken,
  9256. CToken ctoken, Content content) {
  9257. for (size_t i = 0; i < req.ranges.size(); i++) {
  9258. ctoken("--");
  9259. stoken(boundary);
  9260. ctoken("\r\n");
  9261. if (!content_type.empty()) {
  9262. ctoken("Content-Type: ");
  9263. stoken(content_type);
  9264. ctoken("\r\n");
  9265. }
  9266. auto offset_and_length =
  9267. get_range_offset_and_length(req.ranges[i], content_length);
  9268. ctoken("Content-Range: ");
  9269. stoken(make_content_range_header_field(offset_and_length, content_length));
  9270. ctoken("\r\n");
  9271. ctoken("\r\n");
  9272. if (!content(offset_and_length.first, offset_and_length.second)) {
  9273. return false;
  9274. }
  9275. ctoken("\r\n");
  9276. }
  9277. ctoken("--");
  9278. stoken(boundary);
  9279. ctoken("--");
  9280. return true;
  9281. }
  9282. inline void make_multipart_ranges_data(const Request &req, Response &res,
  9283. const std::string &boundary,
  9284. const std::string &content_type,
  9285. size_t content_length,
  9286. std::string &data) {
  9287. process_multipart_ranges_data(
  9288. req, boundary, content_type, content_length,
  9289. [&](const std::string &token) { data += token; },
  9290. [&](const std::string &token) { data += token; },
  9291. [&](size_t offset, size_t length) {
  9292. assert(offset + length <= content_length);
  9293. data += res.body.substr(offset, length);
  9294. return true;
  9295. });
  9296. }
  9297. inline size_t get_multipart_ranges_data_length(const Request &req,
  9298. const std::string &boundary,
  9299. const std::string &content_type,
  9300. size_t content_length) {
  9301. size_t data_length = 0;
  9302. process_multipart_ranges_data(
  9303. req, boundary, content_type, content_length,
  9304. [&](const std::string &token) { data_length += token.size(); },
  9305. [&](const std::string &token) { data_length += token.size(); },
  9306. [&](size_t /*offset*/, size_t length) {
  9307. data_length += length;
  9308. return true;
  9309. });
  9310. return data_length;
  9311. }
  9312. template <typename T>
  9313. inline bool
  9314. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  9315. const std::string &boundary,
  9316. const std::string &content_type,
  9317. size_t content_length, const T &is_shutting_down) {
  9318. return process_multipart_ranges_data(
  9319. req, boundary, content_type, content_length,
  9320. [&](const std::string &token) { strm.write(token); },
  9321. [&](const std::string &token) { strm.write(token); },
  9322. [&](size_t offset, size_t length) {
  9323. return write_content(strm, res.content_provider_, offset, length,
  9324. is_shutting_down);
  9325. });
  9326. }
  9327. inline bool has_framed_body(const Request &req) {
  9328. return is_chunked_transfer_encoding(req.headers) ||
  9329. req.get_header_value_u64("Content-Length") > 0;
  9330. }
  9331. inline bool expect_content(const Request &req) {
  9332. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  9333. req.method == "DELETE") {
  9334. return true;
  9335. }
  9336. return has_framed_body(req);
  9337. }
  9338. #ifdef _WIN32
  9339. class WSInit {
  9340. public:
  9341. WSInit() {
  9342. WSADATA wsaData;
  9343. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  9344. }
  9345. ~WSInit() {
  9346. if (is_valid_) WSACleanup();
  9347. }
  9348. bool is_valid_ = false;
  9349. };
  9350. static WSInit wsinit_;
  9351. #endif
  9352. inline std::string unescape_quoted_pairs(const std::string &s) {
  9353. std::string out;
  9354. out.reserve(s.size());
  9355. for (size_t i = 0; i < s.size(); i++) {
  9356. if (s[i] == '\\' && i + 1 < s.size()) {
  9357. out += s[++i];
  9358. } else {
  9359. out += s[i];
  9360. }
  9361. }
  9362. return out;
  9363. }
  9364. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  9365. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  9366. // quoted-pair, so the recipient recovers the original value.
  9367. inline std::string escape_quoted_pairs(const std::string &s) {
  9368. std::string out;
  9369. out.reserve(s.size());
  9370. for (auto c : s) {
  9371. if (c == '\\' || c == '"') { out += '\\'; }
  9372. out += c;
  9373. }
  9374. return out;
  9375. }
  9376. // RFC 9110 Section 11.6.1 defines a challenge list as
  9377. // WWW-Authenticate = #challenge
  9378. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  9379. // auth-param = token BWS "=" BWS ( token / quoted-string )
  9380. // so a server may offer several schemes, each with its own comma-separated
  9381. // auth-param list, in either order and either as separate field lines or
  9382. // packed into one. Splitting on every comma would break apart a challenge's
  9383. // own param list; splitting only on the first space would miss a Digest
  9384. // challenge that isn't first. Split on commas that aren't inside a
  9385. // quoted-string instead (split_unquoted), then track which scheme each
  9386. // resulting segment belongs to: a segment whose text before "=" contains
  9387. // whitespace (or that has no "=" at all) starts a new challenge named by its
  9388. // leading token.
  9389. inline bool parse_www_authenticate(const Response &res,
  9390. std::map<std::string, std::string> &auth,
  9391. bool is_proxy) {
  9392. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  9393. auto combined = get_combined_header_value(res.headers, auth_key);
  9394. if (combined.empty()) { return false; }
  9395. auto found_digest = false;
  9396. auto in_digest_challenge = false;
  9397. split_unquoted(
  9398. combined.data(), combined.data() + combined.size(), ',',
  9399. [&](const char *b, const char *e) {
  9400. std::string segment(b, e);
  9401. auto eq_pos = segment.find('=');
  9402. // BWS is allowed on both sides of "=", so the text naming the key (or,
  9403. // for the first segment of a challenge, "<scheme> <key>") must be
  9404. // trimmed before its boundaries are inspected.
  9405. auto key_part = trim_copy(
  9406. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  9407. auto space_pos = key_part.find_last_of(" \t");
  9408. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  9409. // "<scheme>[ <key>]" starts a new challenge.
  9410. auto scheme_end =
  9411. space_pos == std::string::npos ? key_part.size() : space_pos;
  9412. // RFC 7616 Section 3.7: a server may offer more than one Digest
  9413. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  9414. // from one challenge is never paired with another's algorithm.
  9415. in_digest_challenge =
  9416. !found_digest &&
  9417. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  9418. if (in_digest_challenge) { found_digest = true; }
  9419. if (space_pos == std::string::npos) {
  9420. // Bare scheme (or a token68), no auth-param on this segment.
  9421. return;
  9422. }
  9423. key_part = key_part.substr(space_pos + 1);
  9424. }
  9425. if (!in_digest_challenge) { return; }
  9426. auto val = trim_copy(segment.substr(eq_pos + 1));
  9427. auto unquoted = trim_double_quotes_copy(val);
  9428. if (unquoted.size() != val.size()) {
  9429. unquoted = unescape_quoted_pairs(unquoted);
  9430. }
  9431. auth[std::move(key_part)] = std::move(unquoted);
  9432. });
  9433. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  9434. // make_digest_authentication_header() dereferences both unconditionally, so
  9435. // a challenge missing either can't produce a usable Authorization header.
  9436. // Treat it the same as no Digest challenge at all.
  9437. return found_digest && auth.find("realm") != auth.end() &&
  9438. auth.find("nonce") != auth.end();
  9439. }
  9440. class ContentProviderAdapter {
  9441. public:
  9442. explicit ContentProviderAdapter(
  9443. ContentProviderWithoutLength &&content_provider)
  9444. : content_provider_(std::move(content_provider)) {}
  9445. bool operator()(size_t offset, size_t, DataSink &sink) {
  9446. return content_provider_(offset, sink);
  9447. }
  9448. private:
  9449. ContentProviderWithoutLength content_provider_;
  9450. };
  9451. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  9452. namespace fields {
  9453. inline bool is_token_char(char c) {
  9454. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  9455. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  9456. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  9457. }
  9458. inline bool is_token(const std::string &s) {
  9459. if (s.empty()) { return false; }
  9460. for (auto c : s) {
  9461. if (!is_token_char(c)) { return false; }
  9462. }
  9463. return true;
  9464. }
  9465. inline bool is_field_name(const std::string &s) { return is_token(s); }
  9466. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  9467. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  9468. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  9469. inline bool is_field_content(const std::string &s) {
  9470. if (s.empty()) { return true; }
  9471. if (s.size() == 1) {
  9472. return is_field_vchar(s[0]);
  9473. } else if (s.size() == 2) {
  9474. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  9475. } else {
  9476. size_t i = 0;
  9477. if (!is_field_vchar(s[i])) { return false; }
  9478. i++;
  9479. while (i < s.size() - 1) {
  9480. auto c = s[i++];
  9481. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  9482. } else {
  9483. return false;
  9484. }
  9485. }
  9486. return is_field_vchar(s[i]);
  9487. }
  9488. }
  9489. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  9490. inline bool is_field_valid(const std::string &name, const std::string &value) {
  9491. return is_field_name(name) && is_field_value(value);
  9492. }
  9493. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  9494. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  9495. inline bool is_request_target(const std::string &s) {
  9496. return std::all_of(s.begin(), s.end(), is_field_vchar);
  9497. }
  9498. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  9499. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  9500. inline bool is_host(const std::string &s) {
  9501. return std::all_of(s.begin(), s.end(), [](char c) {
  9502. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  9503. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9504. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9505. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  9506. });
  9507. }
  9508. } // namespace fields
  9509. // Built in memory first, like ClientImpl::write_request, so a rejected header
  9510. // never leaves a partial request on the wire.
  9511. inline bool write_request_head(Stream &strm, Request &req, Error &error) {
  9512. BufferStream bstrm;
  9513. if (write_request_line(bstrm, req.method, req.path) < 0) {
  9514. error = Error::Write;
  9515. return false;
  9516. }
  9517. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  9518. return false;
  9519. }
  9520. const auto &data = bstrm.get_buffer();
  9521. if (!write_data(strm, data.data(), data.size())) {
  9522. error = Error::Write;
  9523. return false;
  9524. }
  9525. return true;
  9526. }
  9527. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  9528. WebSocketUpgradeResponse &upgrade) {
  9529. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  9530. std::string key_bytes(16, '\0');
  9531. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  9532. key_bytes.size());
  9533. auto client_key = base64_encode(key_bytes);
  9534. req.headers.erase("Upgrade");
  9535. req.headers.erase("Connection");
  9536. req.headers.erase("Sec-WebSocket-Key");
  9537. req.headers.erase("Sec-WebSocket-Version");
  9538. req.headers.emplace("Upgrade", "websocket");
  9539. req.headers.emplace("Connection", "Upgrade");
  9540. req.headers.emplace("Sec-WebSocket-Key", client_key);
  9541. req.headers.emplace("Sec-WebSocket-Version", "13");
  9542. if (!write_request_head(strm, req, upgrade.error)) { return false; }
  9543. // Verify 101 response and Sec-WebSocket-Accept header
  9544. auto expected_accept = websocket_accept_key(client_key);
  9545. auto offered_subprotocols =
  9546. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  9547. return read_websocket_upgrade_response(strm, expected_accept,
  9548. offered_subprotocols, upgrade);
  9549. }
  9550. inline bool is_ip_address(const std::string &host) {
  9551. struct in_addr addr4;
  9552. struct in6_addr addr6;
  9553. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  9554. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  9555. }
  9556. // One spelling for an IPv6 address, and the IPv4 one for an IPv4-mapped IPv6
  9557. // address, which is how a dual-stack socket reports an IPv4 peer. Anything
  9558. // else, including an address with a zone ID, is returned as it is.
  9559. inline std::string canonical_ip(const std::string &addr) {
  9560. struct in6_addr addr6;
  9561. if (addr.find('%') != std::string::npos ||
  9562. inet_pton(AF_INET6, addr.c_str(), &addr6) != 1) {
  9563. return addr;
  9564. }
  9565. char buf[INET6_ADDRSTRLEN];
  9566. if (IN6_IS_ADDR_V4MAPPED(&addr6)) {
  9567. return inet_ntop(AF_INET, &addr6.s6_addr[12], buf, sizeof(buf)) ? buf
  9568. : addr;
  9569. }
  9570. return inet_ntop(AF_INET6, &addr6, buf, sizeof(buf)) ? buf : addr;
  9571. }
  9572. // `trusted_proxies` holds canonical_ip() spellings.
  9573. inline bool is_trusted_proxy(const std::string &addr,
  9574. const std::vector<std::string> &trusted_proxies) {
  9575. if (trusted_proxies.empty()) { return false; }
  9576. return std::find(trusted_proxies.begin(), trusted_proxies.end(),
  9577. canonical_ip(addr)) != trusted_proxies.end();
  9578. }
  9579. // Resolve where a client should connect for `host`, honoring a user-supplied
  9580. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  9581. // supplying the Host header and SNI; only the connection target changes.
  9582. //
  9583. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  9584. // path. Anything else goes to `connect_host`, which create_socket resolves as
  9585. // a name, or uses as the socket path when the address family is AF_UNIX. An
  9586. // absent or empty mapping leaves `host` as the connection target; without the
  9587. // empty check the value would reach getaddrinfo as a null node and silently
  9588. // resolve to loopback.
  9589. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  9590. const std::string &host, std::string &connect_host,
  9591. std::string &ip) {
  9592. connect_host = host;
  9593. ip.clear();
  9594. auto it = addr_map.find(host);
  9595. if (it == addr_map.end() || it->second.empty()) { return; }
  9596. if (is_ip_address(it->second)) {
  9597. ip = it->second;
  9598. } else {
  9599. connect_host = it->second;
  9600. }
  9601. }
  9602. } // namespace detail
  9603. /*
  9604. * Group 2: detail namespace - SSL common utilities
  9605. */
  9606. #ifdef CPPHTTPLIB_SSL_ENABLED
  9607. namespace detail {
  9608. class SSLSocketStream final : public Stream {
  9609. public:
  9610. SSLSocketStream(
  9611. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  9612. time_t read_timeout_usec, time_t write_timeout_sec,
  9613. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  9614. std::chrono::time_point<std::chrono::steady_clock> start_time =
  9615. (std::chrono::steady_clock::time_point::min)());
  9616. ~SSLSocketStream() override;
  9617. bool is_readable() const override;
  9618. bool wait_readable() const override;
  9619. bool wait_writable() const override;
  9620. bool is_peer_alive() const override;
  9621. ssize_t read(char *ptr, size_t size) override;
  9622. ssize_t write(const char *ptr, size_t size) override;
  9623. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9624. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9625. socket_t socket() const override;
  9626. time_t duration() const override;
  9627. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9628. void set_max_timeout(time_t msec) override;
  9629. void set_read_interrupt(std::function<bool()> interrupted) override;
  9630. // See SocketStream::set_readable_hint().
  9631. void set_readable_hint() { readable_hint_ = true; }
  9632. // The error from the last read() or write() that failed in the TLS layer,
  9633. // with code Success if none did
  9634. const tls::TlsError &tls_error() const { return tls_error_; }
  9635. private:
  9636. bool ensure_readable();
  9637. socket_t sock_;
  9638. tls::session_t session_;
  9639. time_t read_timeout_sec_;
  9640. time_t read_timeout_usec_;
  9641. time_t write_timeout_sec_;
  9642. time_t write_timeout_usec_;
  9643. time_t max_timeout_msec_;
  9644. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9645. std::function<bool()> read_interrupted_;
  9646. bool readable_hint_ = false;
  9647. tls::TlsError tls_error_;
  9648. };
  9649. // A TLS stream for WebSocket connections, where the receive path and the
  9650. // send path (application send() plus the heartbeat ping thread) run on
  9651. // different threads. A single TLS session must never be entered
  9652. // concurrently, so every call into the session is serialized by one mutex.
  9653. //
  9654. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  9655. // whole lifetime and each read()/write() performs a single non-blocking TLS
  9656. // call under the lock, then waits for readiness with select() outside the
  9657. // lock. The lock is therefore held only for CPU-bound work, so a reader
  9658. // blocked waiting for data never stalls a concurrent sender.
  9659. //
  9660. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  9661. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  9662. class WebSocketSSLStream final : public Stream {
  9663. public:
  9664. WebSocketSSLStream(socket_t sock, tls::session_t session,
  9665. time_t read_timeout_sec, time_t read_timeout_usec,
  9666. time_t write_timeout_sec, time_t write_timeout_usec);
  9667. ~WebSocketSSLStream() override;
  9668. bool is_readable() const override;
  9669. bool wait_readable() const override;
  9670. bool wait_writable() const override;
  9671. ssize_t read(char *ptr, size_t size) override;
  9672. ssize_t write(const char *ptr, size_t size) override;
  9673. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9674. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9675. socket_t socket() const override;
  9676. time_t duration() const override;
  9677. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9678. void set_max_timeout(time_t msec) override;
  9679. void set_read_interrupt(std::function<bool()> interrupted) override;
  9680. private:
  9681. mutable std::mutex session_mutex_;
  9682. socket_t sock_;
  9683. tls::session_t session_;
  9684. // May change while another thread is in wait_readable(); write timeouts don't
  9685. std::atomic<time_t> read_timeout_sec_;
  9686. std::atomic<time_t> read_timeout_usec_;
  9687. time_t write_timeout_sec_;
  9688. time_t write_timeout_usec_;
  9689. std::atomic<time_t> max_timeout_msec_{0};
  9690. std::atomic<std::chrono::steady_clock::rep> start_time_;
  9691. std::function<bool()> read_interrupted_;
  9692. };
  9693. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9694. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9695. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9696. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9697. unsigned int hash_length = 0;
  9698. unsigned char hash[EVP_MAX_MD_SIZE];
  9699. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9700. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9701. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9702. std::stringstream ss;
  9703. for (auto i = 0u; i < hash_length; ++i) {
  9704. ss << std::hex << std::setw(2) << std::setfill('0')
  9705. << static_cast<unsigned int>(hash[i]);
  9706. }
  9707. return ss.str();
  9708. }
  9709. inline std::string MD5(const std::string &s) {
  9710. return message_digest(s, EVP_md5());
  9711. }
  9712. inline std::string SHA_256(const std::string &s) {
  9713. return message_digest(s, EVP_sha256());
  9714. }
  9715. inline std::string SHA_512(const std::string &s) {
  9716. return message_digest(s, EVP_sha512());
  9717. }
  9718. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9719. namespace {
  9720. template <size_t N>
  9721. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9722. std::stringstream ss;
  9723. for (size_t i = 0; i < N; ++i) {
  9724. ss << std::hex << std::setw(2) << std::setfill('0')
  9725. << static_cast<unsigned int>(hash[i]);
  9726. }
  9727. return ss.str();
  9728. }
  9729. } // namespace
  9730. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9731. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9732. // initialized once. PSA state is process-global; do not free it.
  9733. inline bool ensure_mbedtls_psa_crypto() {
  9734. static std::once_flag once;
  9735. static bool ok = false;
  9736. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9737. return ok;
  9738. }
  9739. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9740. unsigned char *out, size_t out_size) {
  9741. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9742. size_t olen = 0;
  9743. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9744. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9745. olen == out_size;
  9746. }
  9747. #endif
  9748. inline std::string MD5(const std::string &s) {
  9749. unsigned char hash[16];
  9750. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9751. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9752. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9753. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9754. hash);
  9755. #else
  9756. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9757. hash);
  9758. #endif
  9759. return hash_to_hex(hash);
  9760. }
  9761. inline std::string SHA_256(const std::string &s) {
  9762. unsigned char hash[32];
  9763. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9764. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9765. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9766. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9767. hash, 0);
  9768. #else
  9769. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9770. s.size(), hash, 0);
  9771. #endif
  9772. return hash_to_hex(hash);
  9773. }
  9774. inline std::string SHA_512(const std::string &s) {
  9775. unsigned char hash[64];
  9776. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9777. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9778. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9779. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9780. hash, 0);
  9781. #else
  9782. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9783. s.size(), hash, 0);
  9784. #endif
  9785. return hash_to_hex(hash);
  9786. }
  9787. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9788. namespace {
  9789. template <size_t N>
  9790. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9791. std::stringstream ss;
  9792. for (size_t i = 0; i < N; ++i) {
  9793. ss << std::hex << std::setw(2) << std::setfill('0')
  9794. << static_cast<unsigned int>(hash[i]);
  9795. }
  9796. return ss.str();
  9797. }
  9798. } // namespace
  9799. inline std::string MD5(const std::string &s) {
  9800. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9801. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9802. static_cast<word32>(s.size()), hash);
  9803. return hash_to_hex(hash);
  9804. }
  9805. inline std::string SHA_256(const std::string &s) {
  9806. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9807. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9808. static_cast<word32>(s.size()), hash);
  9809. return hash_to_hex(hash);
  9810. }
  9811. inline std::string SHA_512(const std::string &s) {
  9812. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9813. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9814. static_cast<word32>(s.size()), hash);
  9815. return hash_to_hex(hash);
  9816. }
  9817. #endif
  9818. template <typename T>
  9819. inline bool process_server_socket_ssl(
  9820. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9821. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9822. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9823. time_t write_timeout_usec, T callback) {
  9824. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9825. // of a pipelined request, which keep_alive() cannot see on the socket.
  9826. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9827. write_timeout_sec, write_timeout_usec);
  9828. return process_server_socket_core(
  9829. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9830. [&]() { return strm.is_readable(); },
  9831. [&](bool socket_readable, bool close_connection,
  9832. bool &connection_closed) {
  9833. if (socket_readable) { strm.set_readable_hint(); }
  9834. return callback(strm, close_connection, connection_closed);
  9835. });
  9836. }
  9837. template <typename T>
  9838. inline bool process_client_socket_ssl(
  9839. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9840. time_t read_timeout_usec, time_t write_timeout_sec,
  9841. time_t write_timeout_usec, time_t max_timeout_msec,
  9842. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9843. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9844. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9845. start_time);
  9846. return callback(strm);
  9847. }
  9848. // `uri` is req's request-target in origin form, as curl sends it, also when
  9849. // the request line carries the absolute form for a proxy.
  9850. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9851. const Request &req, const std::string &uri,
  9852. const std::map<std::string, std::string> &auth, size_t cnonce_count,
  9853. const std::string &cnonce, const std::string &username,
  9854. const std::string &password, bool is_proxy = false) {
  9855. std::string nc;
  9856. {
  9857. std::stringstream ss;
  9858. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9859. nc = ss.str();
  9860. }
  9861. std::string qop;
  9862. if (auth.find("qop") != auth.end()) {
  9863. qop = auth.at("qop");
  9864. if (qop.find("auth-int") != std::string::npos) {
  9865. qop = "auth-int";
  9866. } else if (qop.find("auth") != std::string::npos) {
  9867. qop = "auth";
  9868. } else {
  9869. qop.clear();
  9870. }
  9871. }
  9872. std::string algo = "MD5";
  9873. if (auth.find("algorithm") != auth.end()) {
  9874. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9875. // not a token would otherwise be emitted verbatim and could carry commas
  9876. // or quotes that inject further auth-params into the header below.
  9877. const auto &a = auth.at("algorithm");
  9878. if (fields::is_token(a)) { algo = a; }
  9879. }
  9880. std::string response;
  9881. {
  9882. auto H = algo == "SHA-256" ? detail::SHA_256
  9883. : algo == "SHA-512" ? detail::SHA_512
  9884. : detail::MD5;
  9885. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9886. auto A2 = req.method + ":" + uri;
  9887. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9888. if (qop.empty()) {
  9889. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9890. } else {
  9891. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9892. ":" + qop + ":" + H(A2));
  9893. }
  9894. }
  9895. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9896. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9897. // close the string early. realm, nonce and opaque come straight from the
  9898. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9899. // without this a crafted challenge injects extra auth-params into the header.
  9900. auto field =
  9901. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9902. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9903. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9904. "\", uri=\"" + detail::escape_quoted_pairs(uri) +
  9905. "\", algorithm=" + algo +
  9906. (qop.empty() ? ", response=\""
  9907. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9908. "\", response=\"") +
  9909. response + "\"" +
  9910. (opaque.empty()
  9911. ? ""
  9912. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9913. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9914. return std::make_pair(key, field);
  9915. }
  9916. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9917. // backend accepts the same names.
  9918. inline bool match_hostname(const std::string &pattern,
  9919. const std::string &hostname) {
  9920. // A trailing dot on the host is ignored
  9921. auto host = hostname;
  9922. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9923. // Exact match (case-insensitive)
  9924. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9925. // Split both pattern and hostname into components by '.', keeping any empty
  9926. // one, which no name may have
  9927. auto labels = [](const std::string &s) {
  9928. std::vector<std::string> v;
  9929. size_t b = 0;
  9930. while (true) {
  9931. auto e = s.find('.', b);
  9932. v.push_back(s.substr(b, e - b));
  9933. if (e == std::string::npos) { return v; }
  9934. b = e + 1;
  9935. }
  9936. };
  9937. auto pattern_components = labels(pattern);
  9938. auto host_components = labels(host);
  9939. auto has_empty_label = [](const std::vector<std::string> &v) {
  9940. return std::any_of(v.begin(), v.end(),
  9941. [](const std::string &l) { return l.empty(); });
  9942. };
  9943. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9944. return false;
  9945. }
  9946. // Component count must match
  9947. if (host_components.size() != pattern_components.size()) { return false; }
  9948. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9949. // and an IDNA label may not have one
  9950. const auto &leftmost = pattern_components.front();
  9951. if (leftmost.find('*') != std::string::npos &&
  9952. (pattern_components.size() < 3 ||
  9953. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9954. return false;
  9955. }
  9956. // Compare each component with wildcard support
  9957. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9958. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9959. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9960. auto itr = pattern_components.begin();
  9961. for (const auto &h : host_components) {
  9962. auto &p = *itr;
  9963. auto is_leftmost = itr == pattern_components.begin();
  9964. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9965. bool partial_match = false;
  9966. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9967. const auto prefix_length = p.size() - 1;
  9968. if (prefix_length == 0) {
  9969. partial_match = true;
  9970. } else if (h.size() >= prefix_length) {
  9971. partial_match =
  9972. std::equal(p.begin(),
  9973. p.begin() + static_cast<std::string::difference_type>(
  9974. prefix_length),
  9975. h.begin(), [](const char ca, const char cb) {
  9976. return detail::case_ignore::to_lower(ca) ==
  9977. detail::case_ignore::to_lower(cb);
  9978. });
  9979. }
  9980. }
  9981. if (!partial_match) { return false; }
  9982. }
  9983. ++itr;
  9984. }
  9985. return true;
  9986. }
  9987. #ifdef _WIN32
  9988. // Verify certificate using Windows CertGetCertificateChain API.
  9989. // This provides real-time certificate validation with Windows Update
  9990. // integration, independent of the TLS backend.
  9991. inline bool verify_cert_with_windows_schannel(
  9992. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9993. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9994. if (der_cert.empty()) { return false; }
  9995. out_error = 0;
  9996. // Create Windows certificate context from DER data
  9997. auto cert_context = CertCreateCertificateContext(
  9998. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9999. static_cast<DWORD>(der_cert.size()));
  10000. if (!cert_context) {
  10001. out_error = GetLastError();
  10002. return false;
  10003. }
  10004. auto cert_guard =
  10005. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  10006. // Give CryptoAPI the certificates the server sent. Without them it follows
  10007. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  10008. std::vector<tls::cert_t> peer_certs;
  10009. tls::get_peer_certs(session, peer_certs);
  10010. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  10011. auto store_guard = scope_exit([&] {
  10012. for (auto cert : peer_certs) {
  10013. tls::free_cert(cert);
  10014. }
  10015. if (store) { CertCloseStore(store, 0); }
  10016. });
  10017. for (auto cert : peer_certs) {
  10018. std::vector<unsigned char> der;
  10019. if (store && tls::get_cert_der(cert, der)) {
  10020. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  10021. static_cast<DWORD>(der.size()),
  10022. CERT_STORE_ADD_USE_EXISTING, nullptr);
  10023. }
  10024. }
  10025. // Setup chain parameters
  10026. CERT_CHAIN_PARA chain_para = {};
  10027. chain_para.cbSize = sizeof(chain_para);
  10028. // Require the server authentication usage along the chain, which also
  10029. // rejects roots that Windows trusts only for other purposes.
  10030. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  10031. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  10032. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  10033. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  10034. // Build certificate chain with revocation checking
  10035. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  10036. auto chain_result = CertGetCertificateChain(
  10037. nullptr, cert_context, nullptr, store, &chain_para,
  10038. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  10039. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  10040. nullptr, &chain_context);
  10041. if (!chain_result || !chain_context) {
  10042. out_error = GetLastError();
  10043. return false;
  10044. }
  10045. auto chain_guard =
  10046. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  10047. // Verify SSL policy
  10048. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  10049. extra_policy_para.cbSize = sizeof(extra_policy_para);
  10050. #ifdef AUTHTYPE_SERVER
  10051. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  10052. #endif
  10053. std::wstring whost;
  10054. if (verify_hostname) {
  10055. whost = u8string_to_wstring(hostname.c_str());
  10056. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  10057. }
  10058. CERT_CHAIN_POLICY_PARA policy_para = {};
  10059. policy_para.cbSize = sizeof(policy_para);
  10060. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  10061. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  10062. #else
  10063. policy_para.dwFlags = 0;
  10064. #endif
  10065. policy_para.pvExtraPolicyPara = &extra_policy_para;
  10066. CERT_CHAIN_POLICY_STATUS policy_status = {};
  10067. policy_status.cbSize = sizeof(policy_status);
  10068. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  10069. &policy_para, &policy_status)) {
  10070. out_error = GetLastError();
  10071. return false;
  10072. }
  10073. if (policy_status.dwError != 0) {
  10074. out_error = policy_status.dwError;
  10075. return false;
  10076. }
  10077. return true;
  10078. }
  10079. #endif // _WIN32
  10080. // Loads CA file/dir configuration and applies the system CA policy to a
  10081. // client TLS context. PEM data and native stores are applied to the context
  10082. // directly at set time; has_custom_store reflects them for the Auto policy
  10083. // decision.
  10084. inline bool load_client_ca_config(tls::ctx_t ctx,
  10085. const std::string &ca_cert_file_path,
  10086. const std::string &ca_cert_dir_path,
  10087. bool has_custom_store, SystemCAMode mode,
  10088. uint64_t &backend_error) {
  10089. auto ret = true;
  10090. if (!ca_cert_file_path.empty()) {
  10091. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  10092. backend_error = tls::get_error();
  10093. ret = false;
  10094. }
  10095. } else if (!ca_cert_dir_path.empty()) {
  10096. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  10097. backend_error = tls::get_error();
  10098. ret = false;
  10099. }
  10100. }
  10101. auto has_custom_ca = !ca_cert_file_path.empty() ||
  10102. !ca_cert_dir_path.empty() || has_custom_store;
  10103. if (mode == SystemCAMode::Enabled ||
  10104. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  10105. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  10106. }
  10107. return ret;
  10108. }
  10109. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  10110. // Schannel is skipped when a custom CA is specified, as the Windows
  10111. // certificate store would not know about it, and when system CA trust is
  10112. // explicitly disabled.
  10113. inline bool use_windows_cert_verification(bool enabled,
  10114. const std::string &ca_cert_file_path,
  10115. const std::string &ca_cert_dir_path,
  10116. bool has_custom_store,
  10117. SystemCAMode mode) {
  10118. return enabled && mode != SystemCAMode::Disabled &&
  10119. ca_cert_file_path.empty() && ca_cert_dir_path.empty() &&
  10120. !has_custom_store;
  10121. }
  10122. #endif
  10123. // Serializes the CA certificates installed in ctx as PEM, so they can be
  10124. // loaded into another context.
  10125. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  10126. std::string pem;
  10127. std::vector<tls::cert_t> certs;
  10128. tls::get_ca_certs(ctx, certs);
  10129. for (auto cert : certs) {
  10130. std::vector<unsigned char> der;
  10131. if (tls::get_cert_der(cert, der)) {
  10132. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  10133. pem += "-----BEGIN CERTIFICATE-----\n";
  10134. for (size_t i = 0; i < b64.size(); i += 64) {
  10135. pem += b64.substr(i, 64);
  10136. pem += '\n';
  10137. }
  10138. pem += "-----END CERTIFICATE-----\n";
  10139. }
  10140. tls::free_cert(cert);
  10141. }
  10142. return pem;
  10143. }
  10144. // Returns a PemMemory field as a NUL-terminated string: its first len bytes,
  10145. // copied to buf, or pem itself when len is 0.
  10146. inline const char *pem_c_str(const char *pem, size_t len, std::string &buf) {
  10147. if (!pem || len == 0) { return pem; }
  10148. buf.assign(pem, len);
  10149. return buf.c_str();
  10150. }
  10151. // The parts of session setup that only SSLClient needs, plus the handful
  10152. // WebSocketClient also exposes; everything else takes the defaults, which is
  10153. // what keeps the two clients on one implementation.
  10154. struct ClientTlsSessionOptions {
  10155. // Both SSLClient and WebSocketClient expose this independently of
  10156. // certificate verification.
  10157. bool server_hostname_verification = true;
  10158. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  10159. // When set, ends the handshake as a timeout does once it returns true
  10160. std::function<bool()> interrupted;
  10161. // When non-null, guards session creation against concurrent use of the
  10162. // context. A WebSocketClient is not safe to use from several threads to
  10163. // begin with, so it passes nothing.
  10164. std::mutex *ctx_mutex = nullptr;
  10165. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  10166. // See use_windows_cert_verification().
  10167. bool windows_cert_verification = false;
  10168. // A server certificate verifier works on the backend's chain verification,
  10169. // so the backend keeps deciding and Schannel only adds its own check.
  10170. bool server_certificate_verifier_set = false;
  10171. #endif
  10172. };
  10173. // Filled in on failure for callers that report error details.
  10174. struct ClientTlsSessionError {
  10175. Error error = Error::Success;
  10176. int ssl_error = 0;
  10177. uint64_t backend_error = 0;
  10178. };
  10179. // Establishes a client TLS session on an already connected socket. On failure
  10180. // the session is left for the caller to free: SSLClient frees it right away,
  10181. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  10182. inline bool setup_client_tls_session(
  10183. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  10184. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  10185. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  10186. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  10187. using namespace tls;
  10188. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  10189. if (out_error) {
  10190. out_error->error = error;
  10191. out_error->ssl_error = ssl_error;
  10192. out_error->backend_error = backend_error;
  10193. }
  10194. return false;
  10195. };
  10196. // A TLS failure, whose verification codes name the Error too
  10197. auto fail_tls = [&](ErrorCode code, uint64_t backend_error) {
  10198. auto error = Error::SSLConnection;
  10199. if (code == ErrorCode::CertVerifyFailed) {
  10200. error = Error::SSLServerVerification;
  10201. } else if (code == ErrorCode::HostnameMismatch) {
  10202. error = Error::SSLServerHostnameVerification;
  10203. }
  10204. return fail(error, static_cast<int>(code), backend_error);
  10205. };
  10206. if (!ctx) {
  10207. session = nullptr;
  10208. return fail(Error::SSLConnection, 0, 0);
  10209. }
  10210. // With Windows verification on and no server certificate verifier set,
  10211. // Schannel is the only chain verifier. The backend's trust store is a
  10212. // snapshot of the Windows stores that lacks the roots Windows fetches on
  10213. // demand, so the backend's verdict is not used.
  10214. auto windows_verifies_chain = false;
  10215. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  10216. windows_verifies_chain = options.windows_cert_verification &&
  10217. !options.server_certificate_verifier_set;
  10218. #endif
  10219. // The chain, and a host name, are verified during the handshake, so that a
  10220. // server failing them never gets to see a client certificate. Unless
  10221. // Schannel verifies the chain instead, this holds for IP hosts too, whose
  10222. // identity is checked after the handshake by verify_hostname().
  10223. auto verify_in_handshake =
  10224. server_certificate_verification && !windows_verifies_chain;
  10225. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10226. // A session verifier may accept a certificate the built-in check rejects,
  10227. // and runs only after the handshake
  10228. verify_in_handshake = verify_in_handshake && !options.session_verifier;
  10229. #endif
  10230. {
  10231. std::unique_lock<std::mutex> guard;
  10232. if (options.ctx_mutex) {
  10233. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  10234. }
  10235. // The mode is set on the context, so under the same lock
  10236. set_verify_client(ctx, verify_in_handshake);
  10237. session = create_session(ctx, sock);
  10238. }
  10239. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  10240. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  10241. // their identity is checked post-handshake below instead.
  10242. if (!is_ip_address(host)) {
  10243. if (!set_sni(session, host.c_str(),
  10244. verify_in_handshake && options.server_hostname_verification)) {
  10245. return fail(Error::SSLConnection, 0, get_error());
  10246. }
  10247. }
  10248. TlsError tls_err;
  10249. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec, &tls_err,
  10250. options.interrupted)) {
  10251. return fail_tls(tls_err.code, tls_err.backend_code);
  10252. }
  10253. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  10254. if (options.session_verifier) {
  10255. verification_status = options.session_verifier(session);
  10256. }
  10257. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  10258. return fail(Error::SSLServerVerification, 0, get_error());
  10259. }
  10260. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  10261. server_certificate_verification) {
  10262. if (!windows_verifies_chain) {
  10263. auto verify_result = get_verify_result(session);
  10264. if (verify_result != 0) {
  10265. return fail_tls(ErrorCode::CertVerifyFailed,
  10266. static_cast<uint64_t>(verify_result));
  10267. }
  10268. }
  10269. auto server_cert = get_peer_cert(session);
  10270. if (!server_cert) {
  10271. return fail_tls(ErrorCode::CertVerifyFailed, get_error());
  10272. }
  10273. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  10274. // Identity check against the peer certificate, post-handshake for all
  10275. // backends. For IP hosts this is the only identity verification, since no
  10276. // hostname is bound during the handshake.
  10277. if (options.server_hostname_verification) {
  10278. if (!verify_hostname(server_cert, host.c_str())) {
  10279. return fail_tls(ErrorCode::HostnameMismatch, hostname_mismatch_code());
  10280. }
  10281. }
  10282. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  10283. // Windows Schannel verification, which lets Windows fetch missing roots
  10284. // and intermediates on demand. It must not be skipped: unless a server
  10285. // certificate verifier is set, it is the only chain check.
  10286. if (options.windows_cert_verification) {
  10287. std::vector<unsigned char> der;
  10288. uint64_t wincrypt_error = 0;
  10289. if (!get_cert_der(server_cert, der) ||
  10290. !verify_cert_with_windows_schannel(
  10291. der, host, options.server_hostname_verification, wincrypt_error,
  10292. session)) {
  10293. return fail_tls(ErrorCode::CertVerifyFailed, wincrypt_error);
  10294. }
  10295. }
  10296. #endif
  10297. }
  10298. return true;
  10299. }
  10300. } // namespace detail
  10301. #endif // CPPHTTPLIB_SSL_ENABLED
  10302. /*
  10303. * Group 3: httplib namespace - Non-SSL public API implementations
  10304. */
  10305. inline void default_socket_options(socket_t sock) {
  10306. set_socket_opt(sock, SOL_SOCKET,
  10307. #ifdef SO_REUSEPORT
  10308. SO_REUSEPORT,
  10309. #else
  10310. SO_REUSEADDR,
  10311. #endif
  10312. 1);
  10313. }
  10314. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  10315. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  10316. sizeof(optval));
  10317. }
  10318. inline std::string get_bearer_token_auth(const Request &req) {
  10319. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  10320. // than the prefix carries no token.
  10321. constexpr const char bearer_prefix[] = "Bearer ";
  10322. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  10323. auto value = req.get_header_value("Authorization");
  10324. if (value.size() >= bearer_prefix_len &&
  10325. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  10326. bearer_prefix)) {
  10327. return value.substr(bearer_prefix_len);
  10328. }
  10329. return "";
  10330. }
  10331. inline const char *status_message(int status) {
  10332. switch (status) {
  10333. case StatusCode::Continue_100: return "Continue";
  10334. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  10335. case StatusCode::Processing_102: return "Processing";
  10336. case StatusCode::EarlyHints_103: return "Early Hints";
  10337. case StatusCode::OK_200: return "OK";
  10338. case StatusCode::Created_201: return "Created";
  10339. case StatusCode::Accepted_202: return "Accepted";
  10340. case StatusCode::NonAuthoritativeInformation_203:
  10341. return "Non-Authoritative Information";
  10342. case StatusCode::NoContent_204: return "No Content";
  10343. case StatusCode::ResetContent_205: return "Reset Content";
  10344. case StatusCode::PartialContent_206: return "Partial Content";
  10345. case StatusCode::MultiStatus_207: return "Multi-Status";
  10346. case StatusCode::AlreadyReported_208: return "Already Reported";
  10347. case StatusCode::IMUsed_226: return "IM Used";
  10348. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  10349. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  10350. case StatusCode::Found_302: return "Found";
  10351. case StatusCode::SeeOther_303: return "See Other";
  10352. case StatusCode::NotModified_304: return "Not Modified";
  10353. case StatusCode::UseProxy_305: return "Use Proxy";
  10354. case StatusCode::unused_306: return "unused";
  10355. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  10356. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  10357. case StatusCode::BadRequest_400: return "Bad Request";
  10358. case StatusCode::Unauthorized_401: return "Unauthorized";
  10359. case StatusCode::PaymentRequired_402: return "Payment Required";
  10360. case StatusCode::Forbidden_403: return "Forbidden";
  10361. case StatusCode::NotFound_404: return "Not Found";
  10362. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  10363. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  10364. case StatusCode::ProxyAuthenticationRequired_407:
  10365. return "Proxy Authentication Required";
  10366. case StatusCode::RequestTimeout_408: return "Request Timeout";
  10367. case StatusCode::Conflict_409: return "Conflict";
  10368. case StatusCode::Gone_410: return "Gone";
  10369. case StatusCode::LengthRequired_411: return "Length Required";
  10370. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  10371. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  10372. case StatusCode::UriTooLong_414: return "URI Too Long";
  10373. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  10374. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  10375. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  10376. case StatusCode::ImATeapot_418: return "I'm a teapot";
  10377. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  10378. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  10379. case StatusCode::Locked_423: return "Locked";
  10380. case StatusCode::FailedDependency_424: return "Failed Dependency";
  10381. case StatusCode::TooEarly_425: return "Too Early";
  10382. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  10383. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  10384. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  10385. case StatusCode::RequestHeaderFieldsTooLarge_431:
  10386. return "Request Header Fields Too Large";
  10387. case StatusCode::UnavailableForLegalReasons_451:
  10388. return "Unavailable For Legal Reasons";
  10389. case StatusCode::NotImplemented_501: return "Not Implemented";
  10390. case StatusCode::BadGateway_502: return "Bad Gateway";
  10391. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  10392. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  10393. case StatusCode::HttpVersionNotSupported_505:
  10394. return "HTTP Version Not Supported";
  10395. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  10396. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  10397. case StatusCode::LoopDetected_508: return "Loop Detected";
  10398. case StatusCode::NotExtended_510: return "Not Extended";
  10399. case StatusCode::NetworkAuthenticationRequired_511:
  10400. return "Network Authentication Required";
  10401. default:
  10402. case StatusCode::InternalServerError_500: return "Internal Server Error";
  10403. }
  10404. }
  10405. inline std::string to_string(const Error error) {
  10406. switch (error) {
  10407. case Error::Success: return "Success (no error)";
  10408. case Error::Unknown: return "Unknown";
  10409. case Error::Connection: return "Could not establish connection";
  10410. case Error::BindIPAddress: return "Failed to bind IP address";
  10411. case Error::Read: return "Failed to read connection";
  10412. case Error::Write: return "Failed to write connection";
  10413. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  10414. case Error::Canceled: return "Connection handling canceled";
  10415. case Error::SSLConnection: return "SSL connection failed";
  10416. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  10417. case Error::SSLServerVerification: return "SSL server verification failed";
  10418. case Error::SSLServerHostnameVerification:
  10419. return "SSL server hostname verification failed";
  10420. case Error::UnsupportedMultipartBoundaryChars:
  10421. return "Unsupported HTTP multipart boundary characters";
  10422. case Error::Compression: return "Compression failed";
  10423. case Error::ConnectionTimeout: return "Connection timed out";
  10424. case Error::ProxyConnection: return "Proxy connection failed";
  10425. case Error::ConnectionClosed: return "Connection closed by server";
  10426. case Error::Timeout: return "Read timeout";
  10427. case Error::ResourceExhaustion: return "Resource exhaustion";
  10428. case Error::TooManyFormDataFiles: return "Too many form data files";
  10429. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  10430. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  10431. case Error::ExceedMaxSocketDescriptorCount:
  10432. return "Exceeded maximum socket descriptor count";
  10433. case Error::InvalidRequestLine: return "Invalid request line";
  10434. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  10435. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  10436. case Error::InvalidHeaders: return "Invalid headers";
  10437. case Error::MultipartParsing: return "Multipart parsing failed";
  10438. case Error::OpenFile: return "Failed to open file";
  10439. case Error::Listen: return "Failed to listen on socket";
  10440. case Error::GetSockName: return "Failed to get socket name";
  10441. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  10442. case Error::HTTPParsing: return "HTTP parsing failed";
  10443. case Error::InvalidRangeHeader: return "Invalid Range header";
  10444. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  10445. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  10446. case Error::UserCallbackException: return "User callback threw an exception";
  10447. default: break;
  10448. }
  10449. return "Invalid";
  10450. }
  10451. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  10452. os << to_string(obj);
  10453. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  10454. return os;
  10455. }
  10456. inline std::string hosted_at(const std::string &hostname) {
  10457. std::vector<std::string> addrs;
  10458. hosted_at(hostname, addrs);
  10459. if (addrs.empty()) { return std::string(); }
  10460. return addrs[0];
  10461. }
  10462. inline void hosted_at(const std::string &hostname,
  10463. std::vector<std::string> &addrs) {
  10464. struct addrinfo hints;
  10465. struct addrinfo *result;
  10466. memset(&hints, 0, sizeof(struct addrinfo));
  10467. hints.ai_family = AF_UNSPEC;
  10468. hints.ai_socktype = SOCK_STREAM;
  10469. hints.ai_protocol = 0;
  10470. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  10471. &result, 0)) {
  10472. #if defined __linux__ && !defined __ANDROID__
  10473. res_init();
  10474. #endif
  10475. return;
  10476. }
  10477. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  10478. for (auto rp = result; rp; rp = rp->ai_next) {
  10479. const auto &addr =
  10480. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  10481. std::string ip;
  10482. auto dummy = -1;
  10483. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  10484. dummy)) {
  10485. addrs.emplace_back(std::move(ip));
  10486. }
  10487. }
  10488. }
  10489. inline std::string encode_uri_component(const std::string &value) {
  10490. std::ostringstream escaped;
  10491. escaped.fill('0');
  10492. escaped << std::hex;
  10493. for (auto c : value) {
  10494. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  10495. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  10496. escaped << c;
  10497. } else {
  10498. escaped << std::uppercase;
  10499. escaped << '%' << std::setw(2)
  10500. << static_cast<int>(static_cast<unsigned char>(c));
  10501. escaped << std::nouppercase;
  10502. }
  10503. }
  10504. return escaped.str();
  10505. }
  10506. inline std::string encode_uri(const std::string &value) {
  10507. std::ostringstream escaped;
  10508. escaped.fill('0');
  10509. escaped << std::hex;
  10510. for (auto c : value) {
  10511. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  10512. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  10513. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  10514. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  10515. escaped << c;
  10516. } else {
  10517. escaped << std::uppercase;
  10518. escaped << '%' << std::setw(2)
  10519. << static_cast<int>(static_cast<unsigned char>(c));
  10520. escaped << std::nouppercase;
  10521. }
  10522. }
  10523. return escaped.str();
  10524. }
  10525. inline std::string decode_uri_component(const std::string &value) {
  10526. std::string result;
  10527. for (size_t i = 0; i < value.size(); i++) {
  10528. if (value[i] == '%' && i + 2 < value.size()) {
  10529. auto val = 0;
  10530. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  10531. result += static_cast<char>(val);
  10532. i += 2;
  10533. } else {
  10534. result += value[i];
  10535. }
  10536. } else {
  10537. result += value[i];
  10538. }
  10539. }
  10540. return result;
  10541. }
  10542. inline std::string decode_uri(const std::string &value) {
  10543. std::string result;
  10544. for (size_t i = 0; i < value.size(); i++) {
  10545. if (value[i] == '%' && i + 2 < value.size()) {
  10546. auto val = 0;
  10547. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  10548. auto c = static_cast<char>(val);
  10549. // Keep escapes of the reserved characters that encode_uri leaves
  10550. // literal, so decode_uri is the inverse of encode_uri and an escaped
  10551. // delimiter is not promoted into a real one (as with JS decodeURI).
  10552. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  10553. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  10554. c == '#') {
  10555. result += value[i];
  10556. result += value[i + 1];
  10557. result += value[i + 2];
  10558. } else {
  10559. result += c;
  10560. }
  10561. i += 2;
  10562. } else {
  10563. result += value[i];
  10564. }
  10565. } else {
  10566. result += value[i];
  10567. }
  10568. }
  10569. return result;
  10570. }
  10571. inline std::string encode_path_component(const std::string &component) {
  10572. std::string result;
  10573. result.reserve(component.size() * 3);
  10574. for (size_t i = 0; i < component.size(); i++) {
  10575. auto c = static_cast<unsigned char>(component[i]);
  10576. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  10577. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10578. c == '_' || c == '~') {
  10579. result += static_cast<char>(c);
  10580. }
  10581. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  10582. // "," / ";" / "="
  10583. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  10584. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  10585. c == '=') {
  10586. result += static_cast<char>(c);
  10587. }
  10588. // Colon is allowed in path segments except first segment
  10589. else if (c == ':') {
  10590. result += static_cast<char>(c);
  10591. }
  10592. // @ is allowed in path
  10593. else if (c == '@') {
  10594. result += static_cast<char>(c);
  10595. } else {
  10596. result += '%';
  10597. char hex[3];
  10598. snprintf(hex, sizeof(hex), "%02X", c);
  10599. result.append(hex, 2);
  10600. }
  10601. }
  10602. return result;
  10603. }
  10604. inline std::string decode_path_component(const std::string &component) {
  10605. std::string result;
  10606. result.reserve(component.size());
  10607. for (size_t i = 0; i < component.size(); i++) {
  10608. if (component[i] == '%' && i + 1 < component.size()) {
  10609. if (component[i + 1] == 'u') {
  10610. // Unicode %uXXXX encoding
  10611. auto val = 0;
  10612. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  10613. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  10614. char buff[4];
  10615. size_t len = 0;
  10616. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  10617. (len = detail::to_utf8(val, buff)) > 0) {
  10618. result.append(buff, len);
  10619. i += 5; // 'u0000'
  10620. } else {
  10621. // Not 4 hex digits, or a surrogate, which is no character: the
  10622. // escape is kept as it is rather than joining its neighbours
  10623. result += component[i];
  10624. }
  10625. } else {
  10626. // Standard %XX encoding
  10627. auto val = 0;
  10628. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10629. // 2 digits hex codes
  10630. result += static_cast<char>(val);
  10631. i += 2; // 'XX'
  10632. } else {
  10633. result += component[i];
  10634. }
  10635. }
  10636. } else {
  10637. result += component[i];
  10638. }
  10639. }
  10640. return result;
  10641. }
  10642. inline std::string encode_query_component(const std::string &component,
  10643. bool space_as_plus) {
  10644. std::string result;
  10645. result.reserve(component.size() * 3);
  10646. for (size_t i = 0; i < component.size(); i++) {
  10647. auto c = static_cast<unsigned char>(component[i]);
  10648. // Unreserved characters per RFC 3986
  10649. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10650. c == '_' || c == '~') {
  10651. result += static_cast<char>(c);
  10652. }
  10653. // Space handling
  10654. else if (c == ' ') {
  10655. if (space_as_plus) {
  10656. result += '+';
  10657. } else {
  10658. result += "%20";
  10659. }
  10660. }
  10661. // Plus sign handling
  10662. else if (c == '+') {
  10663. if (space_as_plus) {
  10664. result += "%2B";
  10665. } else {
  10666. result += static_cast<char>(c);
  10667. }
  10668. }
  10669. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  10670. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  10671. c == '*' || c == ',' || c == ';') {
  10672. result += static_cast<char>(c);
  10673. }
  10674. // Colon and @ are allowed in query
  10675. else if (c == ':' || c == '@') {
  10676. result += static_cast<char>(c);
  10677. }
  10678. // Forward slash is allowed in query values
  10679. else if (c == '/') {
  10680. result += static_cast<char>(c);
  10681. }
  10682. // Question mark is allowed in query values (after first ?)
  10683. else if (c == '?') {
  10684. result += static_cast<char>(c);
  10685. } else {
  10686. result += '%';
  10687. char hex[3];
  10688. snprintf(hex, sizeof(hex), "%02X", c);
  10689. result.append(hex, 2);
  10690. }
  10691. }
  10692. return result;
  10693. }
  10694. inline std::string decode_query_component(const std::string &component,
  10695. bool plus_as_space) {
  10696. std::string result;
  10697. result.reserve(component.size());
  10698. for (size_t i = 0; i < component.size(); i++) {
  10699. if (component[i] == '%' && i + 2 < component.size()) {
  10700. auto val = 0;
  10701. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10702. result += static_cast<char>(val);
  10703. i += 2;
  10704. } else {
  10705. result += component[i];
  10706. }
  10707. } else if (component[i] == '+' && plus_as_space) {
  10708. result += ' '; // + becomes space in form-urlencoded
  10709. } else {
  10710. result += component[i];
  10711. }
  10712. }
  10713. return result;
  10714. }
  10715. inline std::string sanitize_filename(const std::string &filename) {
  10716. // Extract basename: find the last path separator (/ or \) and, on Windows,
  10717. // ':', which ends a drive prefix ("C:..") or names an NTFS stream ("a:b")
  10718. #ifdef _WIN32
  10719. auto pos = filename.find_last_of("/\\:");
  10720. #else
  10721. auto pos = filename.find_last_of("/\\");
  10722. #endif
  10723. auto result =
  10724. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10725. // Strip null bytes
  10726. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10727. // Trim whitespace
  10728. {
  10729. auto start = result.find_first_not_of(" \t");
  10730. auto end = result.find_last_not_of(" \t");
  10731. result = (start == std::string::npos)
  10732. ? ""
  10733. : result.substr(start, end - start + 1);
  10734. }
  10735. // Reject . and ..
  10736. if (result == "." || result == "..") { return ""; }
  10737. return result;
  10738. }
  10739. inline std::string append_query_params(const std::string &path,
  10740. const Params &params) {
  10741. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10742. auto fragment_pos = path.find('#');
  10743. auto path_with_query = path.substr(0, fragment_pos);
  10744. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10745. path_with_query += detail::params_to_query_str(params);
  10746. if (fragment_pos != std::string::npos) {
  10747. path_with_query.append(path, fragment_pos, std::string::npos);
  10748. }
  10749. return path_with_query;
  10750. }
  10751. // Header utilities
  10752. inline std::pair<std::string, std::string>
  10753. make_range_header(const Ranges &ranges) {
  10754. std::string field = "bytes=";
  10755. auto i = 0;
  10756. for (const auto &r : ranges) {
  10757. if (i != 0) { field += ", "; }
  10758. if (r.first != -1) { field += std::to_string(r.first); }
  10759. field += '-';
  10760. if (r.second != -1) { field += std::to_string(r.second); }
  10761. i++;
  10762. }
  10763. return std::make_pair("Range", std::move(field));
  10764. }
  10765. inline std::pair<std::string, std::string>
  10766. make_basic_authentication_header(const std::string &username,
  10767. const std::string &password, bool is_proxy) {
  10768. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10769. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10770. return std::make_pair(key, std::move(field));
  10771. }
  10772. inline std::pair<std::string, std::string>
  10773. make_bearer_token_authentication_header(const std::string &token,
  10774. bool is_proxy = false) {
  10775. auto field = "Bearer " + token;
  10776. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10777. return std::make_pair(key, std::move(field));
  10778. }
  10779. namespace detail {
  10780. // Basic auth when a username or password is set, otherwise a bearer token,
  10781. // unless the request already carries the header.
  10782. inline void add_authorization_header(Request &req, const std::string &username,
  10783. const std::string &password,
  10784. const std::string &token, bool is_proxy) {
  10785. if (req.has_header(is_proxy ? "Proxy-Authorization" : "Authorization")) {
  10786. return;
  10787. }
  10788. if (!username.empty() || !password.empty()) {
  10789. req.headers.insert(
  10790. make_basic_authentication_header(username, password, is_proxy));
  10791. } else if (!token.empty()) {
  10792. req.headers.insert(
  10793. make_bearer_token_authentication_header(token, is_proxy));
  10794. }
  10795. }
  10796. } // namespace detail
  10797. // Request implementation
  10798. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10799. size_t id) const {
  10800. return detail::get_header_value_u64(headers, key, def, id);
  10801. }
  10802. inline bool Request::has_header(const std::string &key) const {
  10803. return detail::has_header(headers, key);
  10804. }
  10805. inline std::string Request::get_header_value(const std::string &key,
  10806. const char *def, size_t id) const {
  10807. return detail::get_header_value(headers, key, def, id);
  10808. }
  10809. inline size_t Request::get_header_value_count(const std::string &key) const {
  10810. return detail::get_header_value_count(headers, key);
  10811. }
  10812. inline void Request::set_header(const std::string &key,
  10813. const std::string &val) {
  10814. detail::set_header(headers, key, val);
  10815. }
  10816. inline bool Request::has_trailer(const std::string &key) const {
  10817. return trailers.find(key) != trailers.end();
  10818. }
  10819. inline std::string Request::get_trailer_value(const std::string &key,
  10820. size_t id) const {
  10821. return detail::get_multimap_value(trailers, key, id);
  10822. }
  10823. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10824. return trailers.count(key);
  10825. }
  10826. inline bool Request::has_param(const std::string &key) const {
  10827. return params.find(key) != params.end();
  10828. }
  10829. inline std::string Request::get_param_value(const std::string &key,
  10830. size_t id) const {
  10831. return detail::get_multimap_value(params, key, id);
  10832. }
  10833. inline std::vector<std::string>
  10834. Request::get_param_values(const std::string &key) const {
  10835. auto rng = params.equal_range(key);
  10836. std::vector<std::string> values;
  10837. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10838. for (auto it = rng.first; it != rng.second; ++it) {
  10839. values.push_back(it->second);
  10840. }
  10841. return values;
  10842. }
  10843. inline size_t Request::get_param_value_count(const std::string &key) const {
  10844. return params.count(key);
  10845. }
  10846. inline bool Request::is_multipart_form_data() const {
  10847. const auto &content_type = get_header_value("Content-Type");
  10848. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10849. "multipart/form-data");
  10850. }
  10851. // Multipart FormData implementation
  10852. inline std::string MultipartFormData::get_field(const std::string &key,
  10853. size_t id) const {
  10854. auto rng = fields.equal_range(key);
  10855. auto it = detail::bounded_next(rng.first, id, rng.second);
  10856. if (it != rng.second) { return it->second.content; }
  10857. return std::string();
  10858. }
  10859. inline std::vector<std::string>
  10860. MultipartFormData::get_fields(const std::string &key) const {
  10861. std::vector<std::string> values;
  10862. auto rng = fields.equal_range(key);
  10863. for (auto it = rng.first; it != rng.second; it++) {
  10864. values.push_back(it->second.content);
  10865. }
  10866. return values;
  10867. }
  10868. inline bool MultipartFormData::has_field(const std::string &key) const {
  10869. return fields.find(key) != fields.end();
  10870. }
  10871. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10872. return fields.count(key);
  10873. }
  10874. inline FormData MultipartFormData::get_file(const std::string &key,
  10875. size_t id) const {
  10876. return detail::get_multimap_value(files, key, id);
  10877. }
  10878. inline std::vector<FormData>
  10879. MultipartFormData::get_files(const std::string &key) const {
  10880. std::vector<FormData> values;
  10881. auto rng = files.equal_range(key);
  10882. for (auto it = rng.first; it != rng.second; it++) {
  10883. values.push_back(it->second);
  10884. }
  10885. return values;
  10886. }
  10887. inline bool MultipartFormData::has_file(const std::string &key) const {
  10888. return files.find(key) != files.end();
  10889. }
  10890. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10891. return files.count(key);
  10892. }
  10893. // Multipart FormData writer implementation
  10894. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10895. return detail::is_multipart_boundary_chars_valid(boundary);
  10896. }
  10897. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10898. : boundary_(detail::make_multipart_data_boundary()) {}
  10899. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10900. : boundary_(std::move(boundary)) {}
  10901. inline const std::string &MultipartFormDataWriter::boundary() const {
  10902. return boundary_;
  10903. }
  10904. inline std::string MultipartFormDataWriter::content_type() const {
  10905. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10906. }
  10907. inline std::string
  10908. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10909. return detail::serialize_multipart_formdata(items, boundary_);
  10910. }
  10911. inline size_t MultipartFormDataWriter::content_length(
  10912. const UploadFormDataItems &items) const {
  10913. return detail::get_multipart_content_length(items, boundary_);
  10914. }
  10915. inline std::string
  10916. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10917. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10918. }
  10919. inline std::string MultipartFormDataWriter::item_end() {
  10920. return detail::serialize_multipart_formdata_item_end();
  10921. }
  10922. inline std::string MultipartFormDataWriter::finish() const {
  10923. return detail::serialize_multipart_formdata_finish(boundary_);
  10924. }
  10925. // Response implementation
  10926. namespace detail {
  10927. // A response has one content source: `body`, a content provider, or a file.
  10928. // Each content setter calls this so that the one called last wins.
  10929. inline void clear_content_provider(Response &res) {
  10930. auto releaser = std::move(res.content_provider_resource_releaser_);
  10931. auto success = res.content_provider_success_;
  10932. res.content_length_ = 0;
  10933. res.content_provider_ = nullptr;
  10934. res.content_provider_resource_releaser_ = nullptr;
  10935. res.is_chunked_content_provider_ = false;
  10936. res.is_file_content_provider_ = false;
  10937. res.content_provider_success_ = false;
  10938. res.content_coding_ = EncodingType::None;
  10939. res.file_content_path_.clear();
  10940. res.file_content_content_type_.clear();
  10941. if (releaser) { releaser(success); }
  10942. }
  10943. inline void clear_content(Response &res) {
  10944. res.body.clear();
  10945. clear_content_provider(res);
  10946. }
  10947. // The Content-Type of the old content goes with it.
  10948. inline void set_content_type(Response &res, const std::string &content_type) {
  10949. res.headers.erase("Content-Type");
  10950. res.set_header("Content-Type", content_type);
  10951. }
  10952. // `body` is public, so it can be assigned directly after a provider or a file
  10953. // was set. It came last, so it wins.
  10954. inline void prefer_assigned_body(Response &res) {
  10955. if (!res.body.empty() &&
  10956. (res.content_provider_ || !res.file_content_path_.empty())) {
  10957. clear_content_provider(res);
  10958. }
  10959. }
  10960. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10961. inline bool body_allowed_for_status(int status) {
  10962. return status >= 200 && status != StatusCode::NoContent_204 &&
  10963. status != StatusCode::NotModified_304;
  10964. }
  10965. // Only a 206 response is served as a partial representation. range_error()
  10966. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10967. // status would start from an unchecked offset.
  10968. inline bool is_partial_content(const Request &req, const Response &res) {
  10969. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10970. }
  10971. // Sets the Content-Length or Transfer-Encoding framing the body that
  10972. // Server::write_response_core() writes, or closes the connection after a body
  10973. // that has neither. Only the library sets them: one from a handler would go
  10974. // out next to it, or describe some other body.
  10975. inline void set_framing_headers(const Request &req, Response &res,
  10976. const std::string &boundary,
  10977. const std::string &content_type) {
  10978. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10979. auto head_length = req.method == "HEAD"
  10980. ? res.get_header_value("Content-Length")
  10981. : std::string();
  10982. res.headers.erase("Content-Length");
  10983. res.headers.erase("Transfer-Encoding");
  10984. if (!body_allowed_for_status(res.status)) { return; }
  10985. if (res.content_provider_) {
  10986. if (res.content_length_ == 0) {
  10987. if (res.is_chunked_content_provider_) {
  10988. res.set_header("Transfer-Encoding", "chunked");
  10989. } else if (req.method != "HEAD") {
  10990. // RFC 9112 6.3: a body with neither ends where the connection does.
  10991. res.headers.erase("Keep-Alive");
  10992. if (!has_header_token(res.headers, "Connection", "close")) {
  10993. res.set_header("Connection", "close");
  10994. }
  10995. }
  10996. return;
  10997. }
  10998. // The part Server::write_content_with_provider() writes.
  10999. auto length = res.content_length_;
  11000. if (is_partial_content(req, res)) {
  11001. length = req.ranges.size() == 1
  11002. ? get_range_offset_and_length(req.ranges[0], length).second
  11003. : get_multipart_ranges_data_length(req, boundary,
  11004. content_type, length);
  11005. }
  11006. res.set_header("Content-Length", std::to_string(length));
  11007. } else if (!res.body.empty()) {
  11008. res.set_header("Content-Length", std::to_string(res.body.size()));
  11009. } else {
  11010. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  11011. }
  11012. }
  11013. } // namespace detail
  11014. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  11015. size_t id) const {
  11016. return detail::get_header_value_u64(headers, key, def, id);
  11017. }
  11018. inline bool Response::has_header(const std::string &key) const {
  11019. return headers.find(key) != headers.end();
  11020. }
  11021. inline std::string Response::get_header_value(const std::string &key,
  11022. const char *def,
  11023. size_t id) const {
  11024. return detail::get_header_value(headers, key, def, id);
  11025. }
  11026. inline size_t Response::get_header_value_count(const std::string &key) const {
  11027. return detail::get_header_value_count(headers, key);
  11028. }
  11029. inline void Response::set_header(const std::string &key,
  11030. const std::string &val) {
  11031. detail::set_header(headers, key, val);
  11032. }
  11033. inline bool Response::has_trailer(const std::string &key) const {
  11034. return trailers.find(key) != trailers.end();
  11035. }
  11036. inline std::string Response::get_trailer_value(const std::string &key,
  11037. size_t id) const {
  11038. return detail::get_multimap_value(trailers, key, id);
  11039. }
  11040. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  11041. return trailers.count(key);
  11042. }
  11043. inline void Response::set_redirect(const std::string &url, int stat) {
  11044. if (detail::fields::is_field_value(url)) {
  11045. set_header("Location", url);
  11046. if (300 <= stat && stat < 400) {
  11047. this->status = stat;
  11048. } else {
  11049. this->status = StatusCode::Found_302;
  11050. }
  11051. }
  11052. }
  11053. inline void Response::set_content(const char *s, size_t n,
  11054. const std::string &content_type) {
  11055. body.assign(s, n); // Before the releaser runs; it may own `s`.
  11056. detail::clear_content_provider(*this);
  11057. detail::set_content_type(*this, content_type);
  11058. }
  11059. inline void Response::set_content(const std::string &s,
  11060. const std::string &content_type) {
  11061. set_content(s.data(), s.size(), content_type);
  11062. }
  11063. inline void Response::set_content(std::string &&s,
  11064. const std::string &content_type) {
  11065. body = std::move(s);
  11066. detail::clear_content_provider(*this);
  11067. detail::set_content_type(*this, content_type);
  11068. }
  11069. inline void Response::set_content_provider(
  11070. size_t in_length, const std::string &content_type, ContentProvider provider,
  11071. ContentProviderResourceReleaser resource_releaser) {
  11072. detail::clear_content(*this);
  11073. detail::set_content_type(*this, content_type);
  11074. content_length_ = in_length;
  11075. if (in_length > 0) { content_provider_ = std::move(provider); }
  11076. content_provider_resource_releaser_ = std::move(resource_releaser);
  11077. }
  11078. inline void Response::set_content_provider(
  11079. const std::string &content_type, ContentProviderWithoutLength provider,
  11080. ContentProviderResourceReleaser resource_releaser) {
  11081. detail::clear_content(*this);
  11082. detail::set_content_type(*this, content_type);
  11083. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  11084. content_provider_resource_releaser_ = std::move(resource_releaser);
  11085. }
  11086. inline void Response::set_chunked_content_provider(
  11087. const std::string &content_type, ContentProviderWithoutLength provider,
  11088. ContentProviderResourceReleaser resource_releaser) {
  11089. set_content_provider(content_type, std::move(provider),
  11090. std::move(resource_releaser));
  11091. is_chunked_content_provider_ = true;
  11092. }
  11093. inline void Response::set_file_content(const std::string &path,
  11094. const std::string &content_type) {
  11095. detail::clear_content(*this);
  11096. headers.erase("Content-Type");
  11097. file_content_path_ = path;
  11098. file_content_content_type_ = content_type;
  11099. }
  11100. inline void Response::set_file_content(const std::string &path) {
  11101. set_file_content(path, std::string());
  11102. }
  11103. // Result implementation
  11104. inline size_t Result::get_request_header_value_u64(const std::string &key,
  11105. size_t def,
  11106. size_t id) const {
  11107. return detail::get_header_value_u64(request_headers_, key, def, id);
  11108. }
  11109. inline bool Result::has_request_header(const std::string &key) const {
  11110. return request_headers_.find(key) != request_headers_.end();
  11111. }
  11112. inline std::string Result::get_request_header_value(const std::string &key,
  11113. const char *def,
  11114. size_t id) const {
  11115. return detail::get_header_value(request_headers_, key, def, id);
  11116. }
  11117. inline size_t
  11118. Result::get_request_header_value_count(const std::string &key) const {
  11119. return request_headers_.count(key);
  11120. }
  11121. // Stream implementation
  11122. inline ssize_t Stream::write(const char *ptr) {
  11123. return write(ptr, strlen(ptr));
  11124. }
  11125. inline ssize_t Stream::write(const std::string &s) {
  11126. return write(s.data(), s.size());
  11127. }
  11128. // BodyReader implementation
  11129. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  11130. if (!stream) {
  11131. last_error = Error::Connection;
  11132. return -1;
  11133. }
  11134. if (eof) { return 0; }
  11135. if (!chunked) {
  11136. // Content-Length based reading
  11137. if (has_content_length && bytes_read >= content_length) {
  11138. eof = true;
  11139. return 0;
  11140. }
  11141. auto to_read = len;
  11142. if (has_content_length) {
  11143. auto remaining = content_length - bytes_read;
  11144. to_read = (std::min)(len, remaining);
  11145. }
  11146. auto n = stream->read(buf, to_read);
  11147. // Without Content-Length the body ends when the connection closes
  11148. // (RFC 9112 §6.3); with one, an EOF here came too early
  11149. if (n < 0 || (n == 0 && has_content_length)) {
  11150. last_error = stream->get_error();
  11151. if (last_error == Error::Success) { last_error = Error::Read; }
  11152. }
  11153. if (n <= 0) {
  11154. eof = true;
  11155. return n;
  11156. }
  11157. bytes_read += static_cast<size_t>(n);
  11158. if (has_content_length && bytes_read >= content_length) { eof = true; }
  11159. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  11160. last_error = Error::ExceedMaxPayloadSize;
  11161. eof = true;
  11162. return -1;
  11163. }
  11164. return n;
  11165. }
  11166. // Chunked transfer encoding: delegate to shared decoder instance.
  11167. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  11168. size_t chunk_offset = 0;
  11169. size_t chunk_total = 0;
  11170. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  11171. if (n < 0) {
  11172. last_error = stream->get_error();
  11173. if (last_error == Error::Success) { last_error = Error::Read; }
  11174. eof = true;
  11175. return n;
  11176. }
  11177. if (n == 0) {
  11178. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  11179. eof = true;
  11180. return 0;
  11181. }
  11182. bytes_read += static_cast<size_t>(n);
  11183. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  11184. last_error = Error::ExceedMaxPayloadSize;
  11185. eof = true;
  11186. return -1;
  11187. }
  11188. return n;
  11189. }
  11190. // ThreadPool implementation
  11191. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  11192. time_t idle_timeout_sec)
  11193. : base_thread_count_(n), max_queued_requests_(mqr),
  11194. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  11195. shutdown_(false) {
  11196. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11197. if (max_n != 0 && max_n < n) {
  11198. std::string msg = "max_threads must be >= base_threads";
  11199. throw std::invalid_argument(msg);
  11200. }
  11201. #endif
  11202. max_thread_count_ = max_n == 0 ? n : max_n;
  11203. threads_.reserve(base_thread_count_);
  11204. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11205. try {
  11206. #endif
  11207. for (size_t i = 0; i < base_thread_count_; i++) {
  11208. threads_.emplace_back(std::thread([this]() { worker(false); }));
  11209. }
  11210. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11211. } catch (...) {
  11212. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  11213. // signal the workers we already spawned to exit and join them so the
  11214. // vector destructor does not see joinable threads (which would call
  11215. // std::terminate). Then rethrow so the caller learns of the failure.
  11216. {
  11217. std::unique_lock<std::mutex> lock(mutex_);
  11218. shutdown_ = true;
  11219. }
  11220. cond_.notify_all();
  11221. for (auto &t : threads_) {
  11222. if (t.joinable()) { t.join(); }
  11223. }
  11224. throw;
  11225. }
  11226. #endif
  11227. }
  11228. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  11229. {
  11230. std::unique_lock<std::mutex> lock(mutex_);
  11231. if (shutdown_) { return false; }
  11232. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  11233. return false;
  11234. }
  11235. jobs_.push_back(std::move(fn));
  11236. // Spawn a dynamic thread if jobs outnumber idle threads and under max
  11237. if (jobs_.size() > idle_thread_count_ &&
  11238. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  11239. cleanup_finished_threads();
  11240. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11241. try {
  11242. #endif
  11243. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  11244. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11245. } catch (const std::system_error &) {
  11246. // No thread budget left: keep the job queued for an existing worker
  11247. // instead of letting the exception escape the accept loop.
  11248. }
  11249. #endif
  11250. }
  11251. }
  11252. cond_.notify_one();
  11253. return true;
  11254. }
  11255. inline void ThreadPool::shutdown() {
  11256. {
  11257. std::unique_lock<std::mutex> lock(mutex_);
  11258. shutdown_ = true;
  11259. }
  11260. cond_.notify_all();
  11261. for (auto &t : threads_) {
  11262. if (t.joinable()) { t.join(); }
  11263. }
  11264. // Move dynamic_threads_ to a local list under the lock to avoid racing
  11265. // with worker threads that call move_to_finished() concurrently.
  11266. std::list<std::thread> remaining_dynamic;
  11267. {
  11268. std::unique_lock<std::mutex> lock(mutex_);
  11269. remaining_dynamic = std::move(dynamic_threads_);
  11270. }
  11271. for (auto &t : remaining_dynamic) {
  11272. if (t.joinable()) { t.join(); }
  11273. }
  11274. std::unique_lock<std::mutex> lock(mutex_);
  11275. cleanup_finished_threads();
  11276. }
  11277. inline void ThreadPool::move_to_finished(std::thread::id id) {
  11278. // Must be called with mutex_ held
  11279. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  11280. if (it->get_id() == id) {
  11281. finished_threads_.push_back(std::move(*it));
  11282. dynamic_threads_.erase(it);
  11283. return;
  11284. }
  11285. }
  11286. }
  11287. inline void ThreadPool::cleanup_finished_threads() {
  11288. // Must be called with mutex_ held
  11289. for (auto &t : finished_threads_) {
  11290. if (t.joinable()) { t.join(); }
  11291. }
  11292. finished_threads_.clear();
  11293. }
  11294. inline void ThreadPool::worker(bool is_dynamic) {
  11295. for (;;) {
  11296. std::function<void()> fn;
  11297. {
  11298. std::unique_lock<std::mutex> lock(mutex_);
  11299. idle_thread_count_++;
  11300. if (is_dynamic) {
  11301. auto has_work =
  11302. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  11303. [&] { return !jobs_.empty() || shutdown_; });
  11304. if (!has_work) {
  11305. // Timed out with no work - exit this dynamic thread
  11306. idle_thread_count_--;
  11307. move_to_finished(std::this_thread::get_id());
  11308. break;
  11309. }
  11310. } else {
  11311. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  11312. }
  11313. idle_thread_count_--;
  11314. if (shutdown_ && jobs_.empty()) { break; }
  11315. fn = std::move(jobs_.front());
  11316. jobs_.pop_front();
  11317. }
  11318. assert(true == static_cast<bool>(fn));
  11319. fn();
  11320. }
  11321. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  11322. !defined(LIBRESSL_VERSION_NUMBER)
  11323. OPENSSL_thread_stop();
  11324. #endif
  11325. }
  11326. /*
  11327. * Group 1 (continued): detail namespace - Stream implementations
  11328. */
  11329. namespace detail {
  11330. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  11331. time_t timeout_sec, time_t timeout_usec,
  11332. time_t &actual_timeout_sec,
  11333. time_t &actual_timeout_usec) {
  11334. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  11335. auto actual_timeout_msec =
  11336. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  11337. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  11338. actual_timeout_sec = actual_timeout_msec / 1000;
  11339. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  11340. }
  11341. // Socket stream implementation
  11342. inline SocketStream::SocketStream(
  11343. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  11344. time_t write_timeout_sec, time_t write_timeout_usec,
  11345. time_t max_timeout_msec,
  11346. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11347. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  11348. read_timeout_usec_(read_timeout_usec),
  11349. write_timeout_sec_(write_timeout_sec),
  11350. write_timeout_usec_(write_timeout_usec),
  11351. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  11352. read_buff_(read_buff_size_, 0) {}
  11353. inline SocketStream::~SocketStream() = default;
  11354. inline bool SocketStream::is_readable() const {
  11355. return read_buff_off_ < read_buff_content_size_;
  11356. }
  11357. inline bool SocketStream::wait_readable() const {
  11358. if (max_timeout_msec_ <= 0) {
  11359. return select_read_interruptible(sock_, read_timeout_sec_,
  11360. read_timeout_usec_, read_interrupted_) > 0;
  11361. }
  11362. time_t read_timeout_sec;
  11363. time_t read_timeout_usec;
  11364. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11365. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11366. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11367. read_interrupted_) > 0;
  11368. }
  11369. inline bool SocketStream::wait_writable() const {
  11370. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11371. }
  11372. inline bool SocketStream::ensure_readable() {
  11373. if (readable_hint_) {
  11374. readable_hint_ = false;
  11375. return true;
  11376. }
  11377. return wait_readable();
  11378. }
  11379. inline const char *SocketStream::buffered_data(size_t &size) const {
  11380. size = read_buff_content_size_ - read_buff_off_;
  11381. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  11382. }
  11383. inline void SocketStream::consume_buffered(size_t size) {
  11384. assert(size <= read_buff_content_size_ - read_buff_off_);
  11385. read_buff_off_ += size;
  11386. }
  11387. inline bool SocketStream::is_peer_alive() const {
  11388. return detail::is_socket_alive(sock_);
  11389. }
  11390. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  11391. #ifdef _WIN32
  11392. size =
  11393. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  11394. #else
  11395. size = (std::min)(size,
  11396. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  11397. #endif
  11398. if (read_buff_off_ < read_buff_content_size_) {
  11399. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  11400. if (size <= remaining_size) {
  11401. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  11402. read_buff_off_ += size;
  11403. return static_cast<ssize_t>(size);
  11404. } else {
  11405. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  11406. read_buff_off_ += remaining_size;
  11407. return static_cast<ssize_t>(remaining_size);
  11408. }
  11409. }
  11410. if (!ensure_readable()) {
  11411. error_ = Error::Timeout;
  11412. return -1;
  11413. }
  11414. read_buff_off_ = 0;
  11415. read_buff_content_size_ = 0;
  11416. if (size < read_buff_size_) {
  11417. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  11418. CPPHTTPLIB_RECV_FLAGS);
  11419. if (n <= 0) {
  11420. if (n == 0) {
  11421. error_ = Error::ConnectionClosed;
  11422. } else {
  11423. error_ = Error::Read;
  11424. }
  11425. return n;
  11426. } else if (n <= static_cast<ssize_t>(size)) {
  11427. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  11428. return n;
  11429. } else {
  11430. memcpy(ptr, read_buff_.data(), size);
  11431. read_buff_off_ = size;
  11432. read_buff_content_size_ = static_cast<size_t>(n);
  11433. return static_cast<ssize_t>(size);
  11434. }
  11435. } else {
  11436. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  11437. if (n <= 0) {
  11438. if (n == 0) {
  11439. error_ = Error::ConnectionClosed;
  11440. } else {
  11441. error_ = Error::Read;
  11442. }
  11443. }
  11444. return n;
  11445. }
  11446. }
  11447. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  11448. if (!wait_writable()) { return -1; }
  11449. // Winsock's send() takes an int length, even on 64-bit Windows
  11450. #ifdef _WIN32
  11451. size =
  11452. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  11453. #endif
  11454. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  11455. }
  11456. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  11457. int &port) const {
  11458. return detail::get_remote_ip_and_port(sock_, ip, port);
  11459. }
  11460. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  11461. int &port) const {
  11462. return detail::get_local_ip_and_port(sock_, ip, port);
  11463. }
  11464. inline socket_t SocketStream::socket() const { return sock_; }
  11465. inline time_t SocketStream::duration() const {
  11466. return static_cast<time_t>(
  11467. std::chrono::duration_cast<std::chrono::milliseconds>(
  11468. std::chrono::steady_clock::now() - start_time_)
  11469. .count());
  11470. }
  11471. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  11472. read_timeout_sec_ = sec;
  11473. read_timeout_usec_ = usec;
  11474. }
  11475. inline void SocketStream::set_max_timeout(time_t msec) {
  11476. max_timeout_msec_ = msec;
  11477. start_time_ = std::chrono::steady_clock::now();
  11478. }
  11479. inline void
  11480. SocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11481. read_interrupted_ = std::move(interrupted);
  11482. }
  11483. // Buffer stream implementation
  11484. inline bool BufferStream::is_readable() const { return true; }
  11485. inline bool BufferStream::wait_readable() const { return true; }
  11486. inline bool BufferStream::wait_writable() const { return true; }
  11487. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  11488. #if defined(_MSC_VER) && _MSC_VER < 1910
  11489. auto len_read = buffer._Copy_s(ptr, size, size, position);
  11490. #else
  11491. auto len_read = buffer.copy(ptr, size, position);
  11492. #endif
  11493. position += static_cast<size_t>(len_read);
  11494. return static_cast<ssize_t>(len_read);
  11495. }
  11496. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  11497. buffer.append(ptr, size);
  11498. return static_cast<ssize_t>(size);
  11499. }
  11500. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  11501. int & /*port*/) const {}
  11502. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  11503. int & /*port*/) const {}
  11504. inline socket_t BufferStream::socket() const { return 0; }
  11505. inline time_t BufferStream::duration() const { return 0; }
  11506. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  11507. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  11508. : MatcherBase(pattern) {
  11509. constexpr const char marker[] = "/:";
  11510. // One past the last ending position of a path param substring
  11511. std::size_t last_param_end = 0;
  11512. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11513. // Needed to ensure that parameter names are unique during matcher
  11514. // construction
  11515. // If exceptions are disabled, only last duplicate path
  11516. // parameter will be set
  11517. std::unordered_set<std::string> param_name_set;
  11518. #endif
  11519. while (true) {
  11520. const auto marker_pos = pattern.find(
  11521. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  11522. if (marker_pos == std::string::npos) { break; }
  11523. static_fragments_.push_back(
  11524. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  11525. const auto param_name_start = marker_pos + str_len(marker);
  11526. auto sep_pos = pattern.find(separator, param_name_start);
  11527. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  11528. auto param_name =
  11529. pattern.substr(param_name_start, sep_pos - param_name_start);
  11530. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11531. if (param_name_set.find(param_name) != param_name_set.cend()) {
  11532. std::string msg = "Encountered path parameter '" + param_name +
  11533. "' multiple times in route pattern '" + pattern + "'.";
  11534. throw std::invalid_argument(msg);
  11535. }
  11536. #endif
  11537. param_names_.push_back(std::move(param_name));
  11538. last_param_end = sep_pos + 1;
  11539. }
  11540. if (last_param_end < pattern.length()) {
  11541. static_fragments_.push_back(pattern.substr(last_param_end));
  11542. }
  11543. }
  11544. inline bool PathParamsMatcher::match(Request &request) const {
  11545. request.matches = std::smatch();
  11546. request.path_params.clear();
  11547. // A pattern without parameters is just a literal path to compare against
  11548. if (param_names_.empty()) { return request.path == pattern(); }
  11549. request.path_params.reserve(param_names_.size());
  11550. // One past the position at which the path matched the pattern last time
  11551. std::size_t starting_pos = 0;
  11552. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  11553. const auto &fragment = static_fragments_[i];
  11554. if (starting_pos + fragment.length() > request.path.length()) {
  11555. return false;
  11556. }
  11557. // Avoid unnecessary allocation by using strncmp instead of substr +
  11558. // comparison
  11559. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  11560. fragment.length()) != 0) {
  11561. return false;
  11562. }
  11563. starting_pos += fragment.length();
  11564. // Should only happen when we have a static fragment after a param
  11565. // Example: '/users/:id/subscriptions'
  11566. // The 'subscriptions' fragment here does not have a corresponding param
  11567. if (i >= param_names_.size()) { continue; }
  11568. auto sep_pos = request.path.find(separator, starting_pos);
  11569. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  11570. const auto &param_name = param_names_[i];
  11571. request.path_params.emplace(
  11572. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  11573. // Mark everything up to '/' as matched
  11574. starting_pos = sep_pos + 1;
  11575. }
  11576. // Returns false if the path is longer than the pattern
  11577. return starting_pos >= request.path.length();
  11578. }
  11579. inline bool RegexMatcher::match(Request &request) const {
  11580. request.path_params.clear();
  11581. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  11582. // a non-match rather than risking a stack overflow in std::regex_match.
  11583. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  11584. return false;
  11585. }
  11586. return std::regex_match(request.path, request.matches, regex_);
  11587. }
  11588. // Enclose IPv6 address in brackets if needed
  11589. inline std::string prepare_host_string(const std::string &host) {
  11590. // Enclose IPv6 address in brackets (but not if already enclosed)
  11591. if (host.find(':') == std::string::npos ||
  11592. (!host.empty() && host[0] == '[')) {
  11593. // IPv4, hostname, or already bracketed IPv6
  11594. return host;
  11595. } else {
  11596. // IPv6 address without brackets
  11597. return "[" + host + "]";
  11598. }
  11599. }
  11600. inline std::string make_host_and_port_string(const std::string &host, int port,
  11601. bool is_ssl) {
  11602. auto result = prepare_host_string(host);
  11603. // Append port if not default
  11604. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  11605. ; // do nothing
  11606. } else {
  11607. result += ":" + std::to_string(port);
  11608. }
  11609. return result;
  11610. }
  11611. // Create "host:port" string always including port number (for CONNECT method)
  11612. inline std::string
  11613. make_host_and_port_string_always_port(const std::string &host, int port) {
  11614. return prepare_host_string(host) + ":" + std::to_string(port);
  11615. }
  11616. // Where a client connects for `host`, as one string: the mapped address or
  11617. // name, or `host` itself.
  11618. inline std::string
  11619. addr_map_target(const std::map<std::string, std::string> &addr_map,
  11620. const std::string &host) {
  11621. std::string connect_host;
  11622. std::string ip;
  11623. apply_addr_map(addr_map, host, connect_host, ip);
  11624. return ip.empty() ? connect_host : ip;
  11625. }
  11626. // Request target of a CONNECT for `host`, with `addr_map` applied.
  11627. inline std::string
  11628. make_connect_request_target(const std::map<std::string, std::string> &addr_map,
  11629. const std::string &host, int port) {
  11630. return make_host_and_port_string_always_port(addr_map_target(addr_map, host),
  11631. port);
  11632. }
  11633. // Value for the Host header a client sends when the caller supplied none.
  11634. // Only the value: callers decide where in their header list it goes.
  11635. inline std::string make_default_host_header_value(const std::string &host,
  11636. int port, bool is_ssl,
  11637. int address_family) {
  11638. if (address_family == AF_UNIX) { return "localhost"; }
  11639. return make_host_and_port_string(host, port, is_ssl);
  11640. }
  11641. inline void add_default_user_agent_header(Request &req) {
  11642. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  11643. if (!req.has_header("User-Agent")) {
  11644. req.set_header("User-Agent",
  11645. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  11646. }
  11647. #else
  11648. (void)req;
  11649. #endif
  11650. }
  11651. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  11652. NormalizedTarget normalize_target(const std::string &host);
  11653. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  11654. bool host_matches_no_proxy(const NormalizedTarget &target,
  11655. const std::vector<NoProxyEntry> &entries);
  11656. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  11657. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  11658. if (prefix_bits == 0) { return true; }
  11659. int full_bytes = prefix_bits / 8;
  11660. int rem_bits = prefix_bits % 8;
  11661. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  11662. static_cast<size_t>(full_bytes)) != 0) {
  11663. return false;
  11664. }
  11665. if (rem_bits == 0) { return true; }
  11666. auto i = static_cast<size_t>(full_bytes);
  11667. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  11668. return (ip[i] & mask) == (net[i] & mask);
  11669. }
  11670. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  11671. if (token.empty()) { return false; }
  11672. if (token == "*") {
  11673. out.kind = NoProxyKind::Wildcard;
  11674. return true;
  11675. }
  11676. auto slash = token.find('/');
  11677. std::string addr_part =
  11678. (slash == std::string::npos) ? token : token.substr(0, slash);
  11679. std::string prefix_part =
  11680. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  11681. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  11682. // don't silently treat it as a /32 (or /128).
  11683. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  11684. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  11685. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  11686. // when brackets are present.
  11687. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  11688. addr_part.back() == ']';
  11689. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  11690. if (!bracketed) {
  11691. struct in_addr v4;
  11692. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  11693. int prefix = 32;
  11694. if (!prefix_part.empty() &&
  11695. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  11696. prefix)) {
  11697. return false;
  11698. }
  11699. out.kind = NoProxyKind::IPv4Cidr;
  11700. std::memcpy(out.net.data(), &v4, sizeof(v4));
  11701. out.prefix_bits = prefix;
  11702. return true;
  11703. }
  11704. }
  11705. struct in6_addr v6;
  11706. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  11707. int prefix = 128;
  11708. if (!prefix_part.empty() &&
  11709. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  11710. prefix)) {
  11711. return false;
  11712. }
  11713. out.kind = NoProxyKind::IPv6Cidr;
  11714. std::memcpy(out.net.data(), &v6, sizeof(v6));
  11715. out.prefix_bits = prefix;
  11716. return true;
  11717. }
  11718. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  11719. // the entry is malformed — don't fall through to the hostname branch.
  11720. if (bracketed) { return false; }
  11721. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  11722. if (slash != std::string::npos) { return false; }
  11723. // Port-specific entries (host:port) are not supported.
  11724. if (token.find(':') != std::string::npos) { return false; }
  11725. std::string hostname = case_ignore::to_lower(token);
  11726. while (!hostname.empty() && hostname.front() == '.') {
  11727. hostname.erase(hostname.begin());
  11728. }
  11729. while (!hostname.empty() && hostname.back() == '.') {
  11730. hostname.pop_back();
  11731. }
  11732. if (hostname.empty()) { return false; }
  11733. out.kind = NoProxyKind::HostnameSuffix;
  11734. out.hostname_pattern = std::move(hostname);
  11735. return true;
  11736. }
  11737. inline std::vector<NoProxyEntry>
  11738. parse_no_proxy_entries(const std::vector<std::string> &patterns) {
  11739. std::vector<NoProxyEntry> entries;
  11740. entries.reserve(patterns.size());
  11741. for (const auto &p : patterns) {
  11742. auto trimmed = trim_copy(p);
  11743. if (trimmed.empty()) { continue; }
  11744. NoProxyEntry entry;
  11745. if (parse_no_proxy_entry(trimmed, entry)) {
  11746. entries.push_back(std::move(entry));
  11747. }
  11748. }
  11749. return entries;
  11750. }
  11751. inline NormalizedTarget normalize_target(const std::string &host) {
  11752. NormalizedTarget t;
  11753. std::string h = host;
  11754. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  11755. h = h.substr(1, h.size() - 2);
  11756. }
  11757. // Strip a single trailing dot so "example.com." canonicalizes to
  11758. // "example.com".
  11759. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  11760. t.hostname = case_ignore::to_lower(h);
  11761. if (!t.hostname.empty()) {
  11762. struct in_addr v4;
  11763. struct in6_addr v6;
  11764. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  11765. t.is_ipv4 = true;
  11766. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  11767. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  11768. t.is_ipv6 = true;
  11769. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  11770. }
  11771. }
  11772. return t;
  11773. }
  11774. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  11775. const std::vector<NoProxyEntry> &entries) {
  11776. if (target.hostname.empty()) { return false; }
  11777. for (const auto &e : entries) {
  11778. switch (e.kind) {
  11779. case NoProxyKind::Wildcard: return true;
  11780. case NoProxyKind::IPv4Cidr:
  11781. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11782. return true;
  11783. }
  11784. break;
  11785. case NoProxyKind::IPv6Cidr:
  11786. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11787. return true;
  11788. }
  11789. break;
  11790. case NoProxyKind::HostnameSuffix:
  11791. if (target.is_ipv4 || target.is_ipv6) { break; }
  11792. if (target.hostname == e.hostname_pattern) { return true; }
  11793. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  11794. // an entry of "example.com".
  11795. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  11796. auto offset = target.hostname.size() - e.hostname_pattern.size();
  11797. if (target.hostname[offset - 1] == '.' &&
  11798. target.hostname.compare(offset, e.hostname_pattern.size(),
  11799. e.hostname_pattern) == 0) {
  11800. return true;
  11801. }
  11802. }
  11803. break;
  11804. }
  11805. }
  11806. return false;
  11807. }
  11808. template <typename T>
  11809. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11810. T header_writer, Error &error) {
  11811. for (const auto &h : headers) {
  11812. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11813. error = Error::InvalidHeaders;
  11814. return false;
  11815. }
  11816. }
  11817. if (header_writer(strm, headers) <= 0) {
  11818. error = Error::Write;
  11819. return false;
  11820. }
  11821. return true;
  11822. }
  11823. } // namespace detail
  11824. /*
  11825. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11826. */
  11827. #ifdef CPPHTTPLIB_SSL_ENABLED
  11828. namespace detail {
  11829. // SSL socket stream implementation
  11830. inline SSLSocketStream::SSLSocketStream(
  11831. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11832. time_t read_timeout_usec, time_t write_timeout_sec,
  11833. time_t write_timeout_usec, time_t max_timeout_msec,
  11834. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11835. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11836. read_timeout_usec_(read_timeout_usec),
  11837. write_timeout_sec_(write_timeout_sec),
  11838. write_timeout_usec_(write_timeout_usec),
  11839. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11840. tls_error_.code = tls::ErrorCode::Success;
  11841. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11842. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11843. // Note: create_session() also clears this, but SSLClient currently
  11844. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11845. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11846. // SSL session was created.
  11847. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11848. #endif
  11849. }
  11850. inline SSLSocketStream::~SSLSocketStream() = default;
  11851. inline bool SSLSocketStream::is_readable() const {
  11852. return tls::pending(session_) > 0;
  11853. }
  11854. inline bool SSLSocketStream::wait_readable() const {
  11855. if (max_timeout_msec_ <= 0) {
  11856. return select_read_interruptible(sock_, read_timeout_sec_,
  11857. read_timeout_usec_, read_interrupted_) > 0;
  11858. }
  11859. time_t read_timeout_sec;
  11860. time_t read_timeout_usec;
  11861. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11862. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11863. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11864. read_interrupted_) > 0;
  11865. }
  11866. inline bool SSLSocketStream::wait_writable() const {
  11867. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11868. !tls::is_peer_closed(session_, sock_);
  11869. }
  11870. inline bool SSLSocketStream::ensure_readable() {
  11871. if (readable_hint_) {
  11872. readable_hint_ = false;
  11873. return true;
  11874. }
  11875. return wait_readable();
  11876. }
  11877. inline bool SSLSocketStream::is_peer_alive() const {
  11878. return !tls::is_peer_closed(session_, sock_);
  11879. }
  11880. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11881. if (tls::pending(session_) > 0) {
  11882. tls::TlsError err;
  11883. auto ret = tls::read(session_, ptr, size, err);
  11884. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11885. error_ = Error::ConnectionClosed;
  11886. } else if (ret < 0) {
  11887. tls_error_ = err;
  11888. }
  11889. return ret;
  11890. } else if (ensure_readable()) {
  11891. tls::TlsError err;
  11892. auto ret = tls::read(session_, ptr, size, err);
  11893. if (ret < 0) {
  11894. auto n = 1000;
  11895. #ifdef _WIN32
  11896. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11897. (err.code == tls::ErrorCode::SyscallError &&
  11898. WSAGetLastError() == WSAETIMEDOUT))) {
  11899. #else
  11900. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11901. #endif
  11902. if (tls::pending(session_) > 0) {
  11903. ret = tls::read(session_, ptr, size, err);
  11904. if (ret >= 0) { return ret; }
  11905. break;
  11906. } else if (wait_readable()) {
  11907. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11908. ret = tls::read(session_, ptr, size, err);
  11909. if (ret >= 0) { return ret; }
  11910. } else {
  11911. break;
  11912. }
  11913. }
  11914. assert(ret < 0);
  11915. tls_error_ = err;
  11916. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11917. error_ = Error::ConnectionClosed;
  11918. }
  11919. return ret;
  11920. } else {
  11921. error_ = Error::Timeout;
  11922. return -1;
  11923. }
  11924. }
  11925. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11926. if (wait_writable()) {
  11927. auto handle_size =
  11928. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11929. tls::TlsError err;
  11930. auto ret = tls::write(session_, ptr, handle_size, err);
  11931. if (ret < 0) {
  11932. auto n = 1000;
  11933. #ifdef _WIN32
  11934. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11935. (err.code == tls::ErrorCode::SyscallError &&
  11936. WSAGetLastError() == WSAETIMEDOUT))) {
  11937. #else
  11938. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11939. #endif
  11940. if (wait_writable()) {
  11941. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11942. ret = tls::write(session_, ptr, handle_size, err);
  11943. if (ret >= 0) { return ret; }
  11944. } else {
  11945. break;
  11946. }
  11947. }
  11948. assert(ret < 0);
  11949. tls_error_ = err;
  11950. }
  11951. return ret;
  11952. }
  11953. return -1;
  11954. }
  11955. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11956. int &port) const {
  11957. detail::get_remote_ip_and_port(sock_, ip, port);
  11958. }
  11959. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11960. int &port) const {
  11961. detail::get_local_ip_and_port(sock_, ip, port);
  11962. }
  11963. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11964. inline time_t SSLSocketStream::duration() const {
  11965. return static_cast<time_t>(
  11966. std::chrono::duration_cast<std::chrono::milliseconds>(
  11967. std::chrono::steady_clock::now() - start_time_)
  11968. .count());
  11969. }
  11970. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11971. read_timeout_sec_ = sec;
  11972. read_timeout_usec_ = usec;
  11973. }
  11974. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11975. max_timeout_msec_ = msec;
  11976. start_time_ = std::chrono::steady_clock::now();
  11977. }
  11978. inline void
  11979. SSLSocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11980. read_interrupted_ = std::move(interrupted);
  11981. }
  11982. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11983. tls::session_t session,
  11984. time_t read_timeout_sec,
  11985. time_t read_timeout_usec,
  11986. time_t write_timeout_sec,
  11987. time_t write_timeout_usec)
  11988. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11989. read_timeout_usec_(read_timeout_usec),
  11990. write_timeout_sec_(write_timeout_sec),
  11991. write_timeout_usec_(write_timeout_usec),
  11992. start_time_(std::chrono::steady_clock::now().time_since_epoch().count()) {
  11993. // The receive and send paths run on different threads, so each TLS call is
  11994. // driven in non-blocking mode and readiness is awaited with select()
  11995. // outside the session lock. Set the socket non-blocking once here; it is
  11996. // never flipped back, so no thread races on the flag.
  11997. detail::set_nonblocking(sock_, true);
  11998. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11999. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  12000. #endif
  12001. }
  12002. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  12003. inline bool WebSocketSSLStream::is_readable() const {
  12004. std::lock_guard<std::mutex> guard(session_mutex_);
  12005. return tls::pending(session_) > 0;
  12006. }
  12007. inline bool WebSocketSSLStream::wait_readable() const {
  12008. auto max_timeout_msec = max_timeout_msec_.load();
  12009. if (max_timeout_msec <= 0) {
  12010. return select_read_interruptible(sock_, read_timeout_sec_,
  12011. read_timeout_usec_, read_interrupted_) > 0;
  12012. }
  12013. time_t read_timeout_sec;
  12014. time_t read_timeout_usec;
  12015. calc_actual_timeout(max_timeout_msec, duration(), read_timeout_sec_,
  12016. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  12017. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  12018. read_interrupted_) > 0;
  12019. }
  12020. inline bool WebSocketSSLStream::wait_writable() const {
  12021. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  12022. // that probe toggles the socket's blocking flag, which would race with the
  12023. // concurrent reader on a permanently non-blocking socket.
  12024. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  12025. }
  12026. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  12027. tls::TlsError err;
  12028. auto n = 1000;
  12029. while (--n >= 0) {
  12030. {
  12031. std::lock_guard<std::mutex> guard(session_mutex_);
  12032. auto ret = tls::read(session_, ptr, size, err);
  12033. if (ret > 0) { return ret; }
  12034. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  12035. error_ = Error::ConnectionClosed;
  12036. return ret;
  12037. }
  12038. }
  12039. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  12040. // direction: the send path shares this session, so output it left pending
  12041. // has to be flushed before more input can be decrypted. Anything else is
  12042. // a hard error.
  12043. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  12044. #ifdef _WIN32
  12045. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  12046. needs_readable =
  12047. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  12048. WSAGetLastError() == WSAETIMEDOUT);
  12049. #endif
  12050. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  12051. error_ = Error::Read;
  12052. return -1;
  12053. }
  12054. if (!(needs_readable ? wait_readable() : wait_writable())) {
  12055. error_ = Error::Timeout;
  12056. return -1;
  12057. }
  12058. }
  12059. // Out of retries. Recording a reason matters: a caller that reads get_error()
  12060. // to tell a timeout from a close would otherwise see whatever the previous
  12061. // failure left behind (error_ is never cleared on success).
  12062. error_ = Error::Read;
  12063. return -1;
  12064. }
  12065. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  12066. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  12067. tls::TlsError err;
  12068. auto n = 1000;
  12069. while (--n >= 0) {
  12070. {
  12071. std::lock_guard<std::mutex> guard(session_mutex_);
  12072. auto ret = tls::write(session_, ptr, handle_size, err);
  12073. if (ret >= 0) { return ret; }
  12074. }
  12075. // ret < 0. As in read(), either direction can be needed: a renegotiation
  12076. // or a post-handshake message must be consumed before the record goes
  12077. // out. Anything else is a hard error.
  12078. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  12079. #ifdef _WIN32
  12080. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  12081. needs_writable =
  12082. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  12083. WSAGetLastError() == WSAETIMEDOUT);
  12084. #endif
  12085. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  12086. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  12087. }
  12088. return -1;
  12089. }
  12090. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  12091. int &port) const {
  12092. detail::get_remote_ip_and_port(sock_, ip, port);
  12093. }
  12094. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  12095. int &port) const {
  12096. detail::get_local_ip_and_port(sock_, ip, port);
  12097. }
  12098. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  12099. inline time_t WebSocketSSLStream::duration() const {
  12100. auto start = std::chrono::steady_clock::time_point(
  12101. std::chrono::steady_clock::duration(start_time_.load()));
  12102. return static_cast<time_t>(
  12103. std::chrono::duration_cast<std::chrono::milliseconds>(
  12104. std::chrono::steady_clock::now() - start)
  12105. .count());
  12106. }
  12107. // Start time first: a reader that sees the new bound also sees its start
  12108. inline void WebSocketSSLStream::set_max_timeout(time_t msec) {
  12109. start_time_ = std::chrono::steady_clock::now().time_since_epoch().count();
  12110. max_timeout_msec_ = msec;
  12111. }
  12112. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  12113. read_timeout_sec_ = sec;
  12114. read_timeout_usec_ = usec;
  12115. }
  12116. inline void
  12117. WebSocketSSLStream::set_read_interrupt(std::function<bool()> interrupted) {
  12118. read_interrupted_ = std::move(interrupted);
  12119. }
  12120. } // namespace detail
  12121. #endif // CPPHTTPLIB_SSL_ENABLED
  12122. /*
  12123. * Group 4: Server implementation
  12124. */
  12125. // HTTP server implementation
  12126. inline Server::Server()
  12127. : new_task_queue([] {
  12128. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  12129. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  12130. }) {
  12131. #ifndef _WIN32
  12132. signal(SIGPIPE, SIG_IGN);
  12133. #endif
  12134. }
  12135. inline Server::~Server() = default;
  12136. inline std::unique_ptr<detail::MatcherBase>
  12137. Server::make_matcher(const std::string &pattern) {
  12138. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  12139. // a path params pattern
  12140. if (pattern.find("/:") != std::string::npos) {
  12141. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  12142. }
  12143. // A pattern with no regex metacharacter only has to be compared literally,
  12144. // which is what PathParamsMatcher already does when it captures no
  12145. // parameter, so std::regex is only worth building for the patterns that
  12146. // actually need it
  12147. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  12148. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  12149. }
  12150. return detail::make_unique<detail::RegexMatcher>(pattern);
  12151. }
  12152. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  12153. return add_handler(get_handlers_, pattern, std::move(handler));
  12154. }
  12155. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  12156. return add_handler(post_handlers_, pattern, std::move(handler));
  12157. }
  12158. inline Server &Server::Post(const std::string &pattern,
  12159. HandlerWithContentReader handler) {
  12160. return add_handler(post_handlers_for_content_reader_, pattern,
  12161. std::move(handler));
  12162. }
  12163. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  12164. return add_handler(put_handlers_, pattern, std::move(handler));
  12165. }
  12166. inline Server &Server::Put(const std::string &pattern,
  12167. HandlerWithContentReader handler) {
  12168. return add_handler(put_handlers_for_content_reader_, pattern,
  12169. std::move(handler));
  12170. }
  12171. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  12172. return add_handler(patch_handlers_, pattern, std::move(handler));
  12173. }
  12174. inline Server &Server::Patch(const std::string &pattern,
  12175. HandlerWithContentReader handler) {
  12176. return add_handler(patch_handlers_for_content_reader_, pattern,
  12177. std::move(handler));
  12178. }
  12179. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  12180. return add_handler(delete_handlers_, pattern, std::move(handler));
  12181. }
  12182. inline Server &Server::Delete(const std::string &pattern,
  12183. HandlerWithContentReader handler) {
  12184. return add_handler(delete_handlers_for_content_reader_, pattern,
  12185. std::move(handler));
  12186. }
  12187. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  12188. return add_handler(options_handlers_, pattern, std::move(handler));
  12189. }
  12190. inline const std::set<std::string> &Server::builtin_methods() {
  12191. thread_local const std::set<std::string> methods{
  12192. "GET", "HEAD", "POST", "PUT", "DELETE",
  12193. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  12194. return methods;
  12195. }
  12196. inline Server::CustomHandlerEntry *
  12197. Server::custom_entry_for_registration(const std::string &method) {
  12198. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  12199. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  12200. // routing() before the custom tables are consulted, so a route registered
  12201. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  12202. // there and would be reachable, but they carry protocol-level meaning
  12203. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  12204. // library does not route.
  12205. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  12206. output_error_log(Error::InvalidHTTPMethod, nullptr);
  12207. has_invalid_registration_ = true;
  12208. return nullptr;
  12209. }
  12210. return &custom_handlers_[method];
  12211. }
  12212. inline Server &Server::CustomRoute(const std::string &method,
  12213. const std::string &pattern,
  12214. Handler handler) {
  12215. auto *entry = custom_entry_for_registration(method);
  12216. if (!entry) { return *this; }
  12217. return add_handler(entry->handlers, pattern, std::move(handler));
  12218. }
  12219. inline Server &Server::CustomRoute(const std::string &method,
  12220. const std::string &pattern,
  12221. HandlerWithContentReader handler) {
  12222. auto *entry = custom_entry_for_registration(method);
  12223. if (!entry) { return *this; }
  12224. return add_handler(entry->handlers_for_content_reader, pattern,
  12225. std::move(handler));
  12226. }
  12227. inline const Server::CustomHandlerEntry *
  12228. Server::find_custom_entry(const std::string &method) const {
  12229. // find() alone would be correct here. The empty() check is what keeps the
  12230. // per-request cost off servers that never call CustomRoute(), which is the
  12231. // overwhelmingly common case; keep it rather than walking into the tree.
  12232. if (custom_handlers_.empty()) { return nullptr; }
  12233. auto it = custom_handlers_.find(method);
  12234. return it == custom_handlers_.end() ? nullptr : &it->second;
  12235. }
  12236. inline Server &Server::WebSocket(const std::string &pattern,
  12237. WebSocketHandler handler) {
  12238. websocket_handlers_.push_back(
  12239. {make_matcher(pattern), std::move(handler), nullptr});
  12240. return *this;
  12241. }
  12242. inline Server &Server::WebSocket(const std::string &pattern,
  12243. WebSocketHandler handler,
  12244. SubProtocolSelector sub_protocol_selector) {
  12245. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  12246. std::move(sub_protocol_selector)});
  12247. return *this;
  12248. }
  12249. inline bool Server::set_base_dir(const std::string &dir,
  12250. const std::string &mount_point) {
  12251. return set_mount_point(mount_point, dir);
  12252. }
  12253. inline bool Server::set_mount_point(const std::string &mount_point,
  12254. const std::string &dir, Headers headers) {
  12255. detail::FileStat stat(dir);
  12256. if (stat.is_dir()) {
  12257. std::string mnt = !mount_point.empty() ? mount_point : "/";
  12258. if (!mnt.empty() && mnt[0] == '/') {
  12259. // Without the resolved directory, a file could not be checked to be
  12260. // inside it.
  12261. std::string resolved_base;
  12262. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  12263. return false;
  12264. }
  12265. #if defined(_WIN32)
  12266. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  12267. resolved_base += '\\';
  12268. }
  12269. #else
  12270. if (resolved_base.back() != '/') { resolved_base += '/'; }
  12271. #endif
  12272. base_dirs_.push_back(
  12273. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  12274. return true;
  12275. }
  12276. }
  12277. return false;
  12278. }
  12279. inline bool Server::remove_mount_point(const std::string &mount_point) {
  12280. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  12281. if (it->mount_point == mount_point) {
  12282. base_dirs_.erase(it);
  12283. return true;
  12284. }
  12285. }
  12286. return false;
  12287. }
  12288. inline Server &
  12289. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  12290. const std::string &mime) {
  12291. // Keyed as find_content_type() looks it up
  12292. auto key = detail::case_ignore::to_lower(ext);
  12293. if (!key.empty() && key[0] == '.') { key.erase(0, 1); }
  12294. file_extension_and_mimetype_map_[key] = mime;
  12295. return *this;
  12296. }
  12297. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  12298. default_file_mimetype_ = mime;
  12299. return *this;
  12300. }
  12301. inline Server &Server::set_file_request_handler(Handler handler) {
  12302. file_request_handler_ = std::move(handler);
  12303. return *this;
  12304. }
  12305. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  12306. std::true_type) {
  12307. error_handler_ = std::move(handler);
  12308. return *this;
  12309. }
  12310. inline Server &Server::set_error_handler_core(Handler handler,
  12311. std::false_type) {
  12312. error_handler_ = [handler](const Request &req, Response &res) {
  12313. handler(req, res);
  12314. return HandlerResponse::Handled;
  12315. };
  12316. return *this;
  12317. }
  12318. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  12319. exception_handler_ = std::move(handler);
  12320. return *this;
  12321. }
  12322. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  12323. pre_routing_handler_ = std::move(handler);
  12324. return *this;
  12325. }
  12326. inline Server &Server::set_post_routing_handler(Handler handler) {
  12327. post_routing_handler_ = std::move(handler);
  12328. return *this;
  12329. }
  12330. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  12331. pre_request_handler_ = std::move(handler);
  12332. return *this;
  12333. }
  12334. inline Server &Server::set_logger(Logger logger) {
  12335. logger_ = std::move(logger);
  12336. return *this;
  12337. }
  12338. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  12339. error_logger_ = std::move(error_logger);
  12340. return *this;
  12341. }
  12342. inline Server &Server::set_pre_compression_logger(Logger logger) {
  12343. pre_compression_logger_ = std::move(logger);
  12344. return *this;
  12345. }
  12346. inline Server &
  12347. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  12348. expect_100_continue_handler_ = std::move(handler);
  12349. return *this;
  12350. }
  12351. inline Server &Server::set_start_handler(StartHandler handler) {
  12352. start_handler_ = std::move(handler);
  12353. return *this;
  12354. }
  12355. inline Server &Server::set_address_family(int family) {
  12356. address_family_ = family;
  12357. return *this;
  12358. }
  12359. inline Server &Server::set_tcp_nodelay(bool on) {
  12360. tcp_nodelay_ = on;
  12361. return *this;
  12362. }
  12363. inline Server &Server::set_ipv6_v6only(bool on) {
  12364. ipv6_v6only_ = on;
  12365. return *this;
  12366. }
  12367. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  12368. socket_options_ = std::move(socket_options);
  12369. return *this;
  12370. }
  12371. inline Server &Server::set_default_headers(Headers headers) {
  12372. default_headers_ = std::move(headers);
  12373. return *this;
  12374. }
  12375. inline Server &Server::set_header_writer(
  12376. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  12377. header_writer_ = writer;
  12378. return *this;
  12379. }
  12380. inline Server &
  12381. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  12382. trusted_proxies_.clear();
  12383. trusted_proxies_.reserve(proxies.size());
  12384. for (const auto &proxy : proxies) {
  12385. trusted_proxies_.push_back(detail::canonical_ip(proxy));
  12386. }
  12387. return *this;
  12388. }
  12389. inline Server &Server::set_keep_alive_max_count(size_t count) {
  12390. keep_alive_max_count_ = count;
  12391. return *this;
  12392. }
  12393. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  12394. keep_alive_timeout_sec_ = sec;
  12395. return *this;
  12396. }
  12397. template <class Rep, class Period>
  12398. inline Server &Server::set_keep_alive_timeout(
  12399. const std::chrono::duration<Rep, Period> &duration) {
  12400. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  12401. set_keep_alive_timeout(sec);
  12402. });
  12403. return *this;
  12404. }
  12405. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  12406. read_timeout_sec_ = sec;
  12407. read_timeout_usec_ = usec;
  12408. return *this;
  12409. }
  12410. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  12411. write_timeout_sec_ = sec;
  12412. write_timeout_usec_ = usec;
  12413. return *this;
  12414. }
  12415. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  12416. idle_interval_sec_ = sec;
  12417. idle_interval_usec_ = usec;
  12418. return *this;
  12419. }
  12420. inline Server &Server::set_payload_max_length(size_t length) {
  12421. payload_max_length_ = length;
  12422. return *this;
  12423. }
  12424. inline Server &Server::set_compress(bool on) {
  12425. compress_ = on;
  12426. return *this;
  12427. }
  12428. inline Server &Server::set_static_file_compression(bool on) {
  12429. static_file_compression_ = on;
  12430. return *this;
  12431. }
  12432. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  12433. static_file_compression_min_length_ = length;
  12434. return *this;
  12435. }
  12436. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  12437. static_file_compression_max_length_ = length;
  12438. return *this;
  12439. }
  12440. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  12441. websocket_max_missed_pongs_ = count;
  12442. return *this;
  12443. }
  12444. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  12445. websocket_ping_interval_sec_ = sec;
  12446. return *this;
  12447. }
  12448. template <class Rep, class Period>
  12449. inline Server &Server::set_websocket_ping_interval(
  12450. const std::chrono::duration<Rep, Period> &duration) {
  12451. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  12452. set_websocket_ping_interval(sec);
  12453. });
  12454. return *this;
  12455. }
  12456. inline bool Server::bind_to_port(const std::string &host, int port,
  12457. int socket_flags) {
  12458. auto ret = bind_internal(host, port, socket_flags);
  12459. if (ret == -1) { is_decommissioned = true; }
  12460. return ret >= 0;
  12461. }
  12462. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  12463. auto ret = bind_internal(host, 0, socket_flags);
  12464. if (ret == -1) { is_decommissioned = true; }
  12465. return ret;
  12466. }
  12467. inline bool Server::listen_after_bind() { return listen_internal(); }
  12468. inline bool Server::listen(const std::string &host, int port,
  12469. int socket_flags) {
  12470. return bind_to_port(host, port, socket_flags) && listen_internal();
  12471. }
  12472. inline bool Server::is_running() const { return is_running_; }
  12473. inline void Server::wait_until_ready() const {
  12474. while (!is_running_ && !is_decommissioned) {
  12475. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12476. }
  12477. }
  12478. inline void Server::stop() noexcept {
  12479. // Release the listening socket whether or not the accept loop is running:
  12480. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  12481. // exchange is what makes this safe to call concurrently with the accept loop.
  12482. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  12483. if (sock != INVALID_SOCKET) {
  12484. detail::shutdown_socket(sock);
  12485. detail::close_socket(sock);
  12486. }
  12487. is_decommissioned = false;
  12488. }
  12489. inline void Server::decommission() { is_decommissioned = true; }
  12490. inline bool Server::parse_request_line(const char *s, Request &req) const {
  12491. auto len = strlen(s);
  12492. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  12493. len -= 2;
  12494. {
  12495. // RFC 9112 §3: exactly one SP between the method, the target and the
  12496. // version. Taking other whitespace as a separator too lets recipients
  12497. // that parse more strictly see a different request.
  12498. auto end = s + len;
  12499. if (std::count(s, end, ' ') != 2) { return false; }
  12500. auto sp1 = std::find(s, end, ' ');
  12501. auto sp2 = std::find(sp1 + 1, end, ' ');
  12502. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  12503. req.method.assign(s, sp1);
  12504. req.target.assign(sp1 + 1, sp2);
  12505. req.version.assign(sp2 + 1, end);
  12506. }
  12507. // A method outside the built-in set is accepted only when a handler has been
  12508. // registered for it with CustomRoute().
  12509. const auto &methods = builtin_methods();
  12510. if (methods.find(req.method) == methods.end() &&
  12511. !find_custom_entry(req.method)) {
  12512. output_error_log(Error::InvalidHTTPMethod, &req);
  12513. return false;
  12514. }
  12515. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  12516. output_error_log(Error::InvalidHTTPVersion, &req);
  12517. return false;
  12518. }
  12519. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  12520. // would leave this server routing a different path than a cache or a
  12521. // filter in front of it sees.
  12522. if (!detail::fields::is_request_target(req.target) ||
  12523. req.target.find('#') != std::string::npos) {
  12524. return false;
  12525. }
  12526. {
  12527. detail::divide(req.target, '?',
  12528. [&](const char *lhs_data, std::size_t lhs_size,
  12529. const char *rhs_data, std::size_t rhs_size) {
  12530. req.path =
  12531. decode_path_component(std::string(lhs_data, lhs_size));
  12532. detail::parse_query_text(rhs_data, rhs_size, req.params);
  12533. });
  12534. }
  12535. return true;
  12536. }
  12537. inline bool Server::write_response(Stream &strm, bool close_connection,
  12538. Request &req, Response &res) {
  12539. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  12540. // incorrectly to the error content.
  12541. req.ranges.clear();
  12542. return write_response_core(strm, close_connection, req, res, false);
  12543. }
  12544. inline bool Server::write_response_with_content(Stream &strm,
  12545. bool close_connection,
  12546. const Request &req,
  12547. Response &res) {
  12548. return write_response_core(strm, close_connection, req, res, true);
  12549. }
  12550. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  12551. const Request &req, Response &res,
  12552. bool need_apply_ranges) {
  12553. assert(res.status != -1);
  12554. if (400 <= res.status && error_handler_ &&
  12555. error_handler_(req, res) == HandlerResponse::Handled) {
  12556. need_apply_ranges = true;
  12557. }
  12558. // Before anything below reads res.headers, which the handlers may have
  12559. // filled directly
  12560. detail::erase_invalid_fields(res.headers);
  12561. if (!detail::body_allowed_for_status(res.status)) {
  12562. detail::clear_content(res);
  12563. }
  12564. detail::prefer_assigned_body(res);
  12565. std::string content_type;
  12566. std::string boundary;
  12567. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  12568. // Prepare additional headers
  12569. if (close_connection ||
  12570. detail::has_header_token(req.headers, "Connection", "close") ||
  12571. 400 <= res.status || // Don't leave connections open after errors
  12572. // The client withholds the body until `100 Continue`, which was never
  12573. // sent, so whether and when the body follows is unknown.
  12574. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  12575. // The body was left partway, e.g. by a content receiver that returned
  12576. // false, so the rest of it cannot be told from the next request.
  12577. (req.body_read_started_ && !req.body_consumed_)) {
  12578. res.set_header("Connection", "close");
  12579. } else {
  12580. std::string s = "timeout=";
  12581. s += std::to_string(keep_alive_timeout_sec_);
  12582. if (keep_alive_max_count_ > 0) {
  12583. s += ", max=";
  12584. s += std::to_string(keep_alive_max_count_);
  12585. }
  12586. res.set_header("Keep-Alive", s);
  12587. }
  12588. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  12589. !res.has_header("Content-Type")) {
  12590. res.set_header("Content-Type", "text/plain");
  12591. }
  12592. detail::set_framing_headers(req, res, boundary, content_type);
  12593. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  12594. res.set_header("Accept-Ranges", "bytes");
  12595. }
  12596. if (post_routing_handler_) {
  12597. post_routing_handler_(req, res);
  12598. detail::erase_invalid_fields(res.headers);
  12599. // Again, for a body or framing headers the handler changed.
  12600. detail::set_framing_headers(req, res, boundary, content_type);
  12601. }
  12602. // Response line and headers
  12603. detail::BufferStream bstrm;
  12604. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  12605. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  12606. // Combine a small body with the headers so the whole response leaves in a
  12607. // single write. A large body is written on its own instead: a copy of it
  12608. // costs more than the extra write saves.
  12609. auto send_body =
  12610. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  12611. auto body_is_separate = false;
  12612. auto provider_done = false;
  12613. if (send_body && !res.body.empty() && !res.content_provider_) {
  12614. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  12615. bstrm.write(res.body.data(), res.body.size());
  12616. } else {
  12617. body_is_separate = true;
  12618. }
  12619. } else if (send_body && res.content_provider_ &&
  12620. res.is_file_content_provider_ &&
  12621. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  12622. // A small file is read into the same buffer. Other providers may produce
  12623. // their data over time, so they are never held back.
  12624. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  12625. return false;
  12626. }
  12627. provider_done = true;
  12628. }
  12629. // Log before writing to avoid race condition with client-side code that
  12630. // accesses logger-captured data immediately after receiving the response.
  12631. output_log(req, res);
  12632. // Flush buffer
  12633. auto &data = bstrm.get_buffer();
  12634. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  12635. if (body_is_separate) {
  12636. return detail::write_data(strm, res.body.data(), res.body.size());
  12637. }
  12638. // Streaming body
  12639. if (send_body && res.content_provider_) {
  12640. if (!provider_done &&
  12641. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  12642. return false;
  12643. }
  12644. res.content_provider_success_ = true;
  12645. }
  12646. return true;
  12647. }
  12648. inline bool
  12649. Server::write_content_with_provider(Stream &strm, const Request &req,
  12650. Response &res, const std::string &boundary,
  12651. const std::string &content_type) {
  12652. auto is_shutting_down = [this]() { return is_stopping(); };
  12653. if (res.content_length_ > 0) {
  12654. if (!detail::is_partial_content(req, res)) {
  12655. return detail::write_content(strm, res.content_provider_, 0,
  12656. res.content_length_, is_shutting_down);
  12657. } else if (req.ranges.size() == 1) {
  12658. auto offset_and_length = detail::get_range_offset_and_length(
  12659. req.ranges[0], res.content_length_);
  12660. return detail::write_content(strm, res.content_provider_,
  12661. offset_and_length.first,
  12662. offset_and_length.second, is_shutting_down);
  12663. } else {
  12664. return detail::write_multipart_ranges_data(
  12665. strm, req, res, boundary, content_type, res.content_length_,
  12666. is_shutting_down);
  12667. }
  12668. } else {
  12669. if (res.is_chunked_content_provider_) {
  12670. // Use the coding `apply_ranges()` chose when it wrote the headers;
  12671. // re-negotiating here would disagree with them, e.g. once a handler's
  12672. // own Content-Encoding header suppresses the negotiation.
  12673. auto compressor = detail::make_compressor(res.content_coding_);
  12674. if (!compressor) {
  12675. compressor = detail::make_unique<detail::nocompressor>();
  12676. }
  12677. return detail::write_content_chunked(strm, res.content_provider_,
  12678. is_shutting_down, *compressor);
  12679. } else {
  12680. return detail::write_content_without_length(strm, res.content_provider_,
  12681. is_shutting_down);
  12682. }
  12683. }
  12684. }
  12685. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  12686. FormFields::iterator cur_field;
  12687. FormFiles::iterator cur_file;
  12688. auto is_text_field = false;
  12689. size_t count = 0;
  12690. if (read_content_core(
  12691. strm, req, res,
  12692. // Regular
  12693. [&](const char *buf, size_t n) {
  12694. // Prevent arithmetic overflow when checking sizes.
  12695. // Avoid computing (req.body.size() + n) directly because
  12696. // adding two unsigned `size_t` values can wrap around and
  12697. // produce a small result instead of indicating overflow.
  12698. // Instead, check using subtraction: ensure `n` does not
  12699. // exceed the remaining capacity `max_size() - size()`.
  12700. if (req.body.size() >= req.body.max_size() ||
  12701. n > req.body.max_size() - req.body.size()) {
  12702. return false;
  12703. }
  12704. // Limit decompressed body size to payload_max_length_ to protect
  12705. // against "zip bomb" attacks where a small compressed payload
  12706. // decompresses to a massive size.
  12707. if (payload_max_length_ > 0 &&
  12708. (req.body.size() >= payload_max_length_ ||
  12709. n > payload_max_length_ - req.body.size())) {
  12710. return false;
  12711. }
  12712. req.body.append(buf, n);
  12713. return true;
  12714. },
  12715. // Multipart FormData
  12716. [&](const FormData &file) {
  12717. if (CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT > 0 &&
  12718. count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  12719. output_error_log(Error::TooManyFormDataFiles, &req);
  12720. return false;
  12721. }
  12722. if (file.filename.empty()) {
  12723. cur_field = req.form.fields.emplace(
  12724. file.name, FormField{file.name, file.content, file.headers});
  12725. is_text_field = true;
  12726. } else {
  12727. cur_file = req.form.files.emplace(file.name, file);
  12728. is_text_field = false;
  12729. }
  12730. return true;
  12731. },
  12732. [&](const char *buf, size_t n) {
  12733. if (is_text_field) {
  12734. auto &content = cur_field->second.content;
  12735. if (content.size() + n > content.max_size()) { return false; }
  12736. content.append(buf, n);
  12737. } else {
  12738. auto &content = cur_file->second.content;
  12739. if (content.size() + n > content.max_size()) { return false; }
  12740. content.append(buf, n);
  12741. }
  12742. return true;
  12743. })) {
  12744. const auto &content_type = req.get_header_value("Content-Type");
  12745. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  12746. "application/x-www-form-urlencoded")) {
  12747. if (CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH > 0 &&
  12748. req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  12749. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  12750. output_error_log(Error::ExceedMaxPayloadSize, &req);
  12751. return false;
  12752. }
  12753. detail::parse_query_text(req.body, req.params);
  12754. }
  12755. return true;
  12756. }
  12757. return false;
  12758. }
  12759. inline bool Server::read_content_with_content_receiver(
  12760. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12761. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  12762. return read_content_core(strm, req, res, std::move(receiver),
  12763. std::move(multipart_header),
  12764. std::move(multipart_receiver));
  12765. }
  12766. inline bool Server::read_content_core(
  12767. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12768. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  12769. detail::FormDataParser multipart_form_data_parser;
  12770. ContentReceiverWithProgress out;
  12771. if (req.is_multipart_form_data()) {
  12772. const auto &content_type = req.get_header_value("Content-Type");
  12773. std::string boundary;
  12774. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  12775. res.status = StatusCode::BadRequest_400;
  12776. output_error_log(Error::MultipartParsing, &req);
  12777. return false;
  12778. }
  12779. multipart_form_data_parser.set_boundary(std::move(boundary));
  12780. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  12781. return multipart_form_data_parser.parse(buf, n, multipart_header,
  12782. multipart_receiver);
  12783. };
  12784. } else {
  12785. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  12786. size_t /*len*/) { return receiver(buf, n); };
  12787. }
  12788. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  12789. if (!req.has_header("Content-Length") &&
  12790. !detail::is_chunked_transfer_encoding(req.headers)) {
  12791. return true;
  12792. }
  12793. // A second read would start where the first one stopped, or in the next
  12794. // request.
  12795. if (req.body_read_started_) { return false; }
  12796. // The client is waiting for this before it sends the body.
  12797. if (req.expect_100_continue_pending_) {
  12798. req.expect_100_continue_pending_ = false;
  12799. detail::write_response_line(strm, StatusCode::Continue_100);
  12800. strm.write("\r\n");
  12801. }
  12802. // Set before reading, since a receiver may also stop by throwing.
  12803. req.body_read_started_ = true;
  12804. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  12805. out, true)) {
  12806. return false;
  12807. }
  12808. req.body_consumed_ = true;
  12809. if (req.is_multipart_form_data()) {
  12810. if (!multipart_form_data_parser.is_valid()) {
  12811. res.status = StatusCode::BadRequest_400;
  12812. output_error_log(Error::MultipartParsing, &req);
  12813. return false;
  12814. }
  12815. }
  12816. return true;
  12817. }
  12818. inline bool Server::handle_file_request(Request &req, Response &res) {
  12819. if (!detail::is_valid_path(req.path)) { return false; }
  12820. for (const auto &entry : base_dirs_) {
  12821. // Prefix match, on a path segment boundary. A mount point of "/mount"
  12822. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  12823. // One that already ends in '/' (the root mount among them) carries its own
  12824. // boundary; set_mount_point() guarantees the mount point is not empty.
  12825. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  12826. (entry.mount_point.back() == '/' ||
  12827. req.path.size() == entry.mount_point.size() ||
  12828. req.path[entry.mount_point.size()] == '/')) {
  12829. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  12830. auto path = entry.base_dir + sub_path;
  12831. if (path.back() == '/') { path += "index.html"; }
  12832. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12833. // but symlinks/junctions can still escape the base directory. A path
  12834. // that cannot be resolved, which includes one that does not exist, is
  12835. // not served from here.
  12836. std::string resolved_path;
  12837. if (!detail::canonicalize_path(path.c_str(), resolved_path)) { continue; }
  12838. if (!detail::is_path_within_base(resolved_path,
  12839. entry.resolved_base_dir)) {
  12840. res.status = StatusCode::Forbidden_403;
  12841. return true;
  12842. }
  12843. detail::FileStat stat(path);
  12844. if (stat.is_dir()) {
  12845. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12846. // in the name from reading as a scheme.
  12847. auto name = req.path.substr(req.path.rfind('/') + 1);
  12848. res.set_redirect("./" + encode_path_component(name) + "/",
  12849. StatusCode::MovedPermanently_301);
  12850. return true;
  12851. }
  12852. if (stat.is_file()) {
  12853. for (const auto &kv : entry.headers) {
  12854. res.set_header(kv.first, kv.second);
  12855. }
  12856. auto content_type = detail::find_content_type(
  12857. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12858. auto encoding = detail::EncodingType::None;
  12859. if (static_file_compression_) {
  12860. encoding = static_file_encoding(req, res, content_type, stat.size());
  12861. }
  12862. // The ETag names the representation actually sent, so a client that
  12863. // cached the compressed form revalidates against the compressed ETag
  12864. // and still gets a 304, while one that took identity keeps the plain
  12865. // ETag.
  12866. auto etag = detail::compute_etag(
  12867. stat, encoding == detail::EncodingType::None
  12868. ? std::string()
  12869. : std::string("-") + detail::encoding_name(encoding));
  12870. if (!etag.empty()) { res.set_header("ETag", etag); }
  12871. auto mtime = stat.mtime();
  12872. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12873. if (!last_modified.empty()) {
  12874. res.set_header("Last-Modified", last_modified);
  12875. }
  12876. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12877. check_if_range(req, etag, mtime);
  12878. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12879. if (!mm->is_open()) {
  12880. output_error_log(Error::OpenFile, &req);
  12881. return false;
  12882. }
  12883. detail::set_file_content_provider(res, mm, content_type, encoding);
  12884. if (req.method != "HEAD" && file_request_handler_) {
  12885. file_request_handler_(req, res);
  12886. }
  12887. return true;
  12888. } else {
  12889. output_error_log(Error::OpenFile, &req);
  12890. }
  12891. }
  12892. }
  12893. return false;
  12894. }
  12895. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12896. const std::string &etag,
  12897. time_t mtime) const {
  12898. // Handle conditional GET:
  12899. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12900. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12901. if (req.has_header("If-None-Match")) {
  12902. if (!etag.empty()) {
  12903. auto val =
  12904. detail::get_combined_header_value(req.headers, "If-None-Match");
  12905. // NOTE: We use exact string matching here. This works correctly
  12906. // because our server always generates weak ETags (W/"..."), and
  12907. // clients typically send back the same ETag they received.
  12908. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12909. // If-None-Match, where W/"x" and "x" would match, but this
  12910. // simplified implementation requires exact matches.
  12911. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12912. [&](const char *b, const char *e) {
  12913. auto seg_len = static_cast<size_t>(e - b);
  12914. return (seg_len == 1 && *b == '*') ||
  12915. (seg_len == etag.size() &&
  12916. std::equal(b, e, etag.begin()));
  12917. });
  12918. if (ret) {
  12919. res.status = StatusCode::NotModified_304;
  12920. return true;
  12921. }
  12922. }
  12923. } else if (req.has_header("If-Modified-Since")) {
  12924. auto val = req.get_header_value("If-Modified-Since");
  12925. auto t = detail::parse_http_date(val);
  12926. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12927. res.status = StatusCode::NotModified_304;
  12928. return true;
  12929. }
  12930. }
  12931. return false;
  12932. }
  12933. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12934. time_t mtime) const {
  12935. // Handle If-Range for partial content requests (RFC 9110
  12936. // Section 13.1.5). If-Range is only evaluated when Range header is
  12937. // present. If the validator matches, serve partial content; otherwise
  12938. // serve full content.
  12939. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12940. auto val = req.get_header_value("If-Range");
  12941. auto is_valid_range = [&]() {
  12942. if (detail::is_strong_etag(val)) {
  12943. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12944. // comparison.
  12945. return (!etag.empty() && val == etag);
  12946. } else if (detail::is_weak_etag(val)) {
  12947. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12948. return false;
  12949. } else {
  12950. // HTTP-date comparison
  12951. auto t = detail::parse_http_date(val);
  12952. return (t != static_cast<time_t>(-1) && mtime <= t);
  12953. }
  12954. };
  12955. if (!is_valid_range()) {
  12956. // Validator doesn't match: ignore Range and serve full content
  12957. req.ranges.clear();
  12958. return false;
  12959. }
  12960. }
  12961. return true;
  12962. }
  12963. inline socket_t
  12964. Server::create_server_socket(const std::string &host, int port,
  12965. int socket_flags,
  12966. SocketOptions socket_options) const {
  12967. return detail::create_socket(
  12968. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12969. ipv6_v6only_, std::move(socket_options),
  12970. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12971. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12972. output_error_log(Error::BindIPAddress, nullptr);
  12973. return false;
  12974. }
  12975. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12976. output_error_log(Error::Listen, nullptr);
  12977. return false;
  12978. }
  12979. return true;
  12980. });
  12981. }
  12982. inline int Server::bind_internal(const std::string &host, int port,
  12983. int socket_flags) {
  12984. if (is_decommissioned) { return -1; }
  12985. if (!is_valid()) { return -1; }
  12986. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12987. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12988. if (port == 0) {
  12989. struct sockaddr_storage addr;
  12990. socklen_t addr_len = sizeof(addr);
  12991. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12992. &addr_len) == -1) {
  12993. output_error_log(Error::GetSockName, nullptr);
  12994. return -1;
  12995. }
  12996. if (addr.ss_family == AF_INET) {
  12997. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12998. } else if (addr.ss_family == AF_INET6) {
  12999. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  13000. } else {
  13001. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  13002. return -1;
  13003. }
  13004. } else {
  13005. return port;
  13006. }
  13007. }
  13008. inline bool Server::listen_internal() {
  13009. // A stop() between bind and listen leaves nothing to accept on. Report
  13010. // failure instead of returning success without ever serving, and mark the
  13011. // server decommissioned the way any failed listen does so that a concurrent
  13012. // wait_until_ready() wakes up instead of spinning forever.
  13013. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  13014. is_decommissioned = true;
  13015. return false;
  13016. }
  13017. auto ret = true;
  13018. is_running_ = true;
  13019. auto se = detail::scope_exit([&]() { is_running_ = false; });
  13020. if (start_handler_) { start_handler_(); }
  13021. {
  13022. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  13023. while (svr_sock_ != INVALID_SOCKET) {
  13024. #ifndef _WIN32
  13025. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  13026. #endif
  13027. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  13028. idle_interval_usec_);
  13029. if (val == 0) { // Timeout
  13030. task_queue->on_idle();
  13031. continue;
  13032. }
  13033. #ifndef _WIN32
  13034. }
  13035. #endif
  13036. #if defined _WIN32
  13037. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  13038. // OVERLAPPED
  13039. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  13040. #elif defined SOCK_CLOEXEC
  13041. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  13042. #else
  13043. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  13044. #endif
  13045. if (sock == INVALID_SOCKET) {
  13046. // NOTE: Winsock reports failures through WSAGetLastError() and never
  13047. // touches the CRT errno, so the two have to be asked platform by
  13048. // platform rather than by testing errno here.
  13049. if (detail::is_accept_resource_error()) {
  13050. // The per-process descriptor limit or the network stack's buffer
  13051. // space has been reached. Try to accept new connections after a
  13052. // short sleep.
  13053. std::this_thread::sleep_for(std::chrono::microseconds{1});
  13054. continue;
  13055. } else if (detail::is_accept_transient_error()) {
  13056. continue;
  13057. }
  13058. // Take the descriptor out of svr_sock_ before closing it: a later
  13059. // stop() would otherwise shutdown()/close() a value the OS may have
  13060. // reused, and keep_alive() watches svr_sock_ to notice the server is
  13061. // gone. The exchange also settles the race with a concurrent stop(),
  13062. // since whichever side takes the descriptor closes it exactly once.
  13063. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  13064. if (listen_sock != INVALID_SOCKET) {
  13065. detail::close_socket(listen_sock);
  13066. ret = false;
  13067. output_error_log(Error::Connection, nullptr);
  13068. } else {
  13069. ; // The server socket was closed by user.
  13070. }
  13071. break;
  13072. }
  13073. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  13074. read_timeout_sec_, read_timeout_usec_);
  13075. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  13076. write_timeout_sec_, write_timeout_usec_);
  13077. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  13078. if (!task_queue->enqueue(
  13079. [this, sock]() { process_and_close_socket(sock); })) {
  13080. output_error_log(Error::ResourceExhaustion, nullptr);
  13081. detail::shutdown_socket(sock);
  13082. detail::close_socket(sock);
  13083. }
  13084. }
  13085. task_queue->shutdown();
  13086. }
  13087. is_decommissioned = !ret;
  13088. return ret;
  13089. }
  13090. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  13091. // Call from a catch block. The response is a 500 unless the exception handler
  13092. // sets another status. Returns whether the exception handler ran.
  13093. inline bool Server::handle_exception(Request &req, Response &res) {
  13094. res.status = StatusCode::InternalServerError_500;
  13095. if (!exception_handler_) { return false; }
  13096. exception_handler_(req, res, std::current_exception());
  13097. return true;
  13098. }
  13099. #endif
  13100. inline bool Server::routing(Request &req, Response &res, Stream &strm,
  13101. bool skip_pre_routing) {
  13102. if (!skip_pre_routing && pre_routing_handler_ &&
  13103. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  13104. return true;
  13105. }
  13106. // File handler
  13107. if ((req.method == "GET" || req.method == "HEAD") &&
  13108. handle_file_request(req, res)) {
  13109. return true;
  13110. }
  13111. const auto *custom = find_custom_entry(req.method);
  13112. // The second clause mirrors what expect_content() does unconditionally for
  13113. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  13114. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  13115. // `allprop`) would skip its handler and fall through to 404.
  13116. if (detail::expect_content(req) ||
  13117. (custom && !custom->handlers_for_content_reader.empty())) {
  13118. // Content reader handler
  13119. {
  13120. // Track whether the ContentReader was aborted due to the decompressed
  13121. // payload exceeding `payload_max_length_`.
  13122. // The user handler runs after the lambda returns, so we must restore the
  13123. // 413 status if the handler overwrites it.
  13124. bool content_reader_payload_too_large = false;
  13125. ContentReader reader(
  13126. [&](ContentReceiver receiver) {
  13127. auto result = read_content_with_content_receiver(
  13128. strm, req, res, std::move(receiver), nullptr, nullptr);
  13129. if (!result) {
  13130. output_error_log(Error::Read, &req);
  13131. if (res.status == StatusCode::PayloadTooLarge_413) {
  13132. content_reader_payload_too_large = true;
  13133. }
  13134. }
  13135. return result;
  13136. },
  13137. [&](FormDataHeader header, ContentReceiver receiver) {
  13138. auto result = read_content_with_content_receiver(
  13139. strm, req, res, nullptr, std::move(header),
  13140. std::move(receiver));
  13141. if (!result) {
  13142. output_error_log(Error::Read, &req);
  13143. if (res.status == StatusCode::PayloadTooLarge_413) {
  13144. content_reader_payload_too_large = true;
  13145. }
  13146. }
  13147. return result;
  13148. });
  13149. bool dispatched = false;
  13150. if (req.method == "POST") {
  13151. dispatched = dispatch_request_for_content_reader(
  13152. req, res, std::move(reader), post_handlers_for_content_reader_);
  13153. } else if (req.method == "PUT") {
  13154. dispatched = dispatch_request_for_content_reader(
  13155. req, res, std::move(reader), put_handlers_for_content_reader_);
  13156. } else if (req.method == "PATCH") {
  13157. dispatched = dispatch_request_for_content_reader(
  13158. req, res, std::move(reader), patch_handlers_for_content_reader_);
  13159. } else if (req.method == "DELETE") {
  13160. dispatched = dispatch_request_for_content_reader(
  13161. req, res, std::move(reader), delete_handlers_for_content_reader_);
  13162. } else if (custom) {
  13163. dispatched = dispatch_request_for_content_reader(
  13164. req, res, std::move(reader), custom->handlers_for_content_reader);
  13165. }
  13166. if (dispatched) {
  13167. if (content_reader_payload_too_large) {
  13168. // Enforce the limit: override any status the handler may have set
  13169. // and return false so the error path sends a plain 413 response.
  13170. res.status = StatusCode::PayloadTooLarge_413;
  13171. detail::clear_content(res);
  13172. return false;
  13173. }
  13174. return true;
  13175. }
  13176. }
  13177. // NOTE: `req.body` is not read here. For a regular handler the body is
  13178. // read inside dispatch_request(), after the route has matched and the
  13179. // pre-request handler has approved the request, so that a rejected
  13180. // request (e.g. failed authentication) never forces us to buffer a
  13181. // potentially large body.
  13182. }
  13183. // Regular handler
  13184. if (req.method == "GET" || req.method == "HEAD") {
  13185. return dispatch_request(req, res, get_handlers_, strm);
  13186. } else if (req.method == "POST") {
  13187. return dispatch_request(req, res, post_handlers_, strm);
  13188. } else if (req.method == "PUT") {
  13189. return dispatch_request(req, res, put_handlers_, strm);
  13190. } else if (req.method == "DELETE") {
  13191. return dispatch_request(req, res, delete_handlers_, strm);
  13192. } else if (req.method == "OPTIONS") {
  13193. return dispatch_request(req, res, options_handlers_, strm);
  13194. } else if (req.method == "PATCH") {
  13195. return dispatch_request(req, res, patch_handlers_, strm);
  13196. } else if (custom) {
  13197. return dispatch_request(req, res, custom->handlers, strm);
  13198. }
  13199. res.status = StatusCode::BadRequest_400;
  13200. return false;
  13201. }
  13202. inline bool Server::dispatch_request(Request &req, Response &res,
  13203. const Handlers &handlers, Stream &strm) {
  13204. for (const auto &x : handlers) {
  13205. const auto &matcher = x.first;
  13206. const auto &handler = x.second;
  13207. if (matcher->match(req)) {
  13208. req.matched_route = matcher->pattern();
  13209. // Run the pre-request handler before reading the body so a rejected
  13210. // request (e.g. failed authentication) never forces us to buffer a
  13211. // potentially large body. `req.matched_route` is available here.
  13212. if (pre_request_handler_ &&
  13213. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  13214. return true;
  13215. }
  13216. // The route matched and the request was approved; read the body now.
  13217. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  13218. output_error_log(Error::Read, &req);
  13219. return false;
  13220. }
  13221. handler(req, res);
  13222. return true;
  13223. }
  13224. }
  13225. return false;
  13226. }
  13227. // Decides the content coding for a response served straight from a file. Both
  13228. // the ETag, which has to name the representation actually sent, and
  13229. // `apply_static_file_compression()` go through this, so the two cannot drift
  13230. // apart.
  13231. inline detail::EncodingType
  13232. Server::static_file_encoding(const Request &req, const Response &res,
  13233. const std::string &content_type,
  13234. size_t length) const {
  13235. if (!static_file_compression_) { return detail::EncodingType::None; }
  13236. // Nothing to compress, and an empty file already answers with
  13237. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  13238. // turn an empty body into a 20-byte gzip stream.
  13239. if (length == 0) { return detail::EncodingType::None; }
  13240. // A file that already fits in a single packet gains nothing from being made
  13241. // smaller, since it still travels in that one segment, and a file of a few
  13242. // bytes comes out larger than it went in.
  13243. if (length < static_file_compression_min_length_) {
  13244. return detail::EncodingType::None;
  13245. }
  13246. // RFC 9110 applies Range to the representation after content coding, so a
  13247. // compressed 206 would mean compressing the whole file and then slicing it.
  13248. // Serve ranges from the identity representation instead.
  13249. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  13250. if (static_file_compression_max_length_ > 0 &&
  13251. length > static_file_compression_max_length_) {
  13252. return detail::EncodingType::None;
  13253. }
  13254. return detail::encoding_type(req, res, content_type);
  13255. }
  13256. // Compresses a file-backed content provider into `res.body`. Returns false when
  13257. // the response is left untouched.
  13258. inline bool Server::apply_static_file_compression(const Request &req,
  13259. Response &res) const {
  13260. auto type = res.content_coding_;
  13261. if (type == detail::EncodingType::None || !res.content_provider_) {
  13262. return false;
  13263. }
  13264. auto compressor = detail::make_compressor(type);
  13265. if (!compressor) { return false; }
  13266. output_pre_compression_log(req, res);
  13267. std::string compressed;
  13268. if (!detail::compress_content_provider(res.content_provider_,
  13269. res.content_length_, *compressor,
  13270. compressed)) {
  13271. return false;
  13272. }
  13273. res.body.swap(compressed);
  13274. // The provider was consumed in full, so its releaser hears about a success.
  13275. res.content_provider_success_ = true;
  13276. detail::clear_content_provider(res);
  13277. res.set_header("Content-Encoding", detail::encoding_name(type));
  13278. res.set_header("Vary", "Accept-Encoding");
  13279. return true;
  13280. }
  13281. inline void Server::apply_ranges(const Request &req, Response &res,
  13282. std::string &content_type,
  13283. std::string &boundary) const {
  13284. // A known-length content provider leaves `res.body` empty, so the compressor
  13285. // at the end of this function never runs for one (issue #2545). A file-backed
  13286. // provider is fully readable right here, so compress it and answer with an
  13287. // ordinary body: `Content-Length` and HEAD keep working, and the response
  13288. // takes the same path as `set_content()` from here on. Range requests never
  13289. // get a content coding, so `Content-Range` still names identity bytes and
  13290. // none of the range handling below applies.
  13291. if (apply_static_file_compression(req, res)) { return; }
  13292. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  13293. auto it = res.headers.find("Content-Type");
  13294. if (it != res.headers.end()) {
  13295. content_type = it->second;
  13296. res.headers.erase(it);
  13297. }
  13298. boundary = detail::make_multipart_data_boundary();
  13299. res.set_header("Content-Type",
  13300. "multipart/byteranges; boundary=" + boundary);
  13301. }
  13302. auto type =
  13303. compress_ ? detail::encoding_type(req, res) : detail::EncodingType::None;
  13304. if (res.body.empty()) {
  13305. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  13306. res.status == StatusCode::PartialContent_206) {
  13307. auto offset_and_length = detail::get_range_offset_and_length(
  13308. req.ranges[0], res.content_length_);
  13309. auto content_range = detail::make_content_range_header_field(
  13310. offset_and_length, res.content_length_);
  13311. res.set_header("Content-Range", content_range);
  13312. } else if (res.is_chunked_content_provider_) {
  13313. res.content_coding_ = type;
  13314. if (type != detail::EncodingType::None) {
  13315. res.set_header("Content-Encoding", detail::encoding_name(type));
  13316. res.set_header("Vary", "Accept-Encoding");
  13317. }
  13318. }
  13319. } else {
  13320. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  13321. ;
  13322. } else if (req.ranges.size() == 1) {
  13323. auto offset_and_length =
  13324. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  13325. auto offset = offset_and_length.first;
  13326. auto length = offset_and_length.second;
  13327. auto content_range = detail::make_content_range_header_field(
  13328. offset_and_length, res.body.size());
  13329. res.set_header("Content-Range", content_range);
  13330. assert(offset + length <= res.body.size());
  13331. res.body = res.body.substr(offset, length);
  13332. } else {
  13333. std::string data;
  13334. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  13335. res.body.size(), data);
  13336. res.body.swap(data);
  13337. }
  13338. if (type != detail::EncodingType::None) {
  13339. output_pre_compression_log(req, res);
  13340. if (auto compressor = detail::make_compressor(type)) {
  13341. std::string compressed;
  13342. if (compressor->compress(res.body.data(), res.body.size(), true,
  13343. [&](const char *data, size_t data_len) {
  13344. compressed.append(data, data_len);
  13345. return true;
  13346. })) {
  13347. res.body.swap(compressed);
  13348. res.set_header("Content-Encoding", detail::encoding_name(type));
  13349. res.set_header("Vary", "Accept-Encoding");
  13350. }
  13351. }
  13352. }
  13353. res.content_length_ = res.body.size();
  13354. }
  13355. }
  13356. inline bool Server::dispatch_request_for_content_reader(
  13357. Request &req, Response &res, ContentReader content_reader,
  13358. const HandlersForContentReader &handlers) const {
  13359. for (const auto &x : handlers) {
  13360. const auto &matcher = x.first;
  13361. const auto &handler = x.second;
  13362. if (matcher->match(req)) {
  13363. req.matched_route = matcher->pattern();
  13364. if (!pre_request_handler_ ||
  13365. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  13366. handler(req, res, content_reader);
  13367. }
  13368. return true;
  13369. }
  13370. }
  13371. return false;
  13372. }
  13373. inline std::string
  13374. get_client_ip(const std::string &x_forwarded_for,
  13375. const std::vector<std::string> &trusted_proxies) {
  13376. // X-Forwarded-For is a comma-separated list per RFC 7239
  13377. std::vector<std::string> ip_list;
  13378. detail::split(x_forwarded_for.data(),
  13379. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  13380. [&](const char *b, const char *e) {
  13381. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  13382. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  13383. });
  13384. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  13385. // no segments. Signal "no client IP derived" with an empty string so the
  13386. // caller can fall back to the connection-level remote address.
  13387. if (ip_list.empty()) { return std::string(); }
  13388. // Each hop appends the address it received the request from, so the rightmost
  13389. // entries are the ones written by our own infrastructure while the leftmost
  13390. // are whatever the original client chose to send. Walk from the right and
  13391. // skip trusted proxies; the first address that is not a trusted proxy is the
  13392. // furthest point still attributable to a real hop, i.e. the client. Scanning
  13393. // from the left instead lets a client forge an arbitrary address by following
  13394. // it with a trusted proxy's address, which the left-to-right scan then
  13395. // returned as the client.
  13396. for (size_t i = ip_list.size(); i-- > 0;) {
  13397. const auto &ip = ip_list[i];
  13398. if (!detail::is_trusted_proxy(ip, trusted_proxies)) { return ip; }
  13399. }
  13400. // Every hop was a trusted proxy; fall back to the first entry.
  13401. return ip_list.front();
  13402. }
  13403. inline bool
  13404. Server::process_request(Stream &strm, const std::string &remote_addr,
  13405. int remote_port, const std::string &local_addr,
  13406. int local_port, bool close_connection,
  13407. bool &connection_closed,
  13408. const std::function<void(Request &)> &setup_request,
  13409. bool *websocket_upgraded) {
  13410. std::array<char, 2048> buf{};
  13411. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13412. // The read timeout bounds the request line and headers as a whole, so a
  13413. // client sending them a byte at a time cannot hold the worker any longer.
  13414. auto read_timeout_msec = read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000;
  13415. strm.set_max_timeout(read_timeout_msec);
  13416. // Connection has been closed on client
  13417. if (!line_reader.getline()) { return false; }
  13418. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  13419. // clients send an extra CRLF after a request body, which would otherwise be
  13420. // parsed as the next request on a persistent connection.
  13421. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  13422. return false;
  13423. }
  13424. Request req;
  13425. req.start_time_ = std::chrono::steady_clock::now();
  13426. req.remote_addr = remote_addr;
  13427. req.remote_port = remote_port;
  13428. req.local_addr = local_addr;
  13429. req.local_port = local_port;
  13430. Response res;
  13431. res.version = "HTTP/1.1";
  13432. res.headers = default_headers_;
  13433. // RFC 9112 §9.6: a server that sends the "close" connection option must
  13434. // close the connection after that response, whichever path wrote it (an
  13435. // error status, a handler, or a rejected request). Reading on would also
  13436. // parse whatever the client sent next on a connection it considers done.
  13437. auto honor_connection_close = detail::scope_exit([&] {
  13438. if (detail::has_header_token(res.headers, "Connection", "close")) {
  13439. connection_closed = true;
  13440. }
  13441. });
  13442. // Request line and headers. A rejected message leaves the rest of it (and
  13443. // any body) unread, so the connection cannot be reused: the leftover bytes
  13444. // would be parsed as the next request.
  13445. if (!parse_request_line(line_reader.ptr(), req)) {
  13446. connection_closed = true;
  13447. res.status = StatusCode::BadRequest_400;
  13448. output_error_log(Error::InvalidRequestLine, &req);
  13449. return write_response(strm, close_connection, req, res);
  13450. }
  13451. // Request headers
  13452. if (!detail::read_headers(strm, req.headers)) {
  13453. connection_closed = true;
  13454. res.status = StatusCode::BadRequest_400;
  13455. output_error_log(Error::InvalidHeaders, &req);
  13456. return write_response(strm, close_connection, req, res);
  13457. }
  13458. strm.set_max_timeout(0);
  13459. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  13460. // which would otherwise let an intermediary and this parser disagree on
  13461. // where the body ends and enable request smuggling. Three cases: a
  13462. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  13463. // or empty), which would otherwise be read as "no body"; a non-zero
  13464. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  13465. // tolerated for compatibility with existing clients); and a
  13466. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  13467. // length undeterminable. None of them may fall through to the "no body"
  13468. // path, or the body bytes are parsed as the next request on a persistent
  13469. // connection.
  13470. auto is_invalid_content_length = false;
  13471. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  13472. is_invalid_content_length);
  13473. if (is_invalid_content_length ||
  13474. detail::has_conflicting_content_length(req.headers) ||
  13475. (req.has_header("Transfer-Encoding") &&
  13476. !detail::is_chunked_transfer_encoding(req.headers))) {
  13477. connection_closed = true;
  13478. res.status = StatusCode::BadRequest_400;
  13479. return write_response(strm, close_connection, req, res);
  13480. }
  13481. // RFC 9112 6.1: a lone "chunked" is the only transfer coding implemented
  13482. if (req.has_header("Transfer-Encoding") &&
  13483. (req.get_header_value_count("Transfer-Encoding") != 1 ||
  13484. !detail::case_ignore::equal(req.get_header_value("Transfer-Encoding"),
  13485. "chunked"))) {
  13486. connection_closed = true;
  13487. res.status = StatusCode::NotImplemented_501;
  13488. return write_response(strm, close_connection, req, res);
  13489. }
  13490. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  13491. // HTTP/1.0 request, is honoured, but the connection closes after the
  13492. // response.
  13493. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  13494. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  13495. // value, or none in HTTP/1.1, so that every recipient of the request sees
  13496. // the same authority.
  13497. auto host_count = req.get_header_value_count("Host");
  13498. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  13499. !detail::fields::is_host(req.get_header_value("Host"))) {
  13500. connection_closed = true;
  13501. res.status = StatusCode::BadRequest_400;
  13502. output_error_log(Error::InvalidHeaders, &req);
  13503. return write_response(strm, close_connection, req, res);
  13504. }
  13505. // Check if the request URI doesn't exceed the limit
  13506. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13507. connection_closed = true;
  13508. res.status = StatusCode::UriTooLong_414;
  13509. output_error_log(Error::ExceedUriMaxLength, &req);
  13510. return write_response(strm, close_connection, req, res);
  13511. }
  13512. if (detail::has_header_token(req.headers, "Connection", "close")) {
  13513. connection_closed = true;
  13514. }
  13515. if (req.version == "HTTP/1.0" &&
  13516. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  13517. connection_closed = true;
  13518. }
  13519. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  13520. // itself a trusted proxy. Otherwise any direct client could spoof
  13521. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  13522. if (detail::is_trusted_proxy(remote_addr, trusted_proxies_) &&
  13523. req.has_header("X-Forwarded-For")) {
  13524. // Some proxies append the address they observed as a separate
  13525. // X-Forwarded-For field line instead of extending the one the client sent
  13526. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  13527. // be scanned. Reading only the first occurrence would hand back the
  13528. // client-supplied, and therefore forgeable, value.
  13529. auto x_forwarded_for =
  13530. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  13531. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  13532. req.remote_addr = derived.empty() ? remote_addr : derived;
  13533. } else {
  13534. req.remote_addr = remote_addr;
  13535. }
  13536. req.remote_port = remote_port;
  13537. req.local_addr = local_addr;
  13538. req.local_port = local_port;
  13539. if (req.has_header("Accept")) {
  13540. auto accept_header =
  13541. detail::get_combined_header_value(req.headers, "Accept");
  13542. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  13543. connection_closed = true;
  13544. res.status = StatusCode::BadRequest_400;
  13545. output_error_log(Error::HTTPParsing, &req);
  13546. return write_response(strm, close_connection, req, res);
  13547. }
  13548. }
  13549. // RFC 9110 14.2: range handling is defined only for GET (and so for HEAD)
  13550. if ((req.method == "GET" || req.method == "HEAD") &&
  13551. req.has_header("Range")) {
  13552. const auto &range_header_value = req.get_header_value("Range");
  13553. // RFC 9110 14.2: a range unit other than bytes must be ignored
  13554. auto unit = range_header_value.substr(0, range_header_value.find('='));
  13555. if (detail::case_ignore::equal(unit, "bytes") &&
  13556. !detail::parse_range_header(range_header_value, req.ranges)) {
  13557. connection_closed = true;
  13558. res.status = StatusCode::RangeNotSatisfiable_416;
  13559. output_error_log(Error::InvalidRangeHeader, &req);
  13560. return write_response(strm, close_connection, req, res);
  13561. }
  13562. }
  13563. if (setup_request) { setup_request(req); }
  13564. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  13565. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  13566. // must be ignored. An expectation we do not recognize is left alone; the
  13567. // 417 the section allows for one is a MAY, not a requirement.
  13568. //
  13569. // `100 Continue` itself is deferred until the body is actually read (see
  13570. // read_content_core), so a request rejected by a later handler never
  13571. // invites the client to send a body nobody will read.
  13572. if (req.version != "HTTP/1.0" &&
  13573. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  13574. int status = StatusCode::Continue_100;
  13575. if (expect_100_continue_handler_) {
  13576. status = expect_100_continue_handler_(req, res);
  13577. }
  13578. if (status == StatusCode::Continue_100) {
  13579. req.expect_100_continue_pending_ = true;
  13580. } else {
  13581. if (res.status == -1) { res.status = status; }
  13582. connection_closed = true;
  13583. return write_response(strm, true, req, res);
  13584. }
  13585. }
  13586. // Setup `is_connection_closed` method
  13587. auto sock = strm.socket();
  13588. req.is_connection_closed = [sock]() {
  13589. return !detail::is_socket_alive(sock);
  13590. };
  13591. // WebSocket upgrade
  13592. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  13593. // that authentication and other middleware can reject the request with an
  13594. // HTTP response (e.g., 401) before the protocol switches.
  13595. // The response says so when this connection closes after it.
  13596. auto close_after_response = close_connection || connection_closed;
  13597. // An upgrade request has been through pre-routing before it reaches routing()
  13598. auto is_upgrade = detail::is_websocket_upgrade(req);
  13599. if (is_upgrade) {
  13600. // A response given here leaves the body unread, and it would be parsed as
  13601. // the next request.
  13602. auto close_if_answered =
  13603. close_after_response || detail::has_framed_body(req);
  13604. const WebSocketHandlerEntry *ws_route = nullptr;
  13605. std::string selected_subprotocol;
  13606. auto answer_before_upgrade = [&]() -> bool {
  13607. if (pre_routing_handler_ &&
  13608. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  13609. return true;
  13610. }
  13611. for (const auto &entry : websocket_handlers_) {
  13612. if (!entry.matcher->match(req)) { continue; }
  13613. req.matched_route = entry.matcher->pattern();
  13614. if (pre_request_handler_ &&
  13615. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  13616. return true;
  13617. }
  13618. ws_route = &entry;
  13619. if (entry.sub_protocol_selector) {
  13620. auto protocol_header = detail::get_combined_header_value(
  13621. req.headers, "Sec-WebSocket-Protocol");
  13622. if (!protocol_header.empty()) {
  13623. std::vector<std::string> protocols;
  13624. detail::split(protocol_header.data(),
  13625. protocol_header.data() + protocol_header.size(), ',',
  13626. [&](const char *b, const char *e) {
  13627. protocols.emplace_back(b, e);
  13628. });
  13629. selected_subprotocol = entry.sub_protocol_selector(protocols);
  13630. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  13631. if (std::find(protocols.begin(), protocols.end(),
  13632. selected_subprotocol) == protocols.end()) {
  13633. selected_subprotocol.clear();
  13634. }
  13635. }
  13636. }
  13637. return false;
  13638. }
  13639. return false;
  13640. };
  13641. auto answered = false;
  13642. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13643. answered = answer_before_upgrade();
  13644. #else
  13645. try {
  13646. answered = answer_before_upgrade();
  13647. } catch (...) {
  13648. if (!handle_exception(req, res)) {
  13649. return write_response(strm, close_if_answered, req, res);
  13650. }
  13651. answered = true;
  13652. }
  13653. #endif
  13654. if (answered) {
  13655. if (res.status == -1) { res.status = StatusCode::OK_200; }
  13656. return write_response_with_content(strm, close_if_answered, req, res);
  13657. }
  13658. if (ws_route) {
  13659. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  13660. auto accept_key = detail::websocket_accept_key(client_key);
  13661. // Send 101 Switching Protocols
  13662. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  13663. "Upgrade: websocket\r\n"
  13664. "Connection: Upgrade\r\n"
  13665. "Sec-WebSocket-Accept: " +
  13666. accept_key + "\r\n";
  13667. if (!selected_subprotocol.empty()) {
  13668. if (!detail::fields::is_field_value(selected_subprotocol)) {
  13669. return false;
  13670. }
  13671. handshake_response +=
  13672. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  13673. }
  13674. handshake_response += "\r\n";
  13675. if (strm.write(handshake_response.data(), handshake_response.size()) <
  13676. 0) {
  13677. return false;
  13678. }
  13679. connection_closed = true;
  13680. if (websocket_upgraded) { *websocket_upgraded = true; }
  13681. auto stopping = [this] { return is_stopping(); };
  13682. if (CPPHTTPLIB_WEBSOCKET_TCP_NODELAY) {
  13683. set_socket_opt(strm.socket(), IPPROTO_TCP, TCP_NODELAY, 1);
  13684. }
  13685. #ifdef CPPHTTPLIB_SSL_ENABLED
  13686. if (req.ssl) {
  13687. // wss: the heartbeat ping thread and the read path enter the same
  13688. // TLS session from different threads. Hand the WebSocket a stream
  13689. // that serializes every TLS call, so the shared SSLSocketStream on
  13690. // the plain HTTP/HTTPS paths stays untouched.
  13691. auto ws_strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  13692. strm.socket(), const_cast<tls::session_t>(req.ssl),
  13693. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  13694. write_timeout_sec_, write_timeout_usec_));
  13695. ws::WebSocket ws(std::move(ws_strm), req, true,
  13696. websocket_ping_interval_sec_,
  13697. websocket_max_missed_pongs_, stopping);
  13698. ws_route->handler(req, ws);
  13699. return true;
  13700. }
  13701. #endif
  13702. // Use WebSocket-specific read timeout instead of HTTP timeout
  13703. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0);
  13704. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  13705. websocket_max_missed_pongs_, stopping);
  13706. ws_route->handler(req, ws);
  13707. return true;
  13708. }
  13709. // No WebSocket route: route it as a plain HTTP request
  13710. }
  13711. // Routing
  13712. auto routed = false;
  13713. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13714. routed = routing(req, res, strm, is_upgrade);
  13715. #else
  13716. try {
  13717. routed = routing(req, res, strm, is_upgrade);
  13718. } catch (...) { routed = handle_exception(req, res); }
  13719. #endif
  13720. auto ret = false;
  13721. if (routed) {
  13722. if (res.status == -1) {
  13723. res.status = req.ranges.empty() ? StatusCode::OK_200
  13724. : StatusCode::PartialContent_206;
  13725. }
  13726. // Before the Range checks below, so they see the body's own length.
  13727. detail::prefer_assigned_body(res);
  13728. // Serve file content by using a content provider
  13729. auto file_open_error = false;
  13730. if (!res.file_content_path_.empty()) {
  13731. const auto &path = res.file_content_path_;
  13732. auto mm = std::make_shared<detail::mmap>(path.c_str());
  13733. if (!mm->is_open()) {
  13734. res.status = StatusCode::NotFound_404;
  13735. output_error_log(Error::OpenFile, &req);
  13736. file_open_error = true;
  13737. } else {
  13738. auto content_type = res.file_content_content_type_;
  13739. if (content_type.empty()) {
  13740. // One the handler set after set_file_content()
  13741. content_type = res.get_header_value("Content-Type");
  13742. }
  13743. if (content_type.empty()) {
  13744. content_type = detail::find_content_type(
  13745. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  13746. }
  13747. detail::set_file_content_provider(
  13748. res, mm, content_type,
  13749. static_file_encoding(req, res, content_type, mm->size()));
  13750. }
  13751. }
  13752. if (file_open_error) {
  13753. ret = write_response(strm, close_after_response, req, res);
  13754. } else if (detail::range_error(req, res)) {
  13755. detail::clear_content(res);
  13756. res.status = StatusCode::RangeNotSatisfiable_416;
  13757. ret = write_response(strm, close_after_response, req, res);
  13758. } else {
  13759. ret = write_response_with_content(strm, close_after_response, req, res);
  13760. }
  13761. } else {
  13762. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  13763. ret = write_response(strm, close_after_response, req, res);
  13764. }
  13765. // Drain any unconsumed framed body to prevent request smuggling on
  13766. // keep-alive. Without framing there is no body to drain — reading would
  13767. // consume the next request (issue #2450). If the response has committed the
  13768. // connection to close, there is no next request to protect. A body read in
  13769. // part cannot be drained from where it stopped, so the connection closes,
  13770. // as it does when the body is longer than the drain limit or does not
  13771. // arrive within the read timeout.
  13772. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  13773. !detail::has_header_token(res.headers, "Connection", "close")) {
  13774. strm.set_max_timeout(read_timeout_msec);
  13775. int dummy_status;
  13776. if (req.body_read_started_ ||
  13777. !detail::read_content(
  13778. strm, req, CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH, dummy_status,
  13779. nullptr, [](const char *, size_t, size_t, size_t) { return true; },
  13780. false)) {
  13781. connection_closed = true;
  13782. }
  13783. }
  13784. return ret;
  13785. }
  13786. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  13787. inline bool Server::process_and_close_socket(socket_t sock) {
  13788. std::string remote_addr;
  13789. int remote_port = 0;
  13790. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  13791. std::string local_addr;
  13792. int local_port = 0;
  13793. detail::get_local_ip_and_port(sock, local_addr, local_port);
  13794. bool websocket_upgraded = false;
  13795. auto ret = serve_guarded([&]() {
  13796. return detail::process_server_socket(
  13797. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  13798. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13799. write_timeout_usec_,
  13800. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  13801. return process_request(strm, remote_addr, remote_port, local_addr,
  13802. local_port, close_connection,
  13803. connection_closed, nullptr,
  13804. &websocket_upgraded);
  13805. });
  13806. });
  13807. detail::drain_and_close_socket(sock);
  13808. return ret;
  13809. }
  13810. inline void Server::output_log(const Request &req, const Response &res) const {
  13811. if (logger_) {
  13812. std::lock_guard<std::mutex> guard(logger_mutex_);
  13813. logger_(req, res);
  13814. }
  13815. }
  13816. inline void Server::output_pre_compression_log(const Request &req,
  13817. const Response &res) const {
  13818. if (pre_compression_logger_) {
  13819. std::lock_guard<std::mutex> guard(logger_mutex_);
  13820. pre_compression_logger_(req, res);
  13821. }
  13822. }
  13823. inline void Server::output_error_log(const Error &err,
  13824. const Request *req) const {
  13825. if (error_logger_) {
  13826. std::lock_guard<std::mutex> guard(logger_mutex_);
  13827. error_logger_(err, req);
  13828. }
  13829. }
  13830. /*
  13831. * Group 5: ClientImpl and Client (Universal) implementation
  13832. */
  13833. // HTTP client implementation
  13834. inline ClientImpl::ClientImpl(const std::string &host)
  13835. : ClientImpl(host, 80, std::string(), std::string()) {}
  13836. inline ClientImpl::ClientImpl(const std::string &host, int port)
  13837. : ClientImpl(host, port, std::string(), std::string()) {}
  13838. inline ClientImpl::ClientImpl(const std::string &host, int port,
  13839. const std::string &client_cert_path,
  13840. const std::string &client_key_path)
  13841. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  13842. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  13843. inline ClientImpl::~ClientImpl() {
  13844. // Wait until all the requests in flight are handled.
  13845. size_t retry_count = 10;
  13846. while (retry_count-- > 0) {
  13847. {
  13848. std::lock_guard<std::mutex> guard(socket_mutex_);
  13849. if (socket_requests_in_flight_ == 0) { break; }
  13850. }
  13851. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  13852. }
  13853. std::lock_guard<std::mutex> guard(socket_mutex_);
  13854. shutdown_socket(socket_);
  13855. close_socket(socket_);
  13856. }
  13857. inline bool ClientImpl::is_valid() const { return true; }
  13858. inline bool
  13859. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  13860. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  13861. if (no_proxy_entries_.empty()) { return true; }
  13862. // host_ is const so its normalized form is invariant; cache it. The
  13863. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  13864. if (host == host_) {
  13865. if (!host_normalized_valid_) {
  13866. host_normalized_ = detail::normalize_target(host_);
  13867. host_normalized_valid_ = true;
  13868. }
  13869. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13870. }
  13871. auto target = detail::normalize_target(host);
  13872. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13873. }
  13874. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13875. if (is_proxy_enabled_for_host(host_)) {
  13876. return detail::create_client_socket(
  13877. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13878. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13879. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13880. write_timeout_sec_, write_timeout_usec_, interface_, error,
  13881. stop_interrupt());
  13882. }
  13883. // Check is custom IP or hostname specified for host_
  13884. std::string connect_host;
  13885. std::string ip;
  13886. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13887. return detail::create_client_socket(
  13888. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13889. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13890. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13891. write_timeout_usec_, interface_, error, stop_interrupt());
  13892. }
  13893. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13894. Error &error) {
  13895. auto sock = create_client_socket(error);
  13896. if (sock == INVALID_SOCKET) { return false; }
  13897. socket.sock = sock;
  13898. return true;
  13899. }
  13900. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13901. socket_tls_settings_version_ = tls_settings_version_;
  13902. return create_and_connect_socket(socket, error);
  13903. }
  13904. inline bool ClientImpl::setup_proxy_connection(
  13905. Socket & /*socket*/,
  13906. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13907. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13908. return true;
  13909. }
  13910. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13911. bool /*shutdown_gracefully*/) {
  13912. // If there are any requests in flight from threads other than us, then it's
  13913. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13914. assert(socket_requests_in_flight_ == 0 ||
  13915. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13916. }
  13917. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13918. if (socket.sock == INVALID_SOCKET) { return; }
  13919. detail::shutdown_socket(socket.sock);
  13920. }
  13921. inline void ClientImpl::close_socket(Socket &socket) {
  13922. // If there are requests in flight in another thread, usually closing
  13923. // the socket will be fine and they will simply receive an error when
  13924. // using the closed socket, but it is still a bug since rarely the OS
  13925. // may reassign the socket id to be used for a new socket, and then
  13926. // suddenly they will be operating on a live socket that is different
  13927. // than the one they intended!
  13928. assert(socket_requests_in_flight_ == 0 ||
  13929. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13930. // It is also a bug if this happens while SSL is still active
  13931. #ifdef CPPHTTPLIB_SSL_ENABLED
  13932. assert(socket.ssl == nullptr);
  13933. #endif
  13934. if (socket.sock == INVALID_SOCKET) { return; }
  13935. detail::close_socket(socket.sock);
  13936. socket.sock = INVALID_SOCKET;
  13937. }
  13938. inline void ClientImpl::disconnect(bool gracefully) {
  13939. shutdown_ssl(socket_, gracefully);
  13940. shutdown_socket(socket_);
  13941. close_socket(socket_);
  13942. }
  13943. inline bool ClientImpl::socket_reusable() {
  13944. if (!socket_.is_open()) { return false; }
  13945. // RFC 9112 9.2: data with no request outstanding is not a response
  13946. if (detail::select_read(socket_.sock, 0, 0) != 0) {
  13947. disconnect(/*gracefully=*/false);
  13948. return false;
  13949. }
  13950. if (is_ssl() && socket_tls_settings_version_ != tls_settings_version_) {
  13951. disconnect(/*gracefully=*/true);
  13952. return false;
  13953. }
  13954. return true;
  13955. }
  13956. inline bool ClientImpl::prepare_socket(
  13957. std::unique_lock<std::mutex> &guard,
  13958. std::chrono::time_point<std::chrono::steady_clock> start_time,
  13959. Response &res, bool &success, Error &error) {
  13960. auto opened = true;
  13961. if (!socket_reusable()) {
  13962. Socket socket;
  13963. guard.unlock();
  13964. opened = ensure_socket_connection(socket, error);
  13965. if (opened) {
  13966. opened = setup_proxy_connection(socket, start_time, res, success, error);
  13967. } else {
  13968. success = false;
  13969. }
  13970. guard.lock();
  13971. socket_ = socket;
  13972. }
  13973. if (stop_requested_) {
  13974. disconnect(/*gracefully=*/false);
  13975. error = Error::Canceled;
  13976. success = false;
  13977. return false;
  13978. }
  13979. return opened;
  13980. }
  13981. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13982. Response &res,
  13983. bool skip_100_continue) const {
  13984. std::array<char, 2048> buf{};
  13985. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13986. if (!line_reader.getline()) { return false; }
  13987. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13988. res.reason)) {
  13989. return req.method == "CONNECT";
  13990. }
  13991. // Skip interim (1xx) responses along with their header fields, except a 100
  13992. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13993. // HTTP on the connection, so it is final. A server sending them without end
  13994. // would hold the client, so there may be only so many.
  13995. size_t interim_count = 0;
  13996. while (100 <= res.status && res.status < 200 &&
  13997. res.status != StatusCode::SwitchingProtocol_101 &&
  13998. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13999. if (++interim_count > CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT) {
  14000. return false;
  14001. }
  14002. Headers interim_headers;
  14003. if (!detail::read_headers(strm, interim_headers)) { return false; }
  14004. if (!line_reader.getline()) { return false; } // next response line
  14005. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  14006. res.reason)) {
  14007. return false;
  14008. }
  14009. }
  14010. return true;
  14011. }
  14012. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  14013. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14014. // A same-origin redirect and a digest retry send through here again. Only
  14015. // the call the caller made reports a failure, once, with its request.
  14016. auto outermost = send_depth_++ == 0;
  14017. auto se = detail::scope_exit([&] { send_depth_--; });
  14018. if (outermost) {
  14019. error = Error::Success;
  14020. stop_requested_ = false;
  14021. }
  14022. auto ret = send_(req, res, error);
  14023. if (error == Error::SSLPeerCouldBeClosed_) {
  14024. assert(!ret);
  14025. ret = send_(req, res, error);
  14026. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  14027. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  14028. }
  14029. // Also an answer that carries an error, such as a proxy's 407
  14030. if (outermost && error != Error::Success) { output_error_log(error, &req); }
  14031. return ret;
  14032. }
  14033. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  14034. #ifdef CPPHTTPLIB_SSL_ENABLED
  14035. // Don't let an earlier attempt's TLS error show up in this one's Result. A
  14036. // client that failed to set up its TLS context keeps reporting why.
  14037. if (is_valid()) {
  14038. last_ssl_error_ = 0;
  14039. last_backend_error_ = 0;
  14040. }
  14041. #endif
  14042. {
  14043. std::unique_lock<std::mutex> guard(socket_mutex_);
  14044. // Set this to false immediately - if it ever gets set to true by the end
  14045. // of the request, we know another thread instructed us to close the
  14046. // socket.
  14047. socket_should_be_closed_when_request_is_done_ = false;
  14048. auto success = true;
  14049. if (!prepare_socket(guard, req.start_time_, res, success, error)) {
  14050. return success;
  14051. }
  14052. // Mark the current socket as being in use so that it cannot be closed by
  14053. // anyone else while this request is ongoing, even though we will be
  14054. // releasing the mutex.
  14055. if (socket_requests_in_flight_ > 1) {
  14056. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  14057. }
  14058. socket_requests_in_flight_ += 1;
  14059. socket_requests_are_from_thread_ = std::this_thread::get_id();
  14060. }
  14061. for (const auto &header : default_headers_) {
  14062. if (req.headers.find(header.first) == req.headers.end()) {
  14063. req.headers.insert(header);
  14064. }
  14065. }
  14066. auto ret = false;
  14067. auto close_connection = !keep_alive_;
  14068. auto se = detail::scope_exit([&]() {
  14069. // Briefly lock mutex in order to mark that a request is no longer ongoing
  14070. std::lock_guard<std::mutex> guard(socket_mutex_);
  14071. socket_requests_in_flight_ -= 1;
  14072. if (socket_requests_in_flight_ <= 0) {
  14073. assert(socket_requests_in_flight_ == 0);
  14074. socket_requests_are_from_thread_ = std::thread::id();
  14075. }
  14076. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  14077. !ret) {
  14078. disconnect(/*gracefully=*/true);
  14079. }
  14080. });
  14081. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  14082. strm.set_read_interrupt(stop_interrupt());
  14083. return handle_request(strm, req, res, close_connection, error);
  14084. });
  14085. if (!ret) {
  14086. if (error == Error::Success) { error = Error::Unknown; }
  14087. }
  14088. return ret;
  14089. }
  14090. inline Result ClientImpl::send(const Request &req) {
  14091. auto req2 = req;
  14092. return send_(std::move(req2));
  14093. }
  14094. inline Result ClientImpl::send_(Request &&req) {
  14095. auto res = detail::make_unique<Response>();
  14096. auto error = Error::Success;
  14097. #ifdef CPPHTTPLIB_SSL_ENABLED
  14098. // Hold the request lock until the Result has read this request's TLS error
  14099. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14100. #endif
  14101. auto ret = send(req, *res, error);
  14102. #ifdef CPPHTTPLIB_SSL_ENABLED
  14103. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  14104. last_ssl_error_, last_backend_error_};
  14105. #else
  14106. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  14107. #endif
  14108. }
  14109. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  14110. const std::string &ct) {
  14111. (void)for_stream;
  14112. // Default headers are meant for the origin and may carry its credentials, so
  14113. // keep them off the CONNECT request the proxy reads.
  14114. if (r.method != "CONNECT") {
  14115. for (const auto &header : default_headers_) {
  14116. if (!r.has_header(header.first)) { r.headers.insert(header); }
  14117. }
  14118. }
  14119. // RFC 9110 5.3 recommends sending control data such as Host first, so
  14120. // prepend it rather than appending it after the caller's own fields.
  14121. if (!r.has_header("Host")) {
  14122. r.headers.emplace_front(
  14123. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  14124. address_family_));
  14125. }
  14126. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  14127. if (!r.content_receiver) {
  14128. if (!r.has_header("Accept-Encoding")) {
  14129. std::string accept_encoding;
  14130. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  14131. accept_encoding = "br";
  14132. #endif
  14133. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  14134. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  14135. accept_encoding += "gzip, deflate";
  14136. #endif
  14137. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  14138. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  14139. accept_encoding += "zstd";
  14140. #endif
  14141. r.set_header("Accept-Encoding", accept_encoding);
  14142. }
  14143. detail::add_default_user_agent_header(r);
  14144. }
  14145. if (!r.body.empty()) {
  14146. if (!ct.empty() && !r.has_header("Content-Type")) {
  14147. r.headers.emplace("Content-Type", ct);
  14148. }
  14149. if (!r.has_header("Content-Length")) {
  14150. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  14151. }
  14152. }
  14153. }
  14154. inline ClientImpl::StreamHandle
  14155. ClientImpl::open_stream(const std::string &method, const std::string &path,
  14156. const Params &params, const Headers &headers,
  14157. const std::string &body,
  14158. const std::string &content_type) {
  14159. // Encode the target exactly like the buffered send path does, so that the
  14160. // same `path` produces the same request line through either API.
  14161. auto raw_query_path =
  14162. params.empty() ? path : append_query_params(path, params);
  14163. Request req;
  14164. req.method = method;
  14165. req.path = detail::encode_request_target(raw_query_path, path_encode_);
  14166. req.headers = headers;
  14167. req.body = body;
  14168. prepare_default_headers(req, true, content_type);
  14169. auto handle = open_stream_(req);
  14170. // Like a buffered request, a stream that fails to open is reported once
  14171. if (handle.error != Error::Success) { output_error_log(handle.error, &req); }
  14172. return handle;
  14173. }
  14174. inline ClientImpl::StreamHandle ClientImpl::open_stream_(Request &req) {
  14175. StreamHandle handle;
  14176. handle.response = detail::make_unique<Response>();
  14177. handle.error = Error::Success;
  14178. handle.connection_ = detail::make_unique<ClientConnection>();
  14179. {
  14180. // A request in flight uses socket_ without holding socket_mutex_
  14181. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14182. if (send_depth_ == 0) { stop_requested_ = false; }
  14183. std::unique_lock<std::mutex> guard(socket_mutex_);
  14184. auto success = true;
  14185. if (!prepare_socket(guard, std::chrono::steady_clock::now(),
  14186. *handle.response, success, handle.error)) {
  14187. if (!success) { handle.response.reset(); }
  14188. return handle;
  14189. }
  14190. transfer_socket_ownership_to_handle(handle);
  14191. }
  14192. #ifdef CPPHTTPLIB_SSL_ENABLED
  14193. if (is_ssl() && handle.connection_->session) {
  14194. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  14195. handle.connection_->sock, handle.connection_->session,
  14196. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14197. write_timeout_usec_);
  14198. } else {
  14199. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  14200. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  14201. write_timeout_sec_, write_timeout_usec_);
  14202. }
  14203. #else
  14204. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  14205. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  14206. write_timeout_sec_, write_timeout_usec_);
  14207. #endif
  14208. handle.stream_ = handle.socket_stream_.get();
  14209. auto &strm = *handle.stream_;
  14210. // Only for the head, as the handle may outlive this client
  14211. strm.set_read_interrupt(stop_interrupt());
  14212. auto release_interrupt =
  14213. detail::scope_exit([&] { strm.set_read_interrupt(nullptr); });
  14214. // After connecting, as for a buffered request
  14215. add_credential_headers(req);
  14216. // Build the request line and headers in memory first, like write_request()
  14217. // does, so that a rejected header leaves nothing on the wire.
  14218. {
  14219. detail::BufferStream bstrm;
  14220. // The path follows the authority in absolute-form, so one that does not
  14221. // begin with '/' (e.g. "@evil.example/x") would name another host.
  14222. auto prefix = proxy_target_prefix();
  14223. if ((!prefix.empty() && req.path[0] != '/') ||
  14224. detail::write_request_line(bstrm, req.method, prefix + req.path) < 0) {
  14225. handle.error = Error::Write;
  14226. handle.response.reset();
  14227. return handle;
  14228. }
  14229. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14230. handle.error)) {
  14231. handle.response.reset();
  14232. return handle;
  14233. }
  14234. const auto &data = bstrm.get_buffer();
  14235. if (!detail::write_data(strm, data.data(), data.size())) {
  14236. handle.error = Error::Write;
  14237. handle.response.reset();
  14238. return handle;
  14239. }
  14240. }
  14241. if (!req.body.empty()) {
  14242. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14243. handle.error = Error::Write;
  14244. handle.response.reset();
  14245. return handle;
  14246. }
  14247. }
  14248. if (!read_response_line(strm, req, *handle.response) ||
  14249. !detail::read_headers(strm, handle.response->headers)) {
  14250. handle.error = Error::Read;
  14251. handle.response.reset();
  14252. return handle;
  14253. }
  14254. handle.body_reader_.stream = handle.stream_;
  14255. handle.body_reader_.payload_max_length = payload_max_length_;
  14256. // RFC 9112 6.3: a response to HEAD, and a 204 or 304 response, ends with its
  14257. // header section, so none of its framing or coding headers apply.
  14258. if (req.method == "HEAD" ||
  14259. handle.response->status == StatusCode::NoContent_204 ||
  14260. handle.response->status == StatusCode::NotModified_304) {
  14261. handle.body_reader_.eof = true;
  14262. return handle;
  14263. }
  14264. // Same framing check as ClientImpl::process_request()
  14265. if (detail::has_conflicting_content_length(handle.response->headers)) {
  14266. handle.error = Error::Read;
  14267. handle.response.reset();
  14268. return handle;
  14269. }
  14270. if (handle.response->has_header("Content-Length")) {
  14271. bool is_invalid = false;
  14272. auto content_length = detail::get_header_value_u64(
  14273. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  14274. if (is_invalid) {
  14275. handle.error = Error::Read;
  14276. handle.response.reset();
  14277. return handle;
  14278. }
  14279. handle.body_reader_.has_content_length = true;
  14280. handle.body_reader_.content_length = content_length;
  14281. }
  14282. handle.body_reader_.chunked =
  14283. detail::is_chunked_transfer_encoding(handle.response->headers);
  14284. auto content_encoding = detail::get_combined_header_value(
  14285. handle.response->headers, "Content-Encoding");
  14286. if (decompress_ && !content_encoding.empty()) {
  14287. // Same policy as prepare_content_receiver(): reject a coding we know about
  14288. // but were not built with, pass an unrecognized one through as-is.
  14289. handle.decompressor_ = detail::create_decompressor(content_encoding);
  14290. if (!handle.decompressor_) {
  14291. if (detail::is_known_content_encoding(content_encoding)) {
  14292. handle.error = Error::UnsupportedContentEncoding;
  14293. handle.response.reset();
  14294. return handle;
  14295. }
  14296. } else if (!handle.decompressor_->is_valid()) {
  14297. handle.error = Error::Compression;
  14298. handle.response.reset();
  14299. return handle;
  14300. }
  14301. }
  14302. return handle;
  14303. }
  14304. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  14305. if (!is_valid() || !response) { return -1; }
  14306. auto n = decompressor_
  14307. ? read_with_decompression(buf, len)
  14308. : detail::read_body_content(stream_, body_reader_, buf, len);
  14309. if (n == 0) { parse_trailers_if_needed(); }
  14310. return n;
  14311. }
  14312. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  14313. size_t len) {
  14314. if (decompress_offset_ < decompress_buffer_.size()) {
  14315. auto available = decompress_buffer_.size() - decompress_offset_;
  14316. auto to_copy = (std::min)(len, available);
  14317. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  14318. decompress_offset_ += to_copy;
  14319. decompressed_bytes_read_ += to_copy;
  14320. return static_cast<ssize_t>(to_copy);
  14321. }
  14322. decompress_buffer_.clear();
  14323. decompress_offset_ = 0;
  14324. constexpr size_t kDecompressionBufferSize = 8192;
  14325. char compressed_buf[kDecompressionBufferSize];
  14326. while (true) {
  14327. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  14328. sizeof(compressed_buf));
  14329. if (n <= 0) { return n; }
  14330. auto exceeded = false;
  14331. bool decompress_ok = decompressor_->decompress(
  14332. compressed_buf, static_cast<size_t>(n),
  14333. [&](const char *data, size_t data_len) {
  14334. decompress_buffer_.append(data, data_len);
  14335. auto limit = body_reader_.payload_max_length;
  14336. exceeded =
  14337. limit > 0 &&
  14338. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  14339. return !exceeded;
  14340. });
  14341. if (!decompress_ok) {
  14342. body_reader_.last_error =
  14343. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  14344. return -1;
  14345. }
  14346. if (!decompress_buffer_.empty()) { break; }
  14347. }
  14348. auto to_copy = (std::min)(len, decompress_buffer_.size());
  14349. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  14350. decompress_offset_ = to_copy;
  14351. decompressed_bytes_read_ += to_copy;
  14352. return static_cast<ssize_t>(to_copy);
  14353. }
  14354. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  14355. // The trailers follow the last chunk, so there are none before it
  14356. auto &decoder = body_reader_.chunked_decoder;
  14357. if (!response || trailers_parsed_ || !decoder || !decoder->finished) {
  14358. return;
  14359. }
  14360. trailers_parsed_ = true;
  14361. decoder->parse_trailers_into(response->trailers, response->headers);
  14362. }
  14363. namespace detail {
  14364. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  14365. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  14366. size_t &out_chunk_offset,
  14367. size_t &out_chunk_total) {
  14368. if (finished) { return 0; }
  14369. if (chunk_remaining == 0) {
  14370. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  14371. if (!lr.getline()) { return -1; }
  14372. // Everything below is bounded by eol rather than by the buffer's NUL, so
  14373. // the line terminator is never mistaken for line content.
  14374. const char *eol = lr.ptr() + lr.size();
  14375. if (lr.end_with_crlf()) {
  14376. eol -= 2;
  14377. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  14378. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  14379. // getline() ends the line on a bare LF. That LF is the terminator, so it
  14380. // has to come off here or the check below would reject the line.
  14381. eol -= 1;
  14382. }
  14383. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  14384. const char *p = lr.ptr();
  14385. int v = 0;
  14386. if (p == eol || !is_hex(*p, v)) { return -1; }
  14387. size_t chunk_len = 0;
  14388. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  14389. for (; p < eol && is_hex(*p, v); ++p) {
  14390. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  14391. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  14392. }
  14393. while (p < eol && is_space_or_tab(*p)) {
  14394. ++p;
  14395. }
  14396. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  14397. // terminator, and it is built from tokens and quoted-strings, so it never
  14398. // holds a CR, LF or any other control character. getline() reads up to the
  14399. // CRLF, so a bare LF left in here would be swallowed as extension text
  14400. // while an intermediary that ends the line on it delimits the chunks
  14401. // differently, and the two disagree on where the body ends (request
  14402. // smuggling).
  14403. if (p < eol && *p != ';') { return -1; }
  14404. for (; p < eol; ++p) {
  14405. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  14406. }
  14407. // The bytes around the data are no payload, so they are counted on their
  14408. // own, as Go does: each chunk may spend 16 bytes and twice its data on
  14409. // them, which lets a stream send a byte at a time, and what goes past that
  14410. // in padding, leading zeros and extensions builds up to one header field.
  14411. overhead += lr.size() + 2;
  14412. overhead = overhead > 16 ? overhead - 16 : 0;
  14413. overhead = chunk_len > overhead / 2 ? 0 : overhead - 2 * chunk_len;
  14414. if (overhead > CPPHTTPLIB_HEADER_MAX_LENGTH) { return -1; }
  14415. if (chunk_len == 0) {
  14416. chunk_remaining = 0;
  14417. finished = true;
  14418. out_chunk_offset = 0;
  14419. out_chunk_total = 0;
  14420. return 0;
  14421. }
  14422. chunk_remaining = chunk_len;
  14423. last_chunk_total = chunk_remaining;
  14424. last_chunk_offset = 0;
  14425. }
  14426. auto to_read = (std::min)(chunk_remaining, len);
  14427. auto n = strm.read(buf, to_read);
  14428. if (n <= 0) { return -1; }
  14429. auto offset_before = last_chunk_offset;
  14430. last_chunk_offset += static_cast<size_t>(n);
  14431. chunk_remaining -= static_cast<size_t>(n);
  14432. out_chunk_offset = offset_before;
  14433. out_chunk_total = last_chunk_total;
  14434. if (chunk_remaining == 0) {
  14435. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  14436. if (!lr.getline()) { return -1; }
  14437. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  14438. }
  14439. return n;
  14440. }
  14441. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  14442. const Headers &src_headers) {
  14443. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  14444. if (!lr.getline()) { return false; }
  14445. return parse_trailers(lr, dest, src_headers);
  14446. }
  14447. // Only 301, 302, 303, 307 and 308 redirect. Any other 3xx, such as a 304, or
  14448. // a redirect without a Location, is a final response.
  14449. inline bool is_redirect(const Response &res) {
  14450. switch (res.status) {
  14451. case StatusCode::MovedPermanently_301:
  14452. case StatusCode::Found_302:
  14453. case StatusCode::SeeOther_303:
  14454. case StatusCode::TemporaryRedirect_307:
  14455. case StatusCode::PermanentRedirect_308:
  14456. return !res.get_header_value("Location").empty();
  14457. default: return false;
  14458. }
  14459. }
  14460. } // namespace detail
  14461. inline void
  14462. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  14463. handle.connection_->sock = socket_.sock;
  14464. #ifdef CPPHTTPLIB_SSL_ENABLED
  14465. handle.connection_->session = socket_.ssl;
  14466. socket_.ssl = nullptr;
  14467. #endif
  14468. socket_.sock = INVALID_SOCKET;
  14469. }
  14470. // A plain HTTP proxy reads the target in absolute-form (RFC 9112 3.2.2)
  14471. inline std::string ClientImpl::proxy_target_prefix() const {
  14472. if (is_ssl() || !is_proxy_enabled_for_host(host_)) { return std::string(); }
  14473. return "http://" + detail::make_host_and_port_string(host_, port_, false);
  14474. }
  14475. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  14476. Response &res, bool close_connection,
  14477. Error &error) {
  14478. if (req.path.empty()) {
  14479. error = Error::Connection;
  14480. return false;
  14481. }
  14482. auto req_save = req;
  14483. bool ret;
  14484. auto prefix = proxy_target_prefix();
  14485. if (!prefix.empty()) {
  14486. // The path follows the authority in absolute-form, so one that does not
  14487. // begin with '/' (e.g. "@evil.example/x") would name another host.
  14488. if (req.path[0] != '/') {
  14489. error = Error::Write;
  14490. return false;
  14491. }
  14492. auto req2 = req;
  14493. req2.path = prefix + req.path;
  14494. ret = process_request(strm, req2, res, close_connection, error);
  14495. req = std::move(req2);
  14496. req.path = req_save.path;
  14497. } else {
  14498. ret = process_request(strm, req, res, close_connection, error);
  14499. }
  14500. if (!ret) { return false; }
  14501. {
  14502. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  14503. // for this to be safe.
  14504. // This is safe to call because handle_request is only called by send_
  14505. // which locks the request mutex during the process. It would be a bug
  14506. // to call it from a different thread since it's a thread-safety issue
  14507. // to do these things to the socket if another thread is using the socket.
  14508. std::lock_guard<std::mutex> guard(socket_mutex_);
  14509. // Also when the request asked for it (e.g. a body that was never sent,
  14510. // or "Connection: close") or bytes follow the response (RFC 9112 9.2), so
  14511. // that a redirect or an auth retry below does not reuse the socket.
  14512. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  14513. strm.is_readable() ||
  14514. detail::has_header_token(res.headers, "Connection", "close") ||
  14515. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  14516. disconnect(/*gracefully=*/true);
  14517. }
  14518. }
  14519. if (follow_location_ && detail::is_redirect(res)) {
  14520. req = std::move(req_save);
  14521. // The client that followed the redirect has answered any challenge it
  14522. // could. Retrying below would sign another host's challenge and send it
  14523. // here.
  14524. return redirect(req, res, error);
  14525. }
  14526. #ifdef CPPHTTPLIB_SSL_ENABLED
  14527. if ((res.status == StatusCode::Unauthorized_401 ||
  14528. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  14529. req.authorization_count_ < 5) {
  14530. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  14531. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  14532. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  14533. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  14534. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  14535. return ret;
  14536. }
  14537. const auto &username =
  14538. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  14539. const auto &password =
  14540. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  14541. if (!username.empty() && !password.empty()) {
  14542. std::map<std::string, std::string> auth;
  14543. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  14544. Request new_req = req;
  14545. new_req.authorization_count_ += 1;
  14546. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  14547. : "Authorization");
  14548. new_req.headers.insert(detail::make_digest_authentication_header(
  14549. req, make_request_target(req), auth, new_req.authorization_count_,
  14550. detail::random_string(10), username, password, is_proxy));
  14551. Response new_res;
  14552. ret = send(new_req, new_res, error);
  14553. if (ret) { res = std::move(new_res); }
  14554. }
  14555. }
  14556. }
  14557. #endif
  14558. return ret;
  14559. }
  14560. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  14561. if (req.redirect_count_ == 0) {
  14562. error = Error::ExceedRedirectCount;
  14563. return false;
  14564. }
  14565. auto location = res.get_header_value("location");
  14566. if (location.empty()) { return false; }
  14567. auto next_url = detail::resolve_relative_location(location, req.path);
  14568. detail::UrlComponents uc;
  14569. if (!detail::parse_url(next_url, uc)) { return false; }
  14570. // Follow only http/https URLs and references starting with '/'
  14571. if (next_url[0] != '/' && uc.scheme != "http" && uc.scheme != "https") {
  14572. return false;
  14573. }
  14574. auto scheme = is_ssl() ? "https" : "http";
  14575. auto next_scheme = std::move(uc.scheme);
  14576. auto next_host = std::move(uc.host);
  14577. auto port_str = std::move(uc.port);
  14578. auto next_path = std::move(uc.path);
  14579. auto next_query = std::move(uc.query);
  14580. auto next_port = port_;
  14581. if (!port_str.empty()) {
  14582. if (!detail::parse_port(port_str, next_port)) { return false; }
  14583. } else if (!next_scheme.empty()) {
  14584. next_port = next_scheme == "https" ? 443 : 80;
  14585. }
  14586. if (next_scheme.empty()) { next_scheme = scheme; }
  14587. if (next_host.empty()) { next_host = host_; }
  14588. if (next_path.empty()) { next_path = "/"; }
  14589. // An absolute or absolute-path location can have dot segments too.
  14590. if (next_path[0] == '/') {
  14591. next_path = detail::remove_dot_segments(next_path);
  14592. }
  14593. auto path = std::move(next_path) + next_query;
  14594. // A Unix socket client sends "Host: localhost", so a Location naming
  14595. // localhost names this client too.
  14596. auto is_same_host = next_host == host_ ||
  14597. (address_family_ == AF_UNIX && next_host == "localhost");
  14598. // Same host redirect - use current client
  14599. if (next_scheme == scheme && is_same_host && next_port == port_) {
  14600. return detail::redirect(*this, req, res, path, location, error);
  14601. }
  14602. // Cross-host/scheme redirect - create new client with robust setup
  14603. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  14604. path, location, error);
  14605. }
  14606. // New method for robust redirect client creation
  14607. inline bool ClientImpl::create_redirect_client(
  14608. const std::string &scheme, const std::string &host, int port, Request &req,
  14609. Response &res, const std::string &path, const std::string &location,
  14610. Error &error) {
  14611. // Determine if we need SSL
  14612. auto need_ssl = (scheme == "https");
  14613. // Clean up request headers that are host/client specific
  14614. // Remove headers that should not be carried over to new host
  14615. auto headers_to_remove = std::vector<std::string>{
  14616. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  14617. for (const auto &header_name : headers_to_remove) {
  14618. auto it = req.headers.find(header_name);
  14619. while (it != req.headers.end()) {
  14620. it = req.headers.erase(it);
  14621. it = req.headers.find(header_name);
  14622. }
  14623. }
  14624. // Create appropriate client type and handle redirect
  14625. if (need_ssl) {
  14626. #ifdef CPPHTTPLIB_SSL_ENABLED
  14627. // Create SSL client for HTTPS redirect
  14628. SSLClient redirect_client(host, port);
  14629. // Setup basic client configuration first
  14630. setup_redirect_client(redirect_client);
  14631. redirect_client.enable_server_certificate_verification(
  14632. server_certificate_verification_);
  14633. redirect_client.enable_server_hostname_verification(
  14634. server_hostname_verification_);
  14635. redirect_client.system_ca_mode_ = system_ca_mode_;
  14636. // Transfer CA certificate to redirect client
  14637. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  14638. if (is_ssl()) {
  14639. auto &self = static_cast<SSLClient &>(*this);
  14640. // A store given to set_ca_cert_store() lives only in this client's
  14641. // context, which then holds all that is trusted.
  14642. if (self.ca_cert_store_set_) {
  14643. std::string pem;
  14644. {
  14645. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  14646. pem = detail::ca_certs_to_pem(self.ctx_);
  14647. }
  14648. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  14649. redirect_client.ca_cert_store_set_ = true;
  14650. } else if (self.custom_ca_loaded_) {
  14651. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  14652. ca_cert_pem_.size());
  14653. }
  14654. redirect_client.set_session_verifier(self.session_verifier_);
  14655. if (self.server_certificate_verifier_) {
  14656. redirect_client.set_server_certificate_verifier(
  14657. self.server_certificate_verifier_);
  14658. }
  14659. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  14660. redirect_client.enable_windows_cert_verification_ =
  14661. self.enable_windows_cert_verification_;
  14662. #endif
  14663. }
  14664. // Client certificates are set through constructor for SSLClient
  14665. // NOTE: SSLClient constructor already takes client_cert_path and
  14666. // client_key_path so we need to create it properly if client certs are
  14667. // needed
  14668. // Execute the redirect
  14669. return detail::redirect(redirect_client, req, res, path, location, error);
  14670. #else
  14671. // SSL not supported - set appropriate error
  14672. error = Error::SSLConnection;
  14673. return false;
  14674. #endif
  14675. } else {
  14676. // HTTP redirect
  14677. ClientImpl redirect_client(host, port);
  14678. // Setup client with robust configuration
  14679. setup_redirect_client(redirect_client);
  14680. // Execute the redirect
  14681. return detail::redirect(redirect_client, req, res, path, location, error);
  14682. }
  14683. }
  14684. // New method for robust client setup (based on basic_manual_redirect.cpp
  14685. // logic)
  14686. template <typename ClientType>
  14687. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  14688. // Copy basic settings first
  14689. client.set_connection_timeout(connection_timeout_sec_,
  14690. connection_timeout_usec_);
  14691. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14692. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  14693. client.set_max_timeout(max_timeout_msec_);
  14694. if (has_payload_max_length_) {
  14695. client.set_payload_max_length(payload_max_length_);
  14696. }
  14697. client.set_keep_alive(keep_alive_);
  14698. client.set_follow_location(
  14699. true); // Enable redirects to handle multi-step redirects
  14700. client.set_path_encode(path_encode_);
  14701. client.set_compress(compress_);
  14702. client.set_decompress(decompress_);
  14703. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  14704. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  14705. // 15.4, credentials must not be forwarded when redirecting to a different
  14706. // host. This function is only called for cross-host redirects; same-host
  14707. // redirects are handled directly in ClientImpl::redirect().
  14708. // Copy the proxy configuration unconditionally; the per-target bypass is
  14709. // re-evaluated at send time, so a later hop to a non-bypassed host can
  14710. // still use the proxy.
  14711. client.no_proxy_entries_ = no_proxy_entries_;
  14712. if (!proxy_host_.empty() && proxy_port_ != -1) {
  14713. client.set_proxy(proxy_host_, proxy_port_);
  14714. if (!proxy_basic_auth_username_.empty() ||
  14715. !proxy_basic_auth_password_.empty()) {
  14716. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  14717. proxy_basic_auth_password_);
  14718. }
  14719. if (!proxy_bearer_token_auth_token_.empty()) {
  14720. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  14721. }
  14722. #ifdef CPPHTTPLIB_SSL_ENABLED
  14723. if (!proxy_digest_auth_username_.empty()) {
  14724. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  14725. proxy_digest_auth_password_);
  14726. }
  14727. #endif
  14728. }
  14729. // Copy network and socket settings
  14730. client.addr_map_ = addr_map_;
  14731. client.tunnel_addr_map_ = tunnel_addr_map_;
  14732. // A Unix socket client reaches every host through its own socket, as curl's
  14733. // --unix-socket does, unless the caller mapped that host elsewhere. The
  14734. // Location's host is never taken as a socket path.
  14735. if (address_family_ == AF_UNIX) {
  14736. auto &target = client.addr_map_[client.host()];
  14737. if (target.empty()) { target = detail::addr_map_target(addr_map_, host_); }
  14738. }
  14739. client.set_address_family(address_family_);
  14740. client.set_tcp_nodelay(tcp_nodelay_);
  14741. client.set_ipv6_v6only(ipv6_v6only_);
  14742. if (socket_options_) { client.set_socket_options(socket_options_); }
  14743. if (!interface_.empty()) { client.set_interface(interface_); }
  14744. // Copy logging and headers. Not the error logger: a failure comes back to
  14745. // this client's send(), which reports it with the caller's request.
  14746. if (logger_) { client.set_logger(logger_); }
  14747. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  14748. // Each new client should generate its own headers based on its target host
  14749. }
  14750. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  14751. const Request &req,
  14752. Error &error) const {
  14753. auto is_shutting_down = []() { return false; };
  14754. if (req.is_chunked_content_provider_) {
  14755. auto compressor = compress_ ? detail::create_compressor().first
  14756. : std::unique_ptr<detail::compressor>();
  14757. if (!compressor) {
  14758. compressor = detail::make_unique<detail::nocompressor>();
  14759. }
  14760. return detail::write_content_chunked(strm, req.content_provider_,
  14761. is_shutting_down, *compressor, error);
  14762. } else {
  14763. return detail::write_content_with_progress(
  14764. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  14765. req.upload_progress, error);
  14766. }
  14767. }
  14768. // What goes on the request line for req: its path, encoded and without the
  14769. // fragment, with `req.params` as the query when the path has none.
  14770. inline std::string ClientImpl::make_request_target(const Request &req) const {
  14771. auto target = detail::encode_request_target(req.path, path_encode_);
  14772. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  14773. target = append_query_params(target, req.params);
  14774. }
  14775. return target;
  14776. }
  14777. inline void ClientImpl::add_credential_headers(Request &req) {
  14778. // A CONNECT request is read by the proxy; everything sent through the tunnel
  14779. // it opens is read by the origin. Each credential goes only to its own hop.
  14780. auto is_connect = req.method == "CONNECT";
  14781. if (!is_connect) {
  14782. detail::add_authorization_header(req, basic_auth_username_,
  14783. basic_auth_password_,
  14784. bearer_token_auth_token_, false);
  14785. }
  14786. // Proxy-Authorization is only sent when the proxy reads this message —
  14787. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  14788. // would leak proxy credentials to the destination server.
  14789. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  14790. detail::add_authorization_header(req, proxy_basic_auth_username_,
  14791. proxy_basic_auth_password_,
  14792. proxy_bearer_token_auth_token_, true);
  14793. }
  14794. }
  14795. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  14796. bool close_connection, Error &error,
  14797. bool skip_body, bool &rejected_locally) {
  14798. rejected_locally = false;
  14799. // Prepare additional headers
  14800. if (close_connection) {
  14801. if (!req.has_header("Connection")) {
  14802. req.set_header("Connection", "close");
  14803. }
  14804. }
  14805. std::string ct_for_defaults;
  14806. if (!req.has_header("Content-Type") && !req.body.empty()) {
  14807. ct_for_defaults = "text/plain";
  14808. }
  14809. prepare_default_headers(req, false, ct_for_defaults);
  14810. if (req.body.empty()) {
  14811. if (req.content_provider_) {
  14812. if (!req.is_chunked_content_provider_) {
  14813. if (!req.has_header("Content-Length")) {
  14814. auto length = std::to_string(req.content_length_);
  14815. req.set_header("Content-Length", length);
  14816. }
  14817. }
  14818. } else {
  14819. if (req.method == "POST" || req.method == "PUT" ||
  14820. req.method == "PATCH") {
  14821. req.set_header("Content-Length", "0");
  14822. }
  14823. }
  14824. }
  14825. add_credential_headers(req);
  14826. // Request line and headers
  14827. {
  14828. detail::BufferStream bstrm;
  14829. auto path_with_query = make_request_target(req);
  14830. // The query already came in through `req.path`; still populate
  14831. // `req.params` for handlers/users who read them.
  14832. auto query_part = detail::query_of(req.path);
  14833. if (!query_part.empty()) {
  14834. detail::parse_query_text(query_part, req.params);
  14835. }
  14836. // Write request line and headers
  14837. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  14838. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  14839. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  14840. // fail the request cleanly instead of emitting a request-line-less,
  14841. // header-injecting request.
  14842. error = Error::Write;
  14843. rejected_locally = true;
  14844. return false;
  14845. }
  14846. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14847. error)) {
  14848. rejected_locally = true;
  14849. return false;
  14850. }
  14851. // Flush buffer
  14852. auto &data = bstrm.get_buffer();
  14853. if (!detail::write_data(strm, data.data(), data.size())) {
  14854. error = Error::Write;
  14855. return false;
  14856. }
  14857. }
  14858. // After sending request line and headers, wait briefly for an early server
  14859. // response (e.g. 4xx) and avoid sending a potentially large request body
  14860. // unnecessarily. This workaround is only enabled on Windows because Unix
  14861. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  14862. // buffering can accept large writes even when the peer already responded.
  14863. // Check the stream first (which covers SSL via `is_readable()`), then
  14864. // fall back to select on the socket. Only perform the wait for very large
  14865. // request bodies to avoid interfering with normal small requests and
  14866. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  14867. // response. Skip this check when using Expect: 100-continue, as the protocol
  14868. // handles early responses properly.
  14869. #if defined(_WIN32)
  14870. if (!skip_body &&
  14871. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  14872. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  14873. auto start = std::chrono::high_resolution_clock::now();
  14874. for (;;) {
  14875. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  14876. // from SSL internals. If the underlying socket is readable, assume an
  14877. // early response may be present.
  14878. auto sock = strm.socket();
  14879. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  14880. return false;
  14881. }
  14882. // Fallback to stream-level check for non-socket streams or when the
  14883. // socket isn't reporting readable. Avoid using `is_readable()` for
  14884. // SSL, since `SSL_pending()` may report buffered records that do not
  14885. // indicate a complete application-level response yet.
  14886. if (!is_ssl() && strm.is_readable()) { return false; }
  14887. auto now = std::chrono::high_resolution_clock::now();
  14888. auto elapsed =
  14889. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  14890. .count();
  14891. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  14892. break;
  14893. }
  14894. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  14895. }
  14896. }
  14897. #endif
  14898. // Body
  14899. if (skip_body) { return true; }
  14900. return write_request_body(strm, req, error);
  14901. }
  14902. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  14903. Error &error) {
  14904. if (req.body.empty()) {
  14905. return write_content_with_provider(strm, req, error);
  14906. }
  14907. if (req.upload_progress) {
  14908. auto body_size = req.body.size();
  14909. size_t written = 0;
  14910. auto data = req.body.data();
  14911. while (written < body_size) {
  14912. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  14913. if (!detail::write_data(strm, data + written, to_write)) {
  14914. error = Error::Write;
  14915. return false;
  14916. }
  14917. written += to_write;
  14918. if (!req.upload_progress(written, body_size)) {
  14919. error = Error::Canceled;
  14920. return false;
  14921. }
  14922. }
  14923. } else {
  14924. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14925. error = Error::Write;
  14926. return false;
  14927. }
  14928. }
  14929. return true;
  14930. }
  14931. inline std::unique_ptr<Response>
  14932. ClientImpl::send_with_content_provider_and_receiver(
  14933. Request &req, const char *body, size_t content_length,
  14934. ContentProvider content_provider,
  14935. ContentProviderWithoutLength content_provider_without_length,
  14936. const std::string &content_type, ContentReceiver content_receiver,
  14937. Error &error) {
  14938. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14939. auto enc = compress_
  14940. ? detail::create_compressor()
  14941. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14942. nullptr, nullptr);
  14943. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14944. // A compressed or chunked body is framed by the library, not the caller
  14945. if (enc.second || content_provider_without_length) {
  14946. req.headers.erase("Content-Length");
  14947. }
  14948. if (enc.first && !content_provider_without_length) {
  14949. auto &compressor = enc.first;
  14950. if (content_provider) {
  14951. auto ok = true;
  14952. auto finished = false;
  14953. size_t offset = 0;
  14954. DataSink data_sink;
  14955. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14956. if (ok) {
  14957. auto last = offset + data_len == content_length;
  14958. auto ret = compressor->compress(
  14959. data, data_len, last,
  14960. [&](const char *compressed_data, size_t compressed_data_len) {
  14961. req.body.append(compressed_data, compressed_data_len);
  14962. return true;
  14963. });
  14964. if (ret) {
  14965. offset += data_len;
  14966. } else {
  14967. ok = false;
  14968. }
  14969. }
  14970. return ok;
  14971. };
  14972. // As in detail::write_content_with_progress(): the body is framed by
  14973. // content_length, so a provider that finishes early has truncated it.
  14974. // Stop and report that instead of calling the provider forever.
  14975. data_sink.done = [&]() { finished = true; };
  14976. while (ok && !finished && offset < content_length) {
  14977. if (!content_provider(offset, content_length - offset, data_sink)) {
  14978. error = Error::Canceled;
  14979. output_error_log(error, &req);
  14980. return nullptr;
  14981. }
  14982. }
  14983. // A short body here means either the provider stopped early or the
  14984. // compressor gave up. The branch below reports a failing compressor as
  14985. // Error::Compression, so keep the two distinguishable.
  14986. if (offset < content_length) {
  14987. error = ok ? Error::Write : Error::Compression;
  14988. output_error_log(error, &req);
  14989. return nullptr;
  14990. }
  14991. } else {
  14992. if (!compressor->compress(body, content_length, true,
  14993. [&](const char *data, size_t data_len) {
  14994. req.body.append(data, data_len);
  14995. return true;
  14996. })) {
  14997. error = Error::Compression;
  14998. output_error_log(error, &req);
  14999. return nullptr;
  15000. }
  15001. }
  15002. } else {
  15003. if (content_provider) {
  15004. req.content_length_ = content_length;
  15005. req.content_provider_ = std::move(content_provider);
  15006. req.is_chunked_content_provider_ = false;
  15007. } else if (content_provider_without_length) {
  15008. req.content_length_ = 0;
  15009. req.content_provider_ = detail::ContentProviderAdapter(
  15010. std::move(content_provider_without_length));
  15011. req.is_chunked_content_provider_ = true;
  15012. req.set_header("Transfer-Encoding", "chunked");
  15013. } else {
  15014. req.body.assign(body, content_length);
  15015. }
  15016. }
  15017. if (content_receiver) {
  15018. req.content_receiver =
  15019. [content_receiver](const char *data, size_t data_length,
  15020. size_t /*offset*/, size_t /*total_length*/) {
  15021. return content_receiver(data, data_length);
  15022. };
  15023. }
  15024. auto res = detail::make_unique<Response>();
  15025. return send(req, *res, error) ? std::move(res) : nullptr;
  15026. }
  15027. inline Result ClientImpl::send_with_content_provider_and_receiver(
  15028. const std::string &method, const std::string &path, const Headers &headers,
  15029. const char *body, size_t content_length, ContentProvider content_provider,
  15030. ContentProviderWithoutLength content_provider_without_length,
  15031. const std::string &content_type, ContentReceiver content_receiver,
  15032. UploadProgress progress) {
  15033. Request req;
  15034. req.method = method;
  15035. req.headers = headers;
  15036. req.path = path;
  15037. req.upload_progress = std::move(progress);
  15038. if (max_timeout_msec_ > 0) {
  15039. req.start_time_ = std::chrono::steady_clock::now();
  15040. }
  15041. auto error = Error::Success;
  15042. #ifdef CPPHTTPLIB_SSL_ENABLED
  15043. // Hold the request lock until the Result has read this request's TLS error
  15044. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  15045. #endif
  15046. auto res = send_with_content_provider_and_receiver(
  15047. req, body, content_length, std::move(content_provider),
  15048. std::move(content_provider_without_length), content_type,
  15049. std::move(content_receiver), error);
  15050. #ifdef CPPHTTPLIB_SSL_ENABLED
  15051. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  15052. last_backend_error_};
  15053. #else
  15054. return Result{std::move(res), error, std::move(req.headers)};
  15055. #endif
  15056. }
  15057. inline void ClientImpl::output_log(const Request &req,
  15058. const Response &res) const {
  15059. if (logger_) {
  15060. std::lock_guard<std::mutex> guard(logger_mutex_);
  15061. logger_(req, res);
  15062. }
  15063. }
  15064. inline void ClientImpl::output_error_log(const Error &err,
  15065. const Request *req) const {
  15066. if (error_logger_) {
  15067. std::lock_guard<std::mutex> guard(logger_mutex_);
  15068. error_logger_(err, req);
  15069. }
  15070. }
  15071. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  15072. Response &res, bool close_connection,
  15073. Error &error) {
  15074. // Auto-add Expect: 100-continue for large bodies
  15075. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  15076. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  15077. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  15078. req.set_header("Expect", "100-continue");
  15079. }
  15080. }
  15081. // Check for Expect: 100-continue
  15082. auto expect_100_continue =
  15083. detail::has_header_token(req.headers, "Expect", "100-continue");
  15084. // Send request (skip body if using Expect: 100-continue)
  15085. auto rejected_locally = false;
  15086. auto write_request_success =
  15087. write_request(strm, req, close_connection, error, expect_100_continue,
  15088. rejected_locally);
  15089. // A failed write normally still reads the response below, since the server
  15090. // may have answered early (e.g. 413/414) and closed while the body was being
  15091. // sent. A request rejected before any byte reached the socket gets no such
  15092. // response, and waiting for one would block until the read timeout.
  15093. if (rejected_locally) { return false; }
  15094. #ifdef CPPHTTPLIB_SSL_ENABLED
  15095. if (is_ssl() && !expect_100_continue) {
  15096. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  15097. if (!is_proxy_enabled) {
  15098. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  15099. error = Error::SSLPeerCouldBeClosed_;
  15100. return false;
  15101. }
  15102. }
  15103. }
  15104. #endif
  15105. // Handle Expect: 100-continue.
  15106. //
  15107. // Wait for an interim/early response by attempting to read the status line
  15108. // under a short timeout, instead of trusting raw socket readability. Over
  15109. // TLS, post-handshake records (e.g. session tickets) make the socket
  15110. // readable without any HTTP response being available; relying on
  15111. // `select_read` there caused the body to be withheld forever and the
  15112. // request to fail with `Read` (#2458). If no status line arrives within the
  15113. // timeout, send the body anyway (matching curl's behavior).
  15114. auto status_line_read = false;
  15115. if (expect_100_continue && write_request_success) {
  15116. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  15117. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  15118. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  15119. strm.set_read_timeout(sec, usec);
  15120. status_line_read = read_response_line(strm, req, res, false);
  15121. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  15122. }
  15123. if (!status_line_read) {
  15124. // No interim response within the timeout: send the body and handle the
  15125. // response as usual.
  15126. if (!write_request_body(strm, req, error)) { return false; }
  15127. expect_100_continue = false; // Switch to normal response handling
  15128. }
  15129. }
  15130. // Receive response and headers
  15131. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  15132. if ((!status_line_read &&
  15133. !read_response_line(strm, req, res, !expect_100_continue)) ||
  15134. !detail::read_headers(strm, res.headers)) {
  15135. if (write_request_success) { error = Error::Read; }
  15136. return false;
  15137. }
  15138. if (!write_request_success) { return false; }
  15139. // Handle Expect: 100-continue response
  15140. if (expect_100_continue) {
  15141. if (res.status == StatusCode::Continue_100) {
  15142. // Server accepted, send the body
  15143. if (!write_request_body(strm, req, error)) { return false; }
  15144. // Read the actual response
  15145. res.headers.clear();
  15146. res.body.clear();
  15147. if (!read_response_line(strm, req, res) ||
  15148. !detail::read_headers(strm, res.headers)) {
  15149. error = Error::Read;
  15150. return false;
  15151. }
  15152. } else {
  15153. // A final response came first, so the body this request declared was
  15154. // never sent, and the server may still be waiting for it. The
  15155. // connection cannot carry another request.
  15156. std::lock_guard<std::mutex> guard(socket_mutex_);
  15157. socket_should_be_closed_when_request_is_done_ = true;
  15158. }
  15159. }
  15160. // Body
  15161. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  15162. req.method != "CONNECT") {
  15163. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  15164. // whose final transfer coding is not chunked is not ambiguous: its body
  15165. // runs until the server closes the connection, so it is not rejected.
  15166. // HEAD/204 are excluded above and a 304 carries no body.
  15167. if (res.status != StatusCode::NotModified_304) {
  15168. if (detail::has_conflicting_content_length(res.headers)) {
  15169. error = Error::Read;
  15170. return false;
  15171. }
  15172. if (detail::has_faulty_transfer_encoding(res)) {
  15173. std::lock_guard<std::mutex> guard(socket_mutex_);
  15174. socket_should_be_closed_when_request_is_done_ = true;
  15175. }
  15176. }
  15177. auto redirect = follow_location_ && detail::is_redirect(res);
  15178. if (req.response_handler && !redirect) {
  15179. if (!req.response_handler(res)) {
  15180. error = Error::Canceled;
  15181. return false;
  15182. }
  15183. }
  15184. auto out =
  15185. req.content_receiver
  15186. ? static_cast<ContentReceiverWithProgress>(
  15187. [&](const char *buf, size_t n, size_t off, size_t len) {
  15188. if (redirect) { return true; }
  15189. auto ret = req.content_receiver(buf, n, off, len);
  15190. if (!ret) { error = Error::Canceled; }
  15191. return ret;
  15192. })
  15193. : static_cast<ContentReceiverWithProgress>(
  15194. [&](const char *buf, size_t n, size_t /*off*/,
  15195. size_t /*len*/) {
  15196. assert(res.body.size() + n <= res.body.max_size());
  15197. if (payload_max_length_ > 0 &&
  15198. (res.body.size() >= payload_max_length_ ||
  15199. n > payload_max_length_ - res.body.size())) {
  15200. return false;
  15201. }
  15202. res.body.append(buf, n);
  15203. return true;
  15204. });
  15205. auto progress = [&](size_t current, size_t total) {
  15206. if (!req.download_progress || redirect) { return true; }
  15207. auto ret = req.download_progress(current, total);
  15208. if (!ret) { error = Error::Canceled; }
  15209. return ret;
  15210. };
  15211. if (res.has_header("Content-Length")) {
  15212. if (!req.content_receiver) {
  15213. auto len = res.get_header_value_u64("Content-Length");
  15214. if (len > res.body.max_size()) {
  15215. error = Error::Read;
  15216. return false;
  15217. }
  15218. // Content-Length is only the server's claim, so reserve no more than
  15219. // payload_max_length_ allows, nor more than 1 MiB before any of the
  15220. // body has arrived. A longer body grows as it is read.
  15221. auto reserve_len =
  15222. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  15223. if (payload_max_length_ > 0) {
  15224. reserve_len = (std::min)(reserve_len, payload_max_length_);
  15225. }
  15226. res.body.reserve(reserve_len);
  15227. }
  15228. }
  15229. if (res.status != StatusCode::NotModified_304) {
  15230. auto content_status = 0;
  15231. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  15232. ? (std::numeric_limits<size_t>::max)()
  15233. : payload_max_length_;
  15234. if (!detail::read_content(strm, res, max_length, content_status,
  15235. std::move(progress), std::move(out),
  15236. decompress_)) {
  15237. if (error != Error::Canceled) {
  15238. // Tell the caller apart from a plain read failure when the body was
  15239. // over the payload limit or could not be decoded because of its
  15240. // Content-Encoding.
  15241. switch (content_status) {
  15242. case StatusCode::PayloadTooLarge_413:
  15243. error = Error::ExceedMaxPayloadSize;
  15244. break;
  15245. case StatusCode::UnsupportedMediaType_415:
  15246. error = Error::UnsupportedContentEncoding;
  15247. break;
  15248. case StatusCode::InternalServerError_500:
  15249. error = Error::Compression;
  15250. break;
  15251. default: error = Error::Read; break;
  15252. }
  15253. }
  15254. return false;
  15255. }
  15256. }
  15257. }
  15258. // Log
  15259. output_log(req, res);
  15260. return true;
  15261. }
  15262. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  15263. const std::string &boundary, const UploadFormDataItems &items,
  15264. const FormDataProviderItems &provider_items) const {
  15265. size_t cur_item = 0;
  15266. size_t cur_start = 0;
  15267. // cur_item and cur_start are copied to within the std::function and
  15268. // maintain state between successive calls
  15269. return [&, cur_item, cur_start](size_t offset,
  15270. DataSink &sink) mutable -> bool {
  15271. if (!offset && !items.empty()) {
  15272. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  15273. return true;
  15274. } else if (cur_item < provider_items.size()) {
  15275. if (!cur_start) {
  15276. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  15277. provider_items[cur_item], boundary);
  15278. offset += begin.size();
  15279. cur_start = offset;
  15280. sink.os << begin;
  15281. }
  15282. DataSink cur_sink;
  15283. auto has_data = true;
  15284. cur_sink.write = sink.write;
  15285. // Forward is_writable so a provider item asking whether it may keep
  15286. // going gets the outer sink's answer rather than the default `true`.
  15287. cur_sink.is_writable = sink.is_writable;
  15288. cur_sink.done = [&]() { has_data = false; };
  15289. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  15290. return false;
  15291. }
  15292. if (!has_data) {
  15293. sink.os << detail::serialize_multipart_formdata_item_end();
  15294. cur_item++;
  15295. cur_start = 0;
  15296. }
  15297. return true;
  15298. } else {
  15299. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  15300. sink.done();
  15301. return true;
  15302. }
  15303. };
  15304. }
  15305. inline bool ClientImpl::process_socket(
  15306. const Socket &socket,
  15307. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15308. std::function<bool(Stream &strm)> callback) {
  15309. return detail::process_client_socket(
  15310. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  15311. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  15312. }
  15313. inline bool ClientImpl::is_ssl() const { return false; }
  15314. inline Result ClientImpl::Get(const std::string &path,
  15315. DownloadProgress progress) {
  15316. return Get(path, Headers(), std::move(progress));
  15317. }
  15318. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  15319. DownloadProgress progress) {
  15320. return Get(path, params, Headers(), std::move(progress));
  15321. }
  15322. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  15323. const Headers &headers,
  15324. DownloadProgress progress) {
  15325. if (params.empty()) { return Get(path, headers); }
  15326. std::string path_with_query = append_query_params(path, params);
  15327. return Get(path_with_query, headers, std::move(progress));
  15328. }
  15329. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  15330. DownloadProgress progress) {
  15331. Request req;
  15332. req.method = "GET";
  15333. req.path = path;
  15334. req.headers = headers;
  15335. req.download_progress = std::move(progress);
  15336. if (max_timeout_msec_ > 0) {
  15337. req.start_time_ = std::chrono::steady_clock::now();
  15338. }
  15339. return send_(std::move(req));
  15340. }
  15341. inline Result ClientImpl::Get(const std::string &path,
  15342. ContentReceiver content_receiver,
  15343. DownloadProgress progress) {
  15344. return Get(path, Headers(), nullptr, std::move(content_receiver),
  15345. std::move(progress));
  15346. }
  15347. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  15348. ContentReceiver content_receiver,
  15349. DownloadProgress progress) {
  15350. return Get(path, headers, nullptr, std::move(content_receiver),
  15351. std::move(progress));
  15352. }
  15353. inline Result ClientImpl::Get(const std::string &path,
  15354. ResponseHandler response_handler,
  15355. ContentReceiver content_receiver,
  15356. DownloadProgress progress) {
  15357. return Get(path, Headers(), std::move(response_handler),
  15358. std::move(content_receiver), std::move(progress));
  15359. }
  15360. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  15361. ResponseHandler response_handler,
  15362. ContentReceiver content_receiver,
  15363. DownloadProgress progress) {
  15364. Request req;
  15365. req.method = "GET";
  15366. req.path = path;
  15367. req.headers = headers;
  15368. req.response_handler = std::move(response_handler);
  15369. req.content_receiver =
  15370. [content_receiver](const char *data, size_t data_length,
  15371. size_t /*offset*/, size_t /*total_length*/) {
  15372. return content_receiver(data, data_length);
  15373. };
  15374. req.download_progress = std::move(progress);
  15375. if (max_timeout_msec_ > 0) {
  15376. req.start_time_ = std::chrono::steady_clock::now();
  15377. }
  15378. return send_(std::move(req));
  15379. }
  15380. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  15381. const Headers &headers,
  15382. ContentReceiver content_receiver,
  15383. DownloadProgress progress) {
  15384. return Get(path, params, headers, nullptr, std::move(content_receiver),
  15385. std::move(progress));
  15386. }
  15387. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  15388. const Headers &headers,
  15389. ResponseHandler response_handler,
  15390. ContentReceiver content_receiver,
  15391. DownloadProgress progress) {
  15392. if (params.empty()) {
  15393. return Get(path, headers, std::move(response_handler),
  15394. std::move(content_receiver), std::move(progress));
  15395. }
  15396. std::string path_with_query = append_query_params(path, params);
  15397. return Get(path_with_query, headers, std::move(response_handler),
  15398. std::move(content_receiver), std::move(progress));
  15399. }
  15400. inline Result ClientImpl::Head(const std::string &path) {
  15401. return Head(path, Headers());
  15402. }
  15403. inline Result ClientImpl::Head(const std::string &path,
  15404. const Headers &headers) {
  15405. Request req;
  15406. req.method = "HEAD";
  15407. req.headers = headers;
  15408. req.path = path;
  15409. if (max_timeout_msec_ > 0) {
  15410. req.start_time_ = std::chrono::steady_clock::now();
  15411. }
  15412. return send_(std::move(req));
  15413. }
  15414. inline Result ClientImpl::Post(const std::string &path) {
  15415. return Post(path, std::string(), std::string());
  15416. }
  15417. inline Result ClientImpl::Post(const std::string &path,
  15418. const Headers &headers) {
  15419. return Post(path, headers, nullptr, 0, std::string());
  15420. }
  15421. inline Result ClientImpl::Post(const std::string &path, const char *body,
  15422. size_t content_length,
  15423. const std::string &content_type,
  15424. UploadProgress progress) {
  15425. return Post(path, Headers(), body, content_length, content_type, progress);
  15426. }
  15427. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  15428. const std::string &content_type,
  15429. UploadProgress progress) {
  15430. return Post(path, Headers(), body, content_type, progress);
  15431. }
  15432. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  15433. return Post(path, Headers(), params);
  15434. }
  15435. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  15436. ContentProvider content_provider,
  15437. const std::string &content_type,
  15438. UploadProgress progress) {
  15439. return Post(path, Headers(), content_length, std::move(content_provider),
  15440. content_type, progress);
  15441. }
  15442. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  15443. ContentProvider content_provider,
  15444. const std::string &content_type,
  15445. ContentReceiver content_receiver,
  15446. UploadProgress progress) {
  15447. return Post(path, Headers(), content_length, std::move(content_provider),
  15448. content_type, std::move(content_receiver), progress);
  15449. }
  15450. inline Result ClientImpl::Post(const std::string &path,
  15451. ContentProviderWithoutLength content_provider,
  15452. const std::string &content_type,
  15453. UploadProgress progress) {
  15454. return Post(path, Headers(), std::move(content_provider), content_type,
  15455. progress);
  15456. }
  15457. inline Result ClientImpl::Post(const std::string &path,
  15458. ContentProviderWithoutLength content_provider,
  15459. const std::string &content_type,
  15460. ContentReceiver content_receiver,
  15461. UploadProgress progress) {
  15462. return Post(path, Headers(), std::move(content_provider), content_type,
  15463. std::move(content_receiver), progress);
  15464. }
  15465. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15466. const Params &params) {
  15467. auto query = detail::params_to_query_str(params);
  15468. return Post(path, headers, query, "application/x-www-form-urlencoded");
  15469. }
  15470. inline Result ClientImpl::Post(const std::string &path,
  15471. const UploadFormDataItems &items,
  15472. UploadProgress progress) {
  15473. return Post(path, Headers(), items, progress);
  15474. }
  15475. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15476. const UploadFormDataItems &items,
  15477. UploadProgress progress) {
  15478. const auto &boundary = detail::make_multipart_data_boundary();
  15479. const auto &content_type =
  15480. detail::serialize_multipart_formdata_get_content_type(boundary);
  15481. auto content_length = detail::get_multipart_content_length(items, boundary);
  15482. return Post(path, headers, content_length,
  15483. detail::make_multipart_content_provider(items, boundary),
  15484. content_type, progress);
  15485. }
  15486. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15487. const UploadFormDataItems &items,
  15488. const std::string &boundary,
  15489. UploadProgress progress) {
  15490. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15491. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15492. }
  15493. const auto &content_type =
  15494. detail::serialize_multipart_formdata_get_content_type(boundary);
  15495. auto content_length = detail::get_multipart_content_length(items, boundary);
  15496. return Post(path, headers, content_length,
  15497. detail::make_multipart_content_provider(items, boundary),
  15498. content_type, progress);
  15499. }
  15500. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15501. const char *body, size_t content_length,
  15502. const std::string &content_type,
  15503. UploadProgress progress) {
  15504. return send_with_content_provider_and_receiver(
  15505. "POST", path, headers, body, content_length, nullptr, nullptr,
  15506. content_type, nullptr, progress);
  15507. }
  15508. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15509. const std::string &body,
  15510. const std::string &content_type,
  15511. UploadProgress progress) {
  15512. return send_with_content_provider_and_receiver(
  15513. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  15514. content_type, nullptr, progress);
  15515. }
  15516. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15517. size_t content_length,
  15518. ContentProvider content_provider,
  15519. const std::string &content_type,
  15520. UploadProgress progress) {
  15521. return send_with_content_provider_and_receiver(
  15522. "POST", path, headers, nullptr, content_length,
  15523. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15524. }
  15525. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15526. size_t content_length,
  15527. ContentProvider content_provider,
  15528. const std::string &content_type,
  15529. ContentReceiver content_receiver,
  15530. DownloadProgress progress) {
  15531. return send_with_content_provider_and_receiver(
  15532. "POST", path, headers, nullptr, content_length,
  15533. std::move(content_provider), nullptr, content_type,
  15534. std::move(content_receiver), std::move(progress));
  15535. }
  15536. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15537. ContentProviderWithoutLength content_provider,
  15538. const std::string &content_type,
  15539. UploadProgress progress) {
  15540. return send_with_content_provider_and_receiver(
  15541. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15542. content_type, nullptr, progress);
  15543. }
  15544. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15545. ContentProviderWithoutLength content_provider,
  15546. const std::string &content_type,
  15547. ContentReceiver content_receiver,
  15548. DownloadProgress progress) {
  15549. return send_with_content_provider_and_receiver(
  15550. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15551. content_type, std::move(content_receiver), std::move(progress));
  15552. }
  15553. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15554. const UploadFormDataItems &items,
  15555. const FormDataProviderItems &provider_items,
  15556. UploadProgress progress) {
  15557. const auto &boundary = detail::make_multipart_data_boundary();
  15558. const auto &content_type =
  15559. detail::serialize_multipart_formdata_get_content_type(boundary);
  15560. return send_with_content_provider_and_receiver(
  15561. "POST", path, headers, nullptr, 0, nullptr,
  15562. get_multipart_content_provider(boundary, items, provider_items),
  15563. content_type, nullptr, progress);
  15564. }
  15565. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15566. const std::string &body,
  15567. const std::string &content_type,
  15568. ContentReceiver content_receiver,
  15569. DownloadProgress progress) {
  15570. Request req;
  15571. req.method = "POST";
  15572. req.path = path;
  15573. req.headers = headers;
  15574. req.body = body;
  15575. req.content_receiver =
  15576. [content_receiver](const char *data, size_t data_length,
  15577. size_t /*offset*/, size_t /*total_length*/) {
  15578. return content_receiver(data, data_length);
  15579. };
  15580. req.download_progress = std::move(progress);
  15581. if (max_timeout_msec_ > 0) {
  15582. req.start_time_ = std::chrono::steady_clock::now();
  15583. }
  15584. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15585. return send_(std::move(req));
  15586. }
  15587. inline Result ClientImpl::Put(const std::string &path) {
  15588. return Put(path, std::string(), std::string());
  15589. }
  15590. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  15591. return Put(path, headers, nullptr, 0, std::string());
  15592. }
  15593. inline Result ClientImpl::Put(const std::string &path, const char *body,
  15594. size_t content_length,
  15595. const std::string &content_type,
  15596. UploadProgress progress) {
  15597. return Put(path, Headers(), body, content_length, content_type, progress);
  15598. }
  15599. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  15600. const std::string &content_type,
  15601. UploadProgress progress) {
  15602. return Put(path, Headers(), body, content_type, progress);
  15603. }
  15604. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  15605. return Put(path, Headers(), params);
  15606. }
  15607. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  15608. ContentProvider content_provider,
  15609. const std::string &content_type,
  15610. UploadProgress progress) {
  15611. return Put(path, Headers(), content_length, std::move(content_provider),
  15612. content_type, progress);
  15613. }
  15614. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  15615. ContentProvider content_provider,
  15616. const std::string &content_type,
  15617. ContentReceiver content_receiver,
  15618. UploadProgress progress) {
  15619. return Put(path, Headers(), content_length, std::move(content_provider),
  15620. content_type, std::move(content_receiver), progress);
  15621. }
  15622. inline Result ClientImpl::Put(const std::string &path,
  15623. ContentProviderWithoutLength content_provider,
  15624. const std::string &content_type,
  15625. UploadProgress progress) {
  15626. return Put(path, Headers(), std::move(content_provider), content_type,
  15627. progress);
  15628. }
  15629. inline Result ClientImpl::Put(const std::string &path,
  15630. ContentProviderWithoutLength content_provider,
  15631. const std::string &content_type,
  15632. ContentReceiver content_receiver,
  15633. UploadProgress progress) {
  15634. return Put(path, Headers(), std::move(content_provider), content_type,
  15635. std::move(content_receiver), progress);
  15636. }
  15637. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15638. const Params &params) {
  15639. auto query = detail::params_to_query_str(params);
  15640. return Put(path, headers, query, "application/x-www-form-urlencoded");
  15641. }
  15642. inline Result ClientImpl::Put(const std::string &path,
  15643. const UploadFormDataItems &items,
  15644. UploadProgress progress) {
  15645. return Put(path, Headers(), items, progress);
  15646. }
  15647. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15648. const UploadFormDataItems &items,
  15649. UploadProgress progress) {
  15650. const auto &boundary = detail::make_multipart_data_boundary();
  15651. const auto &content_type =
  15652. detail::serialize_multipart_formdata_get_content_type(boundary);
  15653. auto content_length = detail::get_multipart_content_length(items, boundary);
  15654. return Put(path, headers, content_length,
  15655. detail::make_multipart_content_provider(items, boundary),
  15656. content_type, progress);
  15657. }
  15658. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15659. const UploadFormDataItems &items,
  15660. const std::string &boundary,
  15661. UploadProgress progress) {
  15662. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15663. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15664. }
  15665. const auto &content_type =
  15666. detail::serialize_multipart_formdata_get_content_type(boundary);
  15667. auto content_length = detail::get_multipart_content_length(items, boundary);
  15668. return Put(path, headers, content_length,
  15669. detail::make_multipart_content_provider(items, boundary),
  15670. content_type, progress);
  15671. }
  15672. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15673. const char *body, size_t content_length,
  15674. const std::string &content_type,
  15675. UploadProgress progress) {
  15676. return send_with_content_provider_and_receiver(
  15677. "PUT", path, headers, body, content_length, nullptr, nullptr,
  15678. content_type, nullptr, progress);
  15679. }
  15680. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15681. const std::string &body,
  15682. const std::string &content_type,
  15683. UploadProgress progress) {
  15684. return send_with_content_provider_and_receiver(
  15685. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  15686. content_type, nullptr, progress);
  15687. }
  15688. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15689. size_t content_length,
  15690. ContentProvider content_provider,
  15691. const std::string &content_type,
  15692. UploadProgress progress) {
  15693. return send_with_content_provider_and_receiver(
  15694. "PUT", path, headers, nullptr, content_length,
  15695. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15696. }
  15697. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15698. size_t content_length,
  15699. ContentProvider content_provider,
  15700. const std::string &content_type,
  15701. ContentReceiver content_receiver,
  15702. UploadProgress progress) {
  15703. return send_with_content_provider_and_receiver(
  15704. "PUT", path, headers, nullptr, content_length,
  15705. std::move(content_provider), nullptr, content_type,
  15706. std::move(content_receiver), progress);
  15707. }
  15708. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15709. ContentProviderWithoutLength content_provider,
  15710. const std::string &content_type,
  15711. UploadProgress progress) {
  15712. return send_with_content_provider_and_receiver(
  15713. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15714. content_type, nullptr, progress);
  15715. }
  15716. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15717. ContentProviderWithoutLength content_provider,
  15718. const std::string &content_type,
  15719. ContentReceiver content_receiver,
  15720. UploadProgress progress) {
  15721. return send_with_content_provider_and_receiver(
  15722. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15723. content_type, std::move(content_receiver), progress);
  15724. }
  15725. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15726. const UploadFormDataItems &items,
  15727. const FormDataProviderItems &provider_items,
  15728. UploadProgress progress) {
  15729. const auto &boundary = detail::make_multipart_data_boundary();
  15730. const auto &content_type =
  15731. detail::serialize_multipart_formdata_get_content_type(boundary);
  15732. return send_with_content_provider_and_receiver(
  15733. "PUT", path, headers, nullptr, 0, nullptr,
  15734. get_multipart_content_provider(boundary, items, provider_items),
  15735. content_type, nullptr, progress);
  15736. }
  15737. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15738. const std::string &body,
  15739. const std::string &content_type,
  15740. ContentReceiver content_receiver,
  15741. DownloadProgress progress) {
  15742. Request req;
  15743. req.method = "PUT";
  15744. req.path = path;
  15745. req.headers = headers;
  15746. req.body = body;
  15747. req.content_receiver =
  15748. [content_receiver](const char *data, size_t data_length,
  15749. size_t /*offset*/, size_t /*total_length*/) {
  15750. return content_receiver(data, data_length);
  15751. };
  15752. req.download_progress = std::move(progress);
  15753. if (max_timeout_msec_ > 0) {
  15754. req.start_time_ = std::chrono::steady_clock::now();
  15755. }
  15756. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15757. return send_(std::move(req));
  15758. }
  15759. inline Result ClientImpl::Patch(const std::string &path) {
  15760. return Patch(path, std::string(), std::string());
  15761. }
  15762. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15763. UploadProgress progress) {
  15764. return Patch(path, headers, nullptr, 0, std::string(), progress);
  15765. }
  15766. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  15767. size_t content_length,
  15768. const std::string &content_type,
  15769. UploadProgress progress) {
  15770. return Patch(path, Headers(), body, content_length, content_type, progress);
  15771. }
  15772. inline Result ClientImpl::Patch(const std::string &path,
  15773. const std::string &body,
  15774. const std::string &content_type,
  15775. UploadProgress progress) {
  15776. return Patch(path, Headers(), body, content_type, progress);
  15777. }
  15778. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  15779. return Patch(path, Headers(), params);
  15780. }
  15781. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15782. ContentProvider content_provider,
  15783. const std::string &content_type,
  15784. UploadProgress progress) {
  15785. return Patch(path, Headers(), content_length, std::move(content_provider),
  15786. content_type, progress);
  15787. }
  15788. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15789. ContentProvider content_provider,
  15790. const std::string &content_type,
  15791. ContentReceiver content_receiver,
  15792. UploadProgress progress) {
  15793. return Patch(path, Headers(), content_length, std::move(content_provider),
  15794. content_type, std::move(content_receiver), progress);
  15795. }
  15796. inline Result ClientImpl::Patch(const std::string &path,
  15797. ContentProviderWithoutLength content_provider,
  15798. const std::string &content_type,
  15799. UploadProgress progress) {
  15800. return Patch(path, Headers(), std::move(content_provider), content_type,
  15801. progress);
  15802. }
  15803. inline Result ClientImpl::Patch(const std::string &path,
  15804. ContentProviderWithoutLength content_provider,
  15805. const std::string &content_type,
  15806. ContentReceiver content_receiver,
  15807. UploadProgress progress) {
  15808. return Patch(path, Headers(), std::move(content_provider), content_type,
  15809. std::move(content_receiver), progress);
  15810. }
  15811. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15812. const Params &params) {
  15813. auto query = detail::params_to_query_str(params);
  15814. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  15815. }
  15816. inline Result ClientImpl::Patch(const std::string &path,
  15817. const UploadFormDataItems &items,
  15818. UploadProgress progress) {
  15819. return Patch(path, Headers(), items, progress);
  15820. }
  15821. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15822. const UploadFormDataItems &items,
  15823. UploadProgress progress) {
  15824. const auto &boundary = detail::make_multipart_data_boundary();
  15825. const auto &content_type =
  15826. detail::serialize_multipart_formdata_get_content_type(boundary);
  15827. auto content_length = detail::get_multipart_content_length(items, boundary);
  15828. return Patch(path, headers, content_length,
  15829. detail::make_multipart_content_provider(items, boundary),
  15830. content_type, progress);
  15831. }
  15832. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15833. const UploadFormDataItems &items,
  15834. const std::string &boundary,
  15835. UploadProgress progress) {
  15836. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15837. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15838. }
  15839. const auto &content_type =
  15840. detail::serialize_multipart_formdata_get_content_type(boundary);
  15841. auto content_length = detail::get_multipart_content_length(items, boundary);
  15842. return Patch(path, headers, content_length,
  15843. detail::make_multipart_content_provider(items, boundary),
  15844. content_type, progress);
  15845. }
  15846. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15847. const char *body, size_t content_length,
  15848. const std::string &content_type,
  15849. UploadProgress progress) {
  15850. return send_with_content_provider_and_receiver(
  15851. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  15852. content_type, nullptr, progress);
  15853. }
  15854. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15855. const std::string &body,
  15856. const std::string &content_type,
  15857. UploadProgress progress) {
  15858. return send_with_content_provider_and_receiver(
  15859. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  15860. content_type, nullptr, progress);
  15861. }
  15862. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15863. size_t content_length,
  15864. ContentProvider content_provider,
  15865. const std::string &content_type,
  15866. UploadProgress progress) {
  15867. return send_with_content_provider_and_receiver(
  15868. "PATCH", path, headers, nullptr, content_length,
  15869. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15870. }
  15871. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15872. size_t content_length,
  15873. ContentProvider content_provider,
  15874. const std::string &content_type,
  15875. ContentReceiver content_receiver,
  15876. UploadProgress progress) {
  15877. return send_with_content_provider_and_receiver(
  15878. "PATCH", path, headers, nullptr, content_length,
  15879. std::move(content_provider), nullptr, content_type,
  15880. std::move(content_receiver), progress);
  15881. }
  15882. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15883. ContentProviderWithoutLength content_provider,
  15884. const std::string &content_type,
  15885. UploadProgress progress) {
  15886. return send_with_content_provider_and_receiver(
  15887. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15888. content_type, nullptr, progress);
  15889. }
  15890. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15891. ContentProviderWithoutLength content_provider,
  15892. const std::string &content_type,
  15893. ContentReceiver content_receiver,
  15894. UploadProgress progress) {
  15895. return send_with_content_provider_and_receiver(
  15896. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15897. content_type, std::move(content_receiver), progress);
  15898. }
  15899. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15900. const UploadFormDataItems &items,
  15901. const FormDataProviderItems &provider_items,
  15902. UploadProgress progress) {
  15903. const auto &boundary = detail::make_multipart_data_boundary();
  15904. const auto &content_type =
  15905. detail::serialize_multipart_formdata_get_content_type(boundary);
  15906. return send_with_content_provider_and_receiver(
  15907. "PATCH", path, headers, nullptr, 0, nullptr,
  15908. get_multipart_content_provider(boundary, items, provider_items),
  15909. content_type, nullptr, progress);
  15910. }
  15911. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15912. const std::string &body,
  15913. const std::string &content_type,
  15914. ContentReceiver content_receiver,
  15915. DownloadProgress progress) {
  15916. Request req;
  15917. req.method = "PATCH";
  15918. req.path = path;
  15919. req.headers = headers;
  15920. req.body = body;
  15921. req.content_receiver =
  15922. [content_receiver](const char *data, size_t data_length,
  15923. size_t /*offset*/, size_t /*total_length*/) {
  15924. return content_receiver(data, data_length);
  15925. };
  15926. req.download_progress = std::move(progress);
  15927. if (max_timeout_msec_ > 0) {
  15928. req.start_time_ = std::chrono::steady_clock::now();
  15929. }
  15930. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15931. return send_(std::move(req));
  15932. }
  15933. inline Result ClientImpl::Delete(const std::string &path,
  15934. DownloadProgress progress) {
  15935. return Delete(path, Headers(), std::string(), std::string(), progress);
  15936. }
  15937. inline Result ClientImpl::Delete(const std::string &path,
  15938. const Headers &headers,
  15939. DownloadProgress progress) {
  15940. return Delete(path, headers, std::string(), std::string(), progress);
  15941. }
  15942. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15943. size_t content_length,
  15944. const std::string &content_type,
  15945. DownloadProgress progress) {
  15946. return Delete(path, Headers(), body, content_length, content_type, progress);
  15947. }
  15948. inline Result ClientImpl::Delete(const std::string &path,
  15949. const std::string &body,
  15950. const std::string &content_type,
  15951. DownloadProgress progress) {
  15952. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15953. progress);
  15954. }
  15955. inline Result ClientImpl::Delete(const std::string &path,
  15956. const Headers &headers,
  15957. const std::string &body,
  15958. const std::string &content_type,
  15959. DownloadProgress progress) {
  15960. return Delete(path, headers, body.data(), body.size(), content_type,
  15961. progress);
  15962. }
  15963. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15964. DownloadProgress progress) {
  15965. return Delete(path, Headers(), params, progress);
  15966. }
  15967. inline Result ClientImpl::Delete(const std::string &path,
  15968. const Headers &headers, const Params &params,
  15969. DownloadProgress progress) {
  15970. auto query = detail::params_to_query_str(params);
  15971. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15972. progress);
  15973. }
  15974. inline Result ClientImpl::Delete(const std::string &path,
  15975. const Headers &headers, const char *body,
  15976. size_t content_length,
  15977. const std::string &content_type,
  15978. DownloadProgress progress) {
  15979. Request req;
  15980. req.method = "DELETE";
  15981. req.headers = headers;
  15982. req.path = path;
  15983. req.download_progress = std::move(progress);
  15984. if (max_timeout_msec_ > 0) {
  15985. req.start_time_ = std::chrono::steady_clock::now();
  15986. }
  15987. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15988. req.body.assign(body, content_length);
  15989. return send_(std::move(req));
  15990. }
  15991. inline Result ClientImpl::Options(const std::string &path) {
  15992. return Options(path, Headers());
  15993. }
  15994. inline Result ClientImpl::Options(const std::string &path,
  15995. const Headers &headers) {
  15996. Request req;
  15997. req.method = "OPTIONS";
  15998. req.headers = headers;
  15999. req.path = path;
  16000. if (max_timeout_msec_ > 0) {
  16001. req.start_time_ = std::chrono::steady_clock::now();
  16002. }
  16003. return send_(std::move(req));
  16004. }
  16005. inline void ClientImpl::stop() {
  16006. std::lock_guard<std::mutex> guard(socket_mutex_);
  16007. stop_requested_ = true;
  16008. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  16009. // do is to shutdown_socket, so that threads using this socket suddenly
  16010. // discover they can't read/write any more and error out. Everything else
  16011. // (closing the socket, shutting ssl down) is unsafe because these actions
  16012. // are not thread-safe.
  16013. if (socket_requests_in_flight_ > 0) {
  16014. shutdown_socket(socket_);
  16015. // Aside from that, we set a flag for the socket to be closed when we're
  16016. // done.
  16017. socket_should_be_closed_when_request_is_done_ = true;
  16018. return;
  16019. }
  16020. disconnect(/*gracefully=*/true);
  16021. }
  16022. inline std::string ClientImpl::host() const { return host_; }
  16023. inline int ClientImpl::port() const { return port_; }
  16024. inline size_t ClientImpl::is_socket_open() const {
  16025. std::lock_guard<std::mutex> guard(socket_mutex_);
  16026. return socket_.is_open();
  16027. }
  16028. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  16029. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  16030. connection_timeout_sec_ = sec;
  16031. connection_timeout_usec_ = usec;
  16032. }
  16033. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  16034. read_timeout_sec_ = sec;
  16035. read_timeout_usec_ = usec;
  16036. }
  16037. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  16038. write_timeout_sec_ = sec;
  16039. write_timeout_usec_ = usec;
  16040. }
  16041. inline void ClientImpl::set_max_timeout(time_t msec) {
  16042. max_timeout_msec_ = msec;
  16043. }
  16044. inline void ClientImpl::set_basic_auth(const std::string &username,
  16045. const std::string &password) {
  16046. basic_auth_username_ = username;
  16047. basic_auth_password_ = password;
  16048. }
  16049. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  16050. bearer_token_auth_token_ = token;
  16051. }
  16052. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  16053. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  16054. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  16055. inline void
  16056. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  16057. set_direct_hostname_addr_map(std::move(addr_map));
  16058. }
  16059. inline void ClientImpl::set_direct_hostname_addr_map(
  16060. std::map<std::string, std::string> addr_map) {
  16061. addr_map_ = std::move(addr_map);
  16062. }
  16063. inline void ClientImpl::set_tunnel_hostname_addr_map(
  16064. std::map<std::string, std::string> addr_map) {
  16065. tunnel_addr_map_ = std::move(addr_map);
  16066. }
  16067. inline void ClientImpl::set_default_headers(Headers headers) {
  16068. default_headers_ = std::move(headers);
  16069. }
  16070. inline void ClientImpl::set_header_writer(
  16071. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  16072. header_writer_ = writer;
  16073. }
  16074. inline void ClientImpl::set_address_family(int family) {
  16075. address_family_ = family;
  16076. }
  16077. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  16078. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  16079. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  16080. socket_options_ = std::move(socket_options);
  16081. }
  16082. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  16083. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  16084. inline void ClientImpl::set_payload_max_length(size_t length) {
  16085. payload_max_length_ = length;
  16086. has_payload_max_length_ = true;
  16087. }
  16088. inline void ClientImpl::set_interface(const std::string &intf) {
  16089. interface_ = intf;
  16090. }
  16091. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  16092. proxy_host_ = host;
  16093. proxy_port_ = port;
  16094. std::lock_guard<std::mutex> guard(socket_mutex_);
  16095. disconnect(/*gracefully=*/true);
  16096. }
  16097. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  16098. const std::string &password) {
  16099. proxy_basic_auth_username_ = username;
  16100. proxy_basic_auth_password_ = password;
  16101. }
  16102. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  16103. proxy_bearer_token_auth_token_ = token;
  16104. }
  16105. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  16106. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  16107. std::lock_guard<std::mutex> guard(socket_mutex_);
  16108. disconnect(/*gracefully=*/true);
  16109. }
  16110. #ifdef CPPHTTPLIB_SSL_ENABLED
  16111. inline void ClientImpl::set_digest_auth(const std::string &username,
  16112. const std::string &password) {
  16113. digest_auth_username_ = username;
  16114. digest_auth_password_ = password;
  16115. }
  16116. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  16117. const std::string &ca_cert_dir_path) {
  16118. ca_cert_file_path_ = ca_cert_file_path;
  16119. ca_cert_dir_path_ = ca_cert_dir_path;
  16120. }
  16121. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  16122. const std::string &password) {
  16123. proxy_digest_auth_username_ = username;
  16124. proxy_digest_auth_password_ = password;
  16125. }
  16126. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  16127. if (server_certificate_verification_ == enabled) { return; }
  16128. server_certificate_verification_ = enabled;
  16129. tls_settings_changed();
  16130. }
  16131. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  16132. if (server_hostname_verification_ == enabled) { return; }
  16133. server_hostname_verification_ = enabled;
  16134. tls_settings_changed();
  16135. }
  16136. inline void ClientImpl::enable_system_ca(bool enabled) {
  16137. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  16138. }
  16139. #endif
  16140. inline void ClientImpl::set_logger(Logger logger) {
  16141. logger_ = std::move(logger);
  16142. }
  16143. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  16144. error_logger_ = std::move(error_logger);
  16145. }
  16146. /*
  16147. * SSL/TLS Common Implementation
  16148. */
  16149. inline ClientConnection::~ClientConnection() {
  16150. #ifdef CPPHTTPLIB_SSL_ENABLED
  16151. if (session) {
  16152. tls::shutdown(session, true);
  16153. tls::free_session(session);
  16154. session = nullptr;
  16155. }
  16156. #endif
  16157. if (sock != INVALID_SOCKET) {
  16158. detail::close_socket(sock);
  16159. sock = INVALID_SOCKET;
  16160. }
  16161. }
  16162. // Universal client implementation
  16163. inline Client::Client(const std::string &scheme_host_port)
  16164. : Client(scheme_host_port, std::string(), std::string()) {}
  16165. inline Client::Client(const std::string &scheme_host_port,
  16166. const std::string &client_cert_path,
  16167. const std::string &client_key_path) {
  16168. detail::UrlComponents uc;
  16169. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  16170. auto &scheme = uc.scheme;
  16171. #ifdef CPPHTTPLIB_SSL_ENABLED
  16172. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  16173. #else
  16174. if (!scheme.empty() && scheme != "http") {
  16175. #endif
  16176. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  16177. std::string msg = "'" + scheme + "' scheme is not supported.";
  16178. throw std::invalid_argument(msg);
  16179. #endif
  16180. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  16181. return;
  16182. }
  16183. auto is_ssl = scheme == "https";
  16184. auto host = std::move(uc.host);
  16185. auto port = is_ssl ? 443 : 80;
  16186. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  16187. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  16188. return;
  16189. }
  16190. if (is_ssl) {
  16191. #ifdef CPPHTTPLIB_SSL_ENABLED
  16192. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  16193. client_key_path);
  16194. is_ssl_ = is_ssl;
  16195. #endif
  16196. } else {
  16197. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  16198. client_key_path);
  16199. }
  16200. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  16201. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  16202. // A URL, but not one this client can use, such as one with userinfo. A
  16203. // Unix socket path may have "//" further on.
  16204. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  16205. } else {
  16206. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  16207. // if port param below changes.
  16208. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  16209. client_cert_path, client_key_path);
  16210. }
  16211. }
  16212. inline Client::Client(const std::string &host, int port)
  16213. : Client(host, port, std::string(), std::string()) {}
  16214. inline Client::Client(const std::string &host, int port,
  16215. const std::string &client_cert_path,
  16216. const std::string &client_key_path)
  16217. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  16218. client_key_path)) {}
  16219. inline Client::~Client() = default;
  16220. inline bool Client::is_valid() const {
  16221. return cli_ != nullptr && cli_->is_valid();
  16222. }
  16223. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  16224. return cli_->Get(path, std::move(progress));
  16225. }
  16226. inline Result Client::Get(const std::string &path, const Headers &headers,
  16227. DownloadProgress progress) {
  16228. return cli_->Get(path, headers, std::move(progress));
  16229. }
  16230. inline Result Client::Get(const std::string &path,
  16231. ContentReceiver content_receiver,
  16232. DownloadProgress progress) {
  16233. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  16234. }
  16235. inline Result Client::Get(const std::string &path, const Headers &headers,
  16236. ContentReceiver content_receiver,
  16237. DownloadProgress progress) {
  16238. return cli_->Get(path, headers, std::move(content_receiver),
  16239. std::move(progress));
  16240. }
  16241. inline Result Client::Get(const std::string &path,
  16242. ResponseHandler response_handler,
  16243. ContentReceiver content_receiver,
  16244. DownloadProgress progress) {
  16245. return cli_->Get(path, std::move(response_handler),
  16246. std::move(content_receiver), std::move(progress));
  16247. }
  16248. inline Result Client::Get(const std::string &path, const Headers &headers,
  16249. ResponseHandler response_handler,
  16250. ContentReceiver content_receiver,
  16251. DownloadProgress progress) {
  16252. return cli_->Get(path, headers, std::move(response_handler),
  16253. std::move(content_receiver), std::move(progress));
  16254. }
  16255. inline Result Client::Get(const std::string &path, const Params &params,
  16256. DownloadProgress progress) {
  16257. return cli_->Get(path, params, std::move(progress));
  16258. }
  16259. inline Result Client::Get(const std::string &path, const Params &params,
  16260. const Headers &headers, DownloadProgress progress) {
  16261. return cli_->Get(path, params, headers, std::move(progress));
  16262. }
  16263. inline Result Client::Get(const std::string &path, const Params &params,
  16264. const Headers &headers,
  16265. ContentReceiver content_receiver,
  16266. DownloadProgress progress) {
  16267. return cli_->Get(path, params, headers, std::move(content_receiver),
  16268. std::move(progress));
  16269. }
  16270. inline Result Client::Get(const std::string &path, const Params &params,
  16271. const Headers &headers,
  16272. ResponseHandler response_handler,
  16273. ContentReceiver content_receiver,
  16274. DownloadProgress progress) {
  16275. return cli_->Get(path, params, headers, std::move(response_handler),
  16276. std::move(content_receiver), std::move(progress));
  16277. }
  16278. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  16279. inline Result Client::Head(const std::string &path, const Headers &headers) {
  16280. return cli_->Head(path, headers);
  16281. }
  16282. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  16283. inline Result Client::Post(const std::string &path, const Headers &headers) {
  16284. return cli_->Post(path, headers);
  16285. }
  16286. inline Result Client::Post(const std::string &path, const char *body,
  16287. size_t content_length,
  16288. const std::string &content_type,
  16289. UploadProgress progress) {
  16290. return cli_->Post(path, body, content_length, content_type, progress);
  16291. }
  16292. inline Result Client::Post(const std::string &path, const Headers &headers,
  16293. const char *body, size_t content_length,
  16294. const std::string &content_type,
  16295. UploadProgress progress) {
  16296. return cli_->Post(path, headers, body, content_length, content_type,
  16297. progress);
  16298. }
  16299. inline Result Client::Post(const std::string &path, const std::string &body,
  16300. const std::string &content_type,
  16301. UploadProgress progress) {
  16302. return cli_->Post(path, body, content_type, progress);
  16303. }
  16304. inline Result Client::Post(const std::string &path, const Headers &headers,
  16305. const std::string &body,
  16306. const std::string &content_type,
  16307. UploadProgress progress) {
  16308. return cli_->Post(path, headers, body, content_type, progress);
  16309. }
  16310. inline Result Client::Post(const std::string &path, size_t content_length,
  16311. ContentProvider content_provider,
  16312. const std::string &content_type,
  16313. UploadProgress progress) {
  16314. return cli_->Post(path, content_length, std::move(content_provider),
  16315. content_type, progress);
  16316. }
  16317. inline Result Client::Post(const std::string &path, size_t content_length,
  16318. ContentProvider content_provider,
  16319. const std::string &content_type,
  16320. ContentReceiver content_receiver,
  16321. UploadProgress progress) {
  16322. return cli_->Post(path, content_length, std::move(content_provider),
  16323. content_type, std::move(content_receiver), progress);
  16324. }
  16325. inline Result Client::Post(const std::string &path,
  16326. ContentProviderWithoutLength content_provider,
  16327. const std::string &content_type,
  16328. UploadProgress progress) {
  16329. return cli_->Post(path, std::move(content_provider), content_type, progress);
  16330. }
  16331. inline Result Client::Post(const std::string &path,
  16332. ContentProviderWithoutLength content_provider,
  16333. const std::string &content_type,
  16334. ContentReceiver content_receiver,
  16335. UploadProgress progress) {
  16336. return cli_->Post(path, std::move(content_provider), content_type,
  16337. std::move(content_receiver), progress);
  16338. }
  16339. inline Result Client::Post(const std::string &path, const Headers &headers,
  16340. size_t content_length,
  16341. ContentProvider content_provider,
  16342. const std::string &content_type,
  16343. UploadProgress progress) {
  16344. return cli_->Post(path, headers, content_length, std::move(content_provider),
  16345. content_type, progress);
  16346. }
  16347. inline Result Client::Post(const std::string &path, const Headers &headers,
  16348. size_t content_length,
  16349. ContentProvider content_provider,
  16350. const std::string &content_type,
  16351. ContentReceiver content_receiver,
  16352. DownloadProgress progress) {
  16353. return cli_->Post(path, headers, content_length, std::move(content_provider),
  16354. content_type, std::move(content_receiver), progress);
  16355. }
  16356. inline Result Client::Post(const std::string &path, const Headers &headers,
  16357. ContentProviderWithoutLength content_provider,
  16358. const std::string &content_type,
  16359. UploadProgress progress) {
  16360. return cli_->Post(path, headers, std::move(content_provider), content_type,
  16361. progress);
  16362. }
  16363. inline Result Client::Post(const std::string &path, const Headers &headers,
  16364. ContentProviderWithoutLength content_provider,
  16365. const std::string &content_type,
  16366. ContentReceiver content_receiver,
  16367. DownloadProgress progress) {
  16368. return cli_->Post(path, headers, std::move(content_provider), content_type,
  16369. std::move(content_receiver), progress);
  16370. }
  16371. inline Result Client::Post(const std::string &path, const Params &params) {
  16372. return cli_->Post(path, params);
  16373. }
  16374. inline Result Client::Post(const std::string &path, const Headers &headers,
  16375. const Params &params) {
  16376. return cli_->Post(path, headers, params);
  16377. }
  16378. inline Result Client::Post(const std::string &path,
  16379. const UploadFormDataItems &items,
  16380. UploadProgress progress) {
  16381. return cli_->Post(path, items, progress);
  16382. }
  16383. inline Result Client::Post(const std::string &path, const Headers &headers,
  16384. const UploadFormDataItems &items,
  16385. UploadProgress progress) {
  16386. return cli_->Post(path, headers, items, progress);
  16387. }
  16388. inline Result Client::Post(const std::string &path, const Headers &headers,
  16389. const UploadFormDataItems &items,
  16390. const std::string &boundary,
  16391. UploadProgress progress) {
  16392. return cli_->Post(path, headers, items, boundary, progress);
  16393. }
  16394. inline Result Client::Post(const std::string &path, const Headers &headers,
  16395. const UploadFormDataItems &items,
  16396. const FormDataProviderItems &provider_items,
  16397. UploadProgress progress) {
  16398. return cli_->Post(path, headers, items, provider_items, progress);
  16399. }
  16400. inline Result Client::Post(const std::string &path, const Headers &headers,
  16401. const std::string &body,
  16402. const std::string &content_type,
  16403. ContentReceiver content_receiver,
  16404. DownloadProgress progress) {
  16405. return cli_->Post(path, headers, body, content_type,
  16406. std::move(content_receiver), progress);
  16407. }
  16408. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  16409. inline Result Client::Put(const std::string &path, const Headers &headers) {
  16410. return cli_->Put(path, headers);
  16411. }
  16412. inline Result Client::Put(const std::string &path, const char *body,
  16413. size_t content_length,
  16414. const std::string &content_type,
  16415. UploadProgress progress) {
  16416. return cli_->Put(path, body, content_length, content_type, progress);
  16417. }
  16418. inline Result Client::Put(const std::string &path, const Headers &headers,
  16419. const char *body, size_t content_length,
  16420. const std::string &content_type,
  16421. UploadProgress progress) {
  16422. return cli_->Put(path, headers, body, content_length, content_type, progress);
  16423. }
  16424. inline Result Client::Put(const std::string &path, const std::string &body,
  16425. const std::string &content_type,
  16426. UploadProgress progress) {
  16427. return cli_->Put(path, body, content_type, progress);
  16428. }
  16429. inline Result Client::Put(const std::string &path, const Headers &headers,
  16430. const std::string &body,
  16431. const std::string &content_type,
  16432. UploadProgress progress) {
  16433. return cli_->Put(path, headers, body, content_type, progress);
  16434. }
  16435. inline Result Client::Put(const std::string &path, size_t content_length,
  16436. ContentProvider content_provider,
  16437. const std::string &content_type,
  16438. UploadProgress progress) {
  16439. return cli_->Put(path, content_length, std::move(content_provider),
  16440. content_type, progress);
  16441. }
  16442. inline Result Client::Put(const std::string &path, size_t content_length,
  16443. ContentProvider content_provider,
  16444. const std::string &content_type,
  16445. ContentReceiver content_receiver,
  16446. UploadProgress progress) {
  16447. return cli_->Put(path, content_length, std::move(content_provider),
  16448. content_type, std::move(content_receiver), progress);
  16449. }
  16450. inline Result Client::Put(const std::string &path,
  16451. ContentProviderWithoutLength content_provider,
  16452. const std::string &content_type,
  16453. UploadProgress progress) {
  16454. return cli_->Put(path, std::move(content_provider), content_type, progress);
  16455. }
  16456. inline Result Client::Put(const std::string &path,
  16457. ContentProviderWithoutLength content_provider,
  16458. const std::string &content_type,
  16459. ContentReceiver content_receiver,
  16460. UploadProgress progress) {
  16461. return cli_->Put(path, std::move(content_provider), content_type,
  16462. std::move(content_receiver), progress);
  16463. }
  16464. inline Result Client::Put(const std::string &path, const Headers &headers,
  16465. size_t content_length,
  16466. ContentProvider content_provider,
  16467. const std::string &content_type,
  16468. UploadProgress progress) {
  16469. return cli_->Put(path, headers, content_length, std::move(content_provider),
  16470. content_type, progress);
  16471. }
  16472. inline Result Client::Put(const std::string &path, const Headers &headers,
  16473. size_t content_length,
  16474. ContentProvider content_provider,
  16475. const std::string &content_type,
  16476. ContentReceiver content_receiver,
  16477. UploadProgress progress) {
  16478. return cli_->Put(path, headers, content_length, std::move(content_provider),
  16479. content_type, std::move(content_receiver), progress);
  16480. }
  16481. inline Result Client::Put(const std::string &path, const Headers &headers,
  16482. ContentProviderWithoutLength content_provider,
  16483. const std::string &content_type,
  16484. UploadProgress progress) {
  16485. return cli_->Put(path, headers, std::move(content_provider), content_type,
  16486. progress);
  16487. }
  16488. inline Result Client::Put(const std::string &path, const Headers &headers,
  16489. ContentProviderWithoutLength content_provider,
  16490. const std::string &content_type,
  16491. ContentReceiver content_receiver,
  16492. UploadProgress progress) {
  16493. return cli_->Put(path, headers, std::move(content_provider), content_type,
  16494. std::move(content_receiver), progress);
  16495. }
  16496. inline Result Client::Put(const std::string &path, const Params &params) {
  16497. return cli_->Put(path, params);
  16498. }
  16499. inline Result Client::Put(const std::string &path, const Headers &headers,
  16500. const Params &params) {
  16501. return cli_->Put(path, headers, params);
  16502. }
  16503. inline Result Client::Put(const std::string &path,
  16504. const UploadFormDataItems &items,
  16505. UploadProgress progress) {
  16506. return cli_->Put(path, items, progress);
  16507. }
  16508. inline Result Client::Put(const std::string &path, const Headers &headers,
  16509. const UploadFormDataItems &items,
  16510. UploadProgress progress) {
  16511. return cli_->Put(path, headers, items, progress);
  16512. }
  16513. inline Result Client::Put(const std::string &path, const Headers &headers,
  16514. const UploadFormDataItems &items,
  16515. const std::string &boundary,
  16516. UploadProgress progress) {
  16517. return cli_->Put(path, headers, items, boundary, progress);
  16518. }
  16519. inline Result Client::Put(const std::string &path, const Headers &headers,
  16520. const UploadFormDataItems &items,
  16521. const FormDataProviderItems &provider_items,
  16522. UploadProgress progress) {
  16523. return cli_->Put(path, headers, items, provider_items, progress);
  16524. }
  16525. inline Result Client::Put(const std::string &path, const Headers &headers,
  16526. const std::string &body,
  16527. const std::string &content_type,
  16528. ContentReceiver content_receiver,
  16529. DownloadProgress progress) {
  16530. return cli_->Put(path, headers, body, content_type, content_receiver,
  16531. progress);
  16532. }
  16533. inline Result Client::Patch(const std::string &path) {
  16534. return cli_->Patch(path);
  16535. }
  16536. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  16537. return cli_->Patch(path, headers);
  16538. }
  16539. inline Result Client::Patch(const std::string &path, const char *body,
  16540. size_t content_length,
  16541. const std::string &content_type,
  16542. UploadProgress progress) {
  16543. return cli_->Patch(path, body, content_length, content_type, progress);
  16544. }
  16545. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16546. const char *body, size_t content_length,
  16547. const std::string &content_type,
  16548. UploadProgress progress) {
  16549. return cli_->Patch(path, headers, body, content_length, content_type,
  16550. progress);
  16551. }
  16552. inline Result Client::Patch(const std::string &path, const std::string &body,
  16553. const std::string &content_type,
  16554. UploadProgress progress) {
  16555. return cli_->Patch(path, body, content_type, progress);
  16556. }
  16557. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16558. const std::string &body,
  16559. const std::string &content_type,
  16560. UploadProgress progress) {
  16561. return cli_->Patch(path, headers, body, content_type, progress);
  16562. }
  16563. inline Result Client::Patch(const std::string &path, size_t content_length,
  16564. ContentProvider content_provider,
  16565. const std::string &content_type,
  16566. UploadProgress progress) {
  16567. return cli_->Patch(path, content_length, std::move(content_provider),
  16568. content_type, progress);
  16569. }
  16570. inline Result Client::Patch(const std::string &path, size_t content_length,
  16571. ContentProvider content_provider,
  16572. const std::string &content_type,
  16573. ContentReceiver content_receiver,
  16574. UploadProgress progress) {
  16575. return cli_->Patch(path, content_length, std::move(content_provider),
  16576. content_type, std::move(content_receiver), progress);
  16577. }
  16578. inline Result Client::Patch(const std::string &path,
  16579. ContentProviderWithoutLength content_provider,
  16580. const std::string &content_type,
  16581. UploadProgress progress) {
  16582. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  16583. }
  16584. inline Result Client::Patch(const std::string &path,
  16585. ContentProviderWithoutLength content_provider,
  16586. const std::string &content_type,
  16587. ContentReceiver content_receiver,
  16588. UploadProgress progress) {
  16589. return cli_->Patch(path, std::move(content_provider), content_type,
  16590. std::move(content_receiver), progress);
  16591. }
  16592. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16593. size_t content_length,
  16594. ContentProvider content_provider,
  16595. const std::string &content_type,
  16596. UploadProgress progress) {
  16597. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  16598. content_type, progress);
  16599. }
  16600. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16601. size_t content_length,
  16602. ContentProvider content_provider,
  16603. const std::string &content_type,
  16604. ContentReceiver content_receiver,
  16605. UploadProgress progress) {
  16606. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  16607. content_type, std::move(content_receiver), progress);
  16608. }
  16609. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16610. ContentProviderWithoutLength content_provider,
  16611. const std::string &content_type,
  16612. UploadProgress progress) {
  16613. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16614. progress);
  16615. }
  16616. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16617. ContentProviderWithoutLength content_provider,
  16618. const std::string &content_type,
  16619. ContentReceiver content_receiver,
  16620. UploadProgress progress) {
  16621. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16622. std::move(content_receiver), progress);
  16623. }
  16624. inline Result Client::Patch(const std::string &path, const Params &params) {
  16625. return cli_->Patch(path, params);
  16626. }
  16627. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16628. const Params &params) {
  16629. return cli_->Patch(path, headers, params);
  16630. }
  16631. inline Result Client::Patch(const std::string &path,
  16632. const UploadFormDataItems &items,
  16633. UploadProgress progress) {
  16634. return cli_->Patch(path, items, progress);
  16635. }
  16636. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16637. const UploadFormDataItems &items,
  16638. UploadProgress progress) {
  16639. return cli_->Patch(path, headers, items, progress);
  16640. }
  16641. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16642. const UploadFormDataItems &items,
  16643. const std::string &boundary,
  16644. UploadProgress progress) {
  16645. return cli_->Patch(path, headers, items, boundary, progress);
  16646. }
  16647. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16648. const UploadFormDataItems &items,
  16649. const FormDataProviderItems &provider_items,
  16650. UploadProgress progress) {
  16651. return cli_->Patch(path, headers, items, provider_items, progress);
  16652. }
  16653. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16654. const std::string &body,
  16655. const std::string &content_type,
  16656. ContentReceiver content_receiver,
  16657. DownloadProgress progress) {
  16658. return cli_->Patch(path, headers, body, content_type, content_receiver,
  16659. progress);
  16660. }
  16661. inline Result Client::Delete(const std::string &path,
  16662. DownloadProgress progress) {
  16663. return cli_->Delete(path, progress);
  16664. }
  16665. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16666. DownloadProgress progress) {
  16667. return cli_->Delete(path, headers, progress);
  16668. }
  16669. inline Result Client::Delete(const std::string &path, const char *body,
  16670. size_t content_length,
  16671. const std::string &content_type,
  16672. DownloadProgress progress) {
  16673. return cli_->Delete(path, body, content_length, content_type, progress);
  16674. }
  16675. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16676. const char *body, size_t content_length,
  16677. const std::string &content_type,
  16678. DownloadProgress progress) {
  16679. return cli_->Delete(path, headers, body, content_length, content_type,
  16680. progress);
  16681. }
  16682. inline Result Client::Delete(const std::string &path, const std::string &body,
  16683. const std::string &content_type,
  16684. DownloadProgress progress) {
  16685. return cli_->Delete(path, body, content_type, progress);
  16686. }
  16687. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16688. const std::string &body,
  16689. const std::string &content_type,
  16690. DownloadProgress progress) {
  16691. return cli_->Delete(path, headers, body, content_type, progress);
  16692. }
  16693. inline Result Client::Delete(const std::string &path, const Params &params,
  16694. DownloadProgress progress) {
  16695. return cli_->Delete(path, params, progress);
  16696. }
  16697. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16698. const Params &params, DownloadProgress progress) {
  16699. return cli_->Delete(path, headers, params, progress);
  16700. }
  16701. inline Result Client::Options(const std::string &path) {
  16702. return cli_->Options(path);
  16703. }
  16704. inline Result Client::Options(const std::string &path, const Headers &headers) {
  16705. return cli_->Options(path, headers);
  16706. }
  16707. inline ClientImpl::StreamHandle
  16708. Client::open_stream(const std::string &method, const std::string &path,
  16709. const Params &params, const Headers &headers,
  16710. const std::string &body, const std::string &content_type) {
  16711. return cli_->open_stream(method, path, params, headers, body, content_type);
  16712. }
  16713. inline bool Client::send(Request &req, Response &res, Error &error) {
  16714. return cli_->send(req, res, error);
  16715. }
  16716. inline Result Client::send(const Request &req) { return cli_->send(req); }
  16717. inline void Client::stop() { cli_->stop(); }
  16718. inline std::string Client::host() const { return cli_->host(); }
  16719. inline int Client::port() const { return cli_->port(); }
  16720. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  16721. inline socket_t Client::socket() const { return cli_->socket(); }
  16722. inline void
  16723. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  16724. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  16725. }
  16726. inline void Client::set_direct_hostname_addr_map(
  16727. std::map<std::string, std::string> addr_map) {
  16728. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  16729. }
  16730. inline void Client::set_tunnel_hostname_addr_map(
  16731. std::map<std::string, std::string> addr_map) {
  16732. cli_->set_tunnel_hostname_addr_map(std::move(addr_map));
  16733. }
  16734. inline void Client::set_default_headers(Headers headers) {
  16735. cli_->set_default_headers(std::move(headers));
  16736. }
  16737. inline void Client::set_header_writer(
  16738. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  16739. cli_->set_header_writer(writer);
  16740. }
  16741. inline void Client::set_address_family(int family) {
  16742. cli_->set_address_family(family);
  16743. }
  16744. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  16745. inline void Client::set_socket_options(SocketOptions socket_options) {
  16746. cli_->set_socket_options(std::move(socket_options));
  16747. }
  16748. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  16749. cli_->set_connection_timeout(sec, usec);
  16750. }
  16751. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  16752. cli_->set_read_timeout(sec, usec);
  16753. }
  16754. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  16755. cli_->set_write_timeout(sec, usec);
  16756. }
  16757. inline void Client::set_basic_auth(const std::string &username,
  16758. const std::string &password) {
  16759. cli_->set_basic_auth(username, password);
  16760. }
  16761. inline void Client::set_bearer_token_auth(const std::string &token) {
  16762. cli_->set_bearer_token_auth(token);
  16763. }
  16764. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  16765. inline void Client::set_follow_location(bool on) {
  16766. cli_->set_follow_location(on);
  16767. }
  16768. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  16769. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  16770. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  16771. inline void Client::set_payload_max_length(size_t length) {
  16772. cli_->set_payload_max_length(length);
  16773. }
  16774. inline void Client::set_interface(const std::string &intf) {
  16775. cli_->set_interface(intf);
  16776. }
  16777. inline void Client::set_proxy(const std::string &host, int port) {
  16778. cli_->set_proxy(host, port);
  16779. }
  16780. inline void Client::set_proxy_basic_auth(const std::string &username,
  16781. const std::string &password) {
  16782. cli_->set_proxy_basic_auth(username, password);
  16783. }
  16784. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  16785. cli_->set_proxy_bearer_token_auth(token);
  16786. }
  16787. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  16788. cli_->set_no_proxy(patterns);
  16789. }
  16790. inline void Client::set_logger(Logger logger) {
  16791. cli_->set_logger(std::move(logger));
  16792. }
  16793. inline void Client::set_error_logger(ErrorLogger error_logger) {
  16794. cli_->set_error_logger(std::move(error_logger));
  16795. }
  16796. /*
  16797. * Group 6: SSL Server and Client implementation
  16798. */
  16799. #ifdef CPPHTTPLIB_SSL_ENABLED
  16800. // SSL HTTP server implementation
  16801. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  16802. const char *client_ca_cert_file_path,
  16803. const char *client_ca_cert_dir_path,
  16804. const char *private_key_password) {
  16805. using namespace tls;
  16806. ctx_ = create_server_context();
  16807. if (!ctx_) { return; }
  16808. // Load server certificate and private key
  16809. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  16810. private_key_password)) {
  16811. last_ssl_error_ = static_cast<int>(get_error());
  16812. free_context(ctx_);
  16813. ctx_ = nullptr;
  16814. return;
  16815. }
  16816. // Load client CA certificates for client authentication
  16817. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  16818. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  16819. client_ca_cert_dir_path)) {
  16820. last_ssl_error_ = static_cast<int>(get_error());
  16821. free_context(ctx_);
  16822. ctx_ = nullptr;
  16823. return;
  16824. }
  16825. // Enable client certificate verification
  16826. set_verify_client(ctx_, true);
  16827. }
  16828. }
  16829. inline SSLServer::SSLServer(const PemMemory &pem) {
  16830. using namespace tls;
  16831. ctx_ = create_server_context();
  16832. if (ctx_) {
  16833. std::string cert_buf, key_buf;
  16834. if (!set_server_cert_pem(
  16835. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16836. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16837. pem.private_key_password)) {
  16838. last_ssl_error_ = static_cast<int>(get_error());
  16839. free_context(ctx_);
  16840. ctx_ = nullptr;
  16841. } else if (pem.client_ca_pem) {
  16842. auto ca_len = pem.client_ca_pem_len ? pem.client_ca_pem_len
  16843. : strlen(pem.client_ca_pem);
  16844. if (!load_ca_pem(ctx_, pem.client_ca_pem, ca_len)) {
  16845. last_ssl_error_ = static_cast<int>(get_error());
  16846. free_context(ctx_);
  16847. ctx_ = nullptr;
  16848. } else {
  16849. set_verify_client(ctx_, true);
  16850. }
  16851. }
  16852. }
  16853. }
  16854. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  16855. using namespace tls;
  16856. ctx_ = create_server_context();
  16857. if (ctx_) {
  16858. if (!setup_callback(ctx_)) {
  16859. free_context(ctx_);
  16860. ctx_ = nullptr;
  16861. }
  16862. }
  16863. }
  16864. inline SSLServer::~SSLServer() {
  16865. if (ctx_) { tls::free_context(ctx_); }
  16866. }
  16867. inline bool SSLServer::is_valid() const {
  16868. return ctx_ != nullptr && Server::is_valid();
  16869. }
  16870. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  16871. using namespace tls;
  16872. session_t session = nullptr;
  16873. {
  16874. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16875. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  16876. session = create_session(static_cast<ctx_t>(ctx_), sock);
  16877. if (session) { handshakes_in_progress_++; }
  16878. }
  16879. if (!session) {
  16880. last_ssl_error_ = static_cast<int>(get_error());
  16881. detail::shutdown_socket(sock);
  16882. detail::close_socket(sock);
  16883. return false;
  16884. }
  16885. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  16886. bool handshake_done = false;
  16887. bool ret = false;
  16888. bool websocket_upgraded = false;
  16889. auto cleanup = detail::scope_exit([&] {
  16890. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  16891. free_session(session);
  16892. if (handshake_done) {
  16893. detail::drain_and_close_socket(sock);
  16894. } else {
  16895. detail::shutdown_socket(sock);
  16896. detail::close_socket(sock);
  16897. }
  16898. });
  16899. // Perform TLS accept handshake with timeout
  16900. TlsError tls_err;
  16901. auto accepted = false;
  16902. {
  16903. auto handshake_left = detail::scope_exit([&] {
  16904. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16905. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  16906. });
  16907. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  16908. read_timeout_usec_, &tls_err);
  16909. }
  16910. if (!accepted) {
  16911. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16912. // Map TlsError to legacy ssl_error for backward compatibility
  16913. if (tls_err.code == ErrorCode::WantRead) {
  16914. last_ssl_error_ = SSL_ERROR_WANT_READ;
  16915. } else if (tls_err.code == ErrorCode::WantWrite) {
  16916. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  16917. } else {
  16918. last_ssl_error_ = SSL_ERROR_SSL;
  16919. }
  16920. #else
  16921. last_ssl_error_ = static_cast<int>(get_error());
  16922. #endif
  16923. return false;
  16924. }
  16925. handshake_done = true;
  16926. std::string remote_addr;
  16927. int remote_port = 0;
  16928. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  16929. std::string local_addr;
  16930. int local_port = 0;
  16931. detail::get_local_ip_and_port(sock, local_addr, local_port);
  16932. ret = serve_guarded([&]() {
  16933. return detail::process_server_socket_ssl(
  16934. svr_sock_, session, sock, keep_alive_max_count_,
  16935. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  16936. write_timeout_sec_, write_timeout_usec_,
  16937. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  16938. return process_request(
  16939. strm, remote_addr, remote_port, local_addr, local_port,
  16940. close_connection, connection_closed,
  16941. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16942. });
  16943. });
  16944. return ret;
  16945. }
  16946. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16947. const char *key_pem,
  16948. const char *client_ca_pem,
  16949. const char *password) {
  16950. if (!ctx_) { return false; }
  16951. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16952. updates_pending_++;
  16953. auto se = detail::scope_exit([&] {
  16954. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16955. });
  16956. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16957. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16958. return false;
  16959. }
  16960. if (client_ca_pem) {
  16961. if (!tls::update_server_client_ca(ctx_, client_ca_pem)) { return false; }
  16962. // As in the constructors, a client CA makes client certificates required
  16963. tls::set_verify_client(ctx_, true);
  16964. }
  16965. return true;
  16966. }
  16967. // SSL HTTP client implementation
  16968. inline SSLClient::~SSLClient() {
  16969. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16970. // base function rather than the derived function once we get to the
  16971. // base class destructor, and won't free the SSL (causing a leak).
  16972. // This must happen before the context is freed below: some backends
  16973. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16974. // context, so freeing the context first leaves close_notify reading
  16975. // freed memory.
  16976. shutdown_ssl_impl(socket_, true);
  16977. if (ctx_) {
  16978. tls::free_context(ctx_);
  16979. ctx_ = nullptr;
  16980. }
  16981. }
  16982. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16983. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16984. shutdown_ssl_impl(socket, shutdown_gracefully);
  16985. }
  16986. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16987. bool shutdown_gracefully) {
  16988. if (socket.sock == INVALID_SOCKET) {
  16989. assert(socket.ssl == nullptr);
  16990. return;
  16991. }
  16992. if (socket.ssl) {
  16993. tls::shutdown(socket.ssl, shutdown_gracefully);
  16994. {
  16995. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16996. tls::free_session(socket.ssl);
  16997. }
  16998. socket.ssl = nullptr;
  16999. }
  17000. assert(socket.ssl == nullptr);
  17001. }
  17002. inline bool SSLClient::process_socket(
  17003. const Socket &socket,
  17004. std::chrono::time_point<std::chrono::steady_clock> start_time,
  17005. std::function<bool(Stream &strm)> callback) {
  17006. assert(socket.ssl);
  17007. return detail::process_client_socket_ssl(
  17008. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  17009. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  17010. [&](detail::SSLSocketStream &strm) {
  17011. auto ret = callback(strm);
  17012. // A request that failed after the handshake reports Error::Read or
  17013. // Error::Write; keep the TLS error behind it, such as a fatal alert
  17014. // from the server, for Result::ssl_error() and ssl_backend_error()
  17015. const auto &tls_error = strm.tls_error();
  17016. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  17017. last_ssl_error_ = static_cast<int>(tls_error.code);
  17018. last_backend_error_ = tls_error.backend_code;
  17019. }
  17020. return ret;
  17021. });
  17022. }
  17023. inline bool SSLClient::is_ssl() const { return true; }
  17024. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  17025. if (!is_valid()) {
  17026. error = Error::SSLConnection;
  17027. return false;
  17028. }
  17029. return ClientImpl::create_and_connect_socket(socket, error);
  17030. }
  17031. inline bool SSLClient::setup_proxy_connection(
  17032. Socket &socket,
  17033. std::chrono::time_point<std::chrono::steady_clock> start_time,
  17034. Response &res, bool &success, Error &error) {
  17035. if (!is_proxy_enabled_for_host(host_)) { return true; }
  17036. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  17037. return false;
  17038. }
  17039. if (!initialize_ssl(socket, error)) {
  17040. shutdown_socket(socket);
  17041. close_socket(socket);
  17042. success = false;
  17043. return false;
  17044. }
  17045. return true;
  17046. }
  17047. // Assumes that socket is a connection being opened, which no other thread uses
  17048. inline bool SSLClient::connect_with_proxy(
  17049. Socket &socket,
  17050. std::chrono::time_point<std::chrono::steady_clock> start_time,
  17051. Response &res, bool &success, Error &error) {
  17052. success = true;
  17053. auto connect_target =
  17054. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  17055. auto retargeted = connect_target !=
  17056. detail::make_host_and_port_string_always_port(host_, port_);
  17057. Response proxy_res;
  17058. if (!detail::process_client_socket(
  17059. socket.sock, read_timeout_sec_, read_timeout_usec_,
  17060. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  17061. start_time, [&](Stream &strm) {
  17062. strm.set_read_interrupt(stop_interrupt());
  17063. Request req2;
  17064. req2.method = "CONNECT";
  17065. req2.path = connect_target;
  17066. if (retargeted) { req2.set_header("Host", connect_target); }
  17067. if (max_timeout_msec_ > 0) {
  17068. req2.start_time_ = std::chrono::steady_clock::now();
  17069. }
  17070. return process_request(strm, req2, proxy_res, false, error);
  17071. })) {
  17072. // Thread-safe to close everything because we are assuming there are no
  17073. // requests in flight
  17074. shutdown_ssl(socket, true);
  17075. shutdown_socket(socket);
  17076. close_socket(socket);
  17077. success = false;
  17078. return false;
  17079. }
  17080. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  17081. if (!proxy_digest_auth_username_.empty() &&
  17082. !proxy_digest_auth_password_.empty()) {
  17083. std::map<std::string, std::string> auth;
  17084. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  17085. // Close the current socket and create a new one for the authenticated
  17086. // request
  17087. shutdown_ssl(socket, true);
  17088. shutdown_socket(socket);
  17089. close_socket(socket);
  17090. // Create a new socket for the authenticated CONNECT request
  17091. if (!ensure_socket_connection(socket, error)) {
  17092. success = false;
  17093. return false;
  17094. }
  17095. proxy_res = Response();
  17096. if (!detail::process_client_socket(
  17097. socket.sock, read_timeout_sec_, read_timeout_usec_,
  17098. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  17099. start_time, [&](Stream &strm) {
  17100. strm.set_read_interrupt(stop_interrupt());
  17101. Request req3;
  17102. req3.method = "CONNECT";
  17103. req3.path = connect_target;
  17104. if (retargeted) { req3.set_header("Host", connect_target); }
  17105. req3.headers.insert(detail::make_digest_authentication_header(
  17106. req3, make_request_target(req3), auth, 1,
  17107. detail::random_string(10), proxy_digest_auth_username_,
  17108. proxy_digest_auth_password_, true));
  17109. if (max_timeout_msec_ > 0) {
  17110. req3.start_time_ = std::chrono::steady_clock::now();
  17111. }
  17112. return process_request(strm, req3, proxy_res, false, error);
  17113. })) {
  17114. // Thread-safe to close everything because we are assuming there are
  17115. // no requests in flight
  17116. shutdown_ssl(socket, true);
  17117. shutdown_socket(socket);
  17118. close_socket(socket);
  17119. success = false;
  17120. return false;
  17121. }
  17122. }
  17123. }
  17124. }
  17125. // If status code is not 200, proxy request is failed.
  17126. // Set error to ProxyConnection. A 407 is returned as the response of the
  17127. // request, so the caller sees the proxy asks for credentials; any other
  17128. // status would read as the answer of the origin, which it never reached.
  17129. if (proxy_res.status != StatusCode::OK_200) {
  17130. error = Error::ProxyConnection;
  17131. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  17132. res = std::move(proxy_res);
  17133. } else {
  17134. success = false;
  17135. }
  17136. // Thread-safe to close everything because we are assuming there are
  17137. // no requests in flight
  17138. shutdown_ssl(socket, true);
  17139. shutdown_socket(socket);
  17140. close_socket(socket);
  17141. return false;
  17142. }
  17143. return true;
  17144. }
  17145. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  17146. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  17147. if (is_proxy_enabled_for_host(host_)) { return true; }
  17148. if (!initialize_ssl(socket, error)) {
  17149. shutdown_socket(socket);
  17150. close_socket(socket);
  17151. return false;
  17152. }
  17153. return true;
  17154. }
  17155. // SSL HTTP client implementation
  17156. inline SSLClient::SSLClient(const std::string &host)
  17157. : SSLClient(host, 443, std::string(), std::string()) {}
  17158. inline SSLClient::SSLClient(const std::string &host, int port)
  17159. : SSLClient(host, port, std::string(), std::string()) {}
  17160. inline void SSLClient::init_ctx() {
  17161. ctx_ = tls::create_client_context();
  17162. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  17163. }
  17164. inline void SSLClient::reset_ctx_on_error() {
  17165. last_backend_error_ = tls::get_error();
  17166. tls::free_context(ctx_);
  17167. ctx_ = nullptr;
  17168. }
  17169. inline SSLClient::SSLClient(const std::string &host, int port,
  17170. const std::string &client_cert_path,
  17171. const std::string &client_key_path,
  17172. const std::string &private_key_password)
  17173. : ClientImpl(host, port, client_cert_path, client_key_path) {
  17174. init_ctx();
  17175. if (!ctx_) { return; }
  17176. if (!client_cert_path.empty() && !client_key_path.empty()) {
  17177. const char *password =
  17178. private_key_password.empty() ? nullptr : private_key_password.c_str();
  17179. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  17180. client_key_path.c_str(), password)) {
  17181. reset_ctx_on_error();
  17182. }
  17183. }
  17184. }
  17185. inline SSLClient::SSLClient(const std::string &host, int port,
  17186. const PemMemory &pem)
  17187. : ClientImpl(host, port) {
  17188. init_ctx();
  17189. if (!ctx_) { return; }
  17190. if (pem.cert_pem && pem.key_pem) {
  17191. std::string cert_buf, key_buf;
  17192. if (!tls::set_client_cert_pem(
  17193. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  17194. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  17195. pem.private_key_password)) {
  17196. reset_ctx_on_error();
  17197. }
  17198. }
  17199. }
  17200. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  17201. if (ca_cert_store && ctx_) {
  17202. // set_ca_store takes ownership of ca_cert_store
  17203. tls::set_ca_store(ctx_, ca_cert_store);
  17204. ca_cert_store_set_ = true;
  17205. } else if (ca_cert_store) {
  17206. tls::free_ca_store(ca_cert_store);
  17207. }
  17208. custom_ca_loaded_ = true;
  17209. tls_settings_changed();
  17210. }
  17211. inline void
  17212. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  17213. if (!ctx_) { return; }
  17214. server_certificate_verifier_ = verifier;
  17215. {
  17216. // Under the lock that creating a session from ctx_ takes
  17217. std::lock_guard<std::mutex> guard(ctx_mutex_);
  17218. tls::set_verify_callback(ctx_, std::move(verifier));
  17219. }
  17220. tls_settings_changed();
  17221. }
  17222. inline void SSLClient::set_session_verifier(
  17223. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  17224. session_verifier_ = std::move(verifier);
  17225. tls_settings_changed();
  17226. }
  17227. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  17228. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  17229. if (enable_windows_cert_verification_ == enabled) { return; }
  17230. enable_windows_cert_verification_ = enabled;
  17231. tls_settings_changed();
  17232. }
  17233. #endif
  17234. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  17235. std::size_t size) {
  17236. if (ctx_ && ca_cert && size > 0) {
  17237. // Every PEM loaded, for redirect transfer
  17238. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  17239. ca_cert_pem_ += '\n';
  17240. }
  17241. ca_cert_pem_.append(ca_cert, size);
  17242. tls::load_ca_pem(ctx_, ca_cert, size);
  17243. }
  17244. custom_ca_loaded_ = true;
  17245. tls_settings_changed();
  17246. }
  17247. inline bool SSLClient::load_certs() {
  17248. auto ret = true;
  17249. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  17250. // one client is shared across concurrent requests here.
  17251. std::call_once(initialize_cert_, [&]() {
  17252. std::lock_guard<std::mutex> guard(ctx_mutex_);
  17253. ret = detail::load_client_ca_config(ctx_, ca_cert_file_path_,
  17254. ca_cert_dir_path_, custom_ca_loaded_,
  17255. system_ca_mode_, last_backend_error_);
  17256. });
  17257. return ret;
  17258. }
  17259. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  17260. // Load CA certificates if server verification is enabled
  17261. if (server_certificate_verification_) {
  17262. if (!load_certs()) {
  17263. error = Error::SSLLoadingCerts;
  17264. return false;
  17265. }
  17266. }
  17267. detail::ClientTlsSessionOptions options;
  17268. options.server_hostname_verification = server_hostname_verification_;
  17269. options.session_verifier = session_verifier_;
  17270. options.interrupted = stop_interrupt();
  17271. options.ctx_mutex = &ctx_mutex_;
  17272. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  17273. options.windows_cert_verification = detail::use_windows_cert_verification(
  17274. enable_windows_cert_verification_, ca_cert_file_path_, ca_cert_dir_path_,
  17275. custom_ca_loaded_, system_ca_mode_);
  17276. // Only a verifier set through set_server_certificate_verifier() is seen
  17277. // here, not one installed with tls::set_verify_callback() directly.
  17278. options.server_certificate_verifier_set =
  17279. static_cast<bool>(server_certificate_verifier_);
  17280. #endif
  17281. tls::session_t session = nullptr;
  17282. // Use scope_exit to ensure session is freed on error paths
  17283. bool success = false;
  17284. auto session_guard = detail::scope_exit([&] {
  17285. if (!success) { tls::free_session(session); }
  17286. });
  17287. detail::ClientTlsSessionError tls_error;
  17288. if (!detail::setup_client_tls_session(
  17289. host_, ctx_, session, socket.sock, server_certificate_verification_,
  17290. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  17291. options)) {
  17292. error = tls_error.error;
  17293. last_ssl_error_ = tls_error.ssl_error;
  17294. last_backend_error_ = tls_error.backend_error;
  17295. return false;
  17296. }
  17297. success = true;
  17298. socket.ssl = session;
  17299. return true;
  17300. }
  17301. inline void Client::set_digest_auth(const std::string &username,
  17302. const std::string &password) {
  17303. cli_->set_digest_auth(username, password);
  17304. }
  17305. inline void Client::set_proxy_digest_auth(const std::string &username,
  17306. const std::string &password) {
  17307. cli_->set_proxy_digest_auth(username, password);
  17308. }
  17309. inline void Client::enable_server_certificate_verification(bool enabled) {
  17310. cli_->enable_server_certificate_verification(enabled);
  17311. }
  17312. inline void Client::enable_server_hostname_verification(bool enabled) {
  17313. cli_->enable_server_hostname_verification(enabled);
  17314. }
  17315. inline void Client::enable_system_ca(bool enabled) {
  17316. cli_->enable_system_ca(enabled);
  17317. }
  17318. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  17319. inline void Client::enable_windows_certificate_verification(bool enabled) {
  17320. if (is_ssl_) {
  17321. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  17322. enabled);
  17323. }
  17324. }
  17325. #endif
  17326. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  17327. const std::string &ca_cert_dir_path) {
  17328. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  17329. }
  17330. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  17331. if (is_ssl_) {
  17332. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  17333. } else if (ca_cert_store) {
  17334. tls::free_ca_store(ca_cert_store);
  17335. }
  17336. }
  17337. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  17338. if (is_ssl_) {
  17339. // Use the PEM-based path so the CA data is retained for redirect transfer
  17340. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  17341. }
  17342. }
  17343. inline void
  17344. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  17345. if (is_ssl_) {
  17346. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  17347. std::move(verifier));
  17348. }
  17349. }
  17350. inline void Client::set_session_verifier(
  17351. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  17352. if (is_ssl_) {
  17353. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  17354. }
  17355. }
  17356. inline tls::ctx_t Client::tls_context() const {
  17357. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  17358. return nullptr;
  17359. }
  17360. #endif // CPPHTTPLIB_SSL_ENABLED
  17361. /*
  17362. * Group 7: TLS abstraction layer - Common API
  17363. */
  17364. #ifdef CPPHTTPLIB_SSL_ENABLED
  17365. namespace tls {
  17366. // Helper for PeerCert construction
  17367. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  17368. return PeerCert(get_peer_cert(session));
  17369. }
  17370. namespace impl {
  17371. // set_verify_callback() can replace a callback while handshakes on other
  17372. // threads run it, so they share it, and take their reference under this lock.
  17373. inline std::mutex &verify_callback_mutex() {
  17374. static std::mutex mutex;
  17375. return mutex;
  17376. }
  17377. // The TLS libraries are C, so an exception from a verify callback must not
  17378. // unwind through them. It rejects the certificate instead.
  17379. inline bool run_verify_callback(const VerifyCallback &callback,
  17380. const VerifyContext &ctx) {
  17381. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  17382. return callback(ctx);
  17383. #else
  17384. try {
  17385. return callback(ctx);
  17386. } catch (...) { return false; }
  17387. #endif
  17388. }
  17389. // Check if a string is an IPv4 address
  17390. inline bool is_ipv4_address(const std::string &str) {
  17391. int dots = 0;
  17392. for (char c : str) {
  17393. if (c == '.') {
  17394. dots++;
  17395. } else if (!detail::is_ascii_digit(c)) {
  17396. return false;
  17397. }
  17398. }
  17399. return dots == 3;
  17400. }
  17401. // Parse IPv4 address string to bytes
  17402. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  17403. const char *p = str.c_str();
  17404. for (int i = 0; i < 4; i++) {
  17405. if (i > 0) {
  17406. if (*p != '.') { return false; }
  17407. p++;
  17408. }
  17409. int val = 0;
  17410. int digits = 0;
  17411. while (detail::is_ascii_digit(*p)) {
  17412. val = val * 10 + (*p - '0');
  17413. if (val > 255) { return false; }
  17414. p++;
  17415. digits++;
  17416. }
  17417. if (digits == 0) { return false; }
  17418. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  17419. if (digits > 1 && *(p - digits) == '0') { return false; }
  17420. out[i] = static_cast<unsigned char>(val);
  17421. }
  17422. return *p == '\0';
  17423. }
  17424. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  17425. // `out` must have room for at least 16 bytes. Returns the address length
  17426. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  17427. // literal. Used to match a host against iPAddress SANs the same way the
  17428. // OpenSSL backend does via X509_check_ip.
  17429. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  17430. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  17431. struct in6_addr addr6 = {};
  17432. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  17433. memcpy(out, &addr6, 16);
  17434. return 16;
  17435. }
  17436. return 0;
  17437. }
  17438. #ifdef _WIN32
  17439. // Enumerate Windows system certificates and call callback with DER data
  17440. template <typename Callback>
  17441. inline bool enumerate_windows_system_certs(Callback cb) {
  17442. bool loaded = false;
  17443. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17444. for (auto store_name : store_names) {
  17445. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  17446. if (hStore) {
  17447. PCCERT_CONTEXT pContext = nullptr;
  17448. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17449. nullptr) {
  17450. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  17451. loaded = true;
  17452. }
  17453. }
  17454. CertCloseStore(hStore, 0);
  17455. }
  17456. }
  17457. return loaded;
  17458. }
  17459. #endif
  17460. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17461. // The trust a certificate's Trust Settings give it for SSL server
  17462. // verification (SecTrustSettings.h). An empty array trusts it as a root.
  17463. // Otherwise the first usage-constraints dictionary that applies decides: one
  17464. // naming a policy other than SSL, a host name or an application does not
  17465. // apply, and a result left out means TrustRoot. Keychain Access writes "Never
  17466. // Trust" as kSecTrustSettingsResultDeny.
  17467. inline SecTrustSettingsResult
  17468. macos_ssl_trust_settings_result(CFArrayRef trust_settings) {
  17469. auto count = CFArrayGetCount(trust_settings);
  17470. if (count == 0) { return kSecTrustSettingsResultTrustRoot; }
  17471. for (CFIndex i = 0; i < count; i++) {
  17472. auto value = CFArrayGetValueAtIndex(trust_settings, i);
  17473. if (!value || CFGetTypeID(value) != CFDictionaryGetTypeID()) { continue; }
  17474. auto constraint = static_cast<CFDictionaryRef>(value);
  17475. auto policy_value =
  17476. CFDictionaryGetValue(constraint, kSecTrustSettingsPolicy);
  17477. if (policy_value) {
  17478. auto policy = static_cast<SecPolicyRef>(const_cast<void *>(policy_value));
  17479. auto is_ssl = false;
  17480. if (auto properties = SecPolicyCopyProperties(policy)) {
  17481. auto oid = CFDictionaryGetValue(properties, kSecPolicyOid);
  17482. is_ssl = oid && CFEqual(oid, kSecPolicyAppleSSL);
  17483. CFRelease(properties);
  17484. }
  17485. if (!is_ssl) { continue; }
  17486. }
  17487. if (CFDictionaryContainsKey(constraint, kSecTrustSettingsPolicyString) ||
  17488. CFDictionaryContainsKey(constraint, kSecTrustSettingsApplication)) {
  17489. continue;
  17490. }
  17491. auto result = kSecTrustSettingsResultTrustRoot;
  17492. auto number = static_cast<CFNumberRef>(
  17493. CFDictionaryGetValue(constraint, kSecTrustSettingsResult));
  17494. if (number) {
  17495. SInt32 number_value = 0;
  17496. if (!CFNumberGetValue(number, kCFNumberSInt32Type, &number_value)) {
  17497. continue;
  17498. }
  17499. result = static_cast<SecTrustSettingsResult>(number_value);
  17500. }
  17501. if (result == kSecTrustSettingsResultTrustRoot ||
  17502. result == kSecTrustSettingsResultTrustAsRoot ||
  17503. result == kSecTrustSettingsResultDeny) {
  17504. return result;
  17505. }
  17506. }
  17507. return kSecTrustSettingsResultUnspecified;
  17508. }
  17509. // Enumerate the macOS Keychain certificates trusted for SSL and call callback
  17510. // with DER data. A certificate with Trust Settings is not trusted just by
  17511. // having them: the settings say whether it is, and a per-user setting
  17512. // overrides the admin domain's, which overrides the system domain's (whose
  17513. // roots are all trusted). So a system root the user set to "Never Trust" is
  17514. // left out, as is one trusted only for S/MIME or code signing.
  17515. template <typename Callback>
  17516. inline bool enumerate_macos_keychain_certs(Callback cb) {
  17517. const SecTrustSettingsDomain domains[] = {
  17518. kSecTrustSettingsDomainUser,
  17519. kSecTrustSettingsDomainAdmin,
  17520. kSecTrustSettingsDomainSystem,
  17521. };
  17522. std::set<std::string> decided;
  17523. std::vector<std::string> trusted;
  17524. for (auto domain : domains) {
  17525. CFArrayRef certs = nullptr;
  17526. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  17527. if (status != errSecSuccess || !certs) {
  17528. if (certs) CFRelease(certs);
  17529. continue;
  17530. }
  17531. CFIndex count = CFArrayGetCount(certs);
  17532. for (CFIndex i = 0; i < count; i++) {
  17533. SecCertificateRef cert =
  17534. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  17535. CFDataRef data = SecCertificateCopyData(cert);
  17536. if (!data) { continue; }
  17537. std::string der(reinterpret_cast<const char *>(CFDataGetBytePtr(data)),
  17538. static_cast<size_t>(CFDataGetLength(data)));
  17539. CFRelease(data);
  17540. // Decided by a domain that overrides this one
  17541. if (decided.find(der) != decided.end()) { continue; }
  17542. auto result = kSecTrustSettingsResultTrustRoot;
  17543. if (domain != kSecTrustSettingsDomainSystem) {
  17544. result = kSecTrustSettingsResultUnspecified;
  17545. CFArrayRef trust_settings = nullptr;
  17546. if (SecTrustSettingsCopyTrustSettings(cert, domain, &trust_settings) ==
  17547. errSecSuccess &&
  17548. trust_settings) {
  17549. result = macos_ssl_trust_settings_result(trust_settings);
  17550. }
  17551. if (trust_settings) CFRelease(trust_settings);
  17552. }
  17553. // Neither trusted nor distrusted here; a domain below may decide
  17554. if (result == kSecTrustSettingsResultUnspecified) { continue; }
  17555. decided.insert(der);
  17556. if (result == kSecTrustSettingsResultTrustRoot ||
  17557. result == kSecTrustSettingsResultTrustAsRoot) {
  17558. trusted.push_back(std::move(der));
  17559. }
  17560. }
  17561. CFRelease(certs);
  17562. }
  17563. bool loaded = false;
  17564. for (const auto &der : trusted) {
  17565. if (cb(reinterpret_cast<const unsigned char *>(der.data()), der.size())) {
  17566. loaded = true;
  17567. }
  17568. }
  17569. return loaded;
  17570. }
  17571. #endif
  17572. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  17573. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  17574. // Common CA certificate file paths on Linux/Unix
  17575. inline const char **system_ca_paths() {
  17576. static const char *paths[] = {
  17577. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  17578. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  17579. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  17580. "/etc/pki/tls/cacert.pem", // OpenELEC
  17581. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  17582. nullptr};
  17583. return paths;
  17584. }
  17585. // Common CA certificate directory paths on Linux/Unix
  17586. inline const char **system_ca_dirs() {
  17587. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  17588. "/etc/pki/tls/certs", // RHEL/CentOS
  17589. "/usr/share/ca-certificates", // Other
  17590. nullptr};
  17591. return dirs;
  17592. }
  17593. #endif
  17594. } // namespace impl
  17595. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  17596. const char *ca_dir) {
  17597. if (!ctx) { return false; }
  17598. bool success = true;
  17599. if (ca_file && *ca_file) {
  17600. if (!load_ca_file(ctx, ca_file)) { success = false; }
  17601. }
  17602. if (ca_dir && *ca_dir) {
  17603. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  17604. }
  17605. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17606. // Set CA list for client certificate request (CertificateRequest message)
  17607. if (ca_file && *ca_file) {
  17608. auto list = SSL_load_client_CA_file(ca_file);
  17609. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  17610. }
  17611. #endif
  17612. return success;
  17613. }
  17614. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17615. const char *password) {
  17616. return set_client_cert_pem(ctx, cert, key, password);
  17617. }
  17618. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  17619. const char *key_path, const char *password) {
  17620. return set_client_cert_file(ctx, cert_path, key_path, password);
  17621. }
  17622. // PeerCert implementation
  17623. inline PeerCert::PeerCert() = default;
  17624. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  17625. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  17626. other.cert_ = nullptr;
  17627. }
  17628. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  17629. if (this != &other) {
  17630. if (cert_) { free_cert(cert_); }
  17631. cert_ = other.cert_;
  17632. other.cert_ = nullptr;
  17633. }
  17634. return *this;
  17635. }
  17636. inline PeerCert::~PeerCert() {
  17637. if (cert_) { free_cert(cert_); }
  17638. }
  17639. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  17640. inline std::string PeerCert::subject_cn() const {
  17641. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  17642. }
  17643. inline std::string PeerCert::issuer_name() const {
  17644. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  17645. }
  17646. inline bool PeerCert::check_hostname(const char *hostname) const {
  17647. return cert_ ? verify_hostname(cert_, hostname) : false;
  17648. }
  17649. inline std::vector<SanEntry> PeerCert::sans() const {
  17650. std::vector<SanEntry> result;
  17651. if (cert_) { get_cert_sans(cert_, result); }
  17652. return result;
  17653. }
  17654. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  17655. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  17656. }
  17657. inline std::string PeerCert::serial() const {
  17658. return cert_ ? get_cert_serial(cert_) : std::string();
  17659. }
  17660. // VerifyContext method implementations
  17661. inline std::string VerifyContext::subject_cn() const {
  17662. return cert ? get_cert_subject_cn(cert) : std::string();
  17663. }
  17664. inline std::string VerifyContext::issuer_name() const {
  17665. return cert ? get_cert_issuer_name(cert) : std::string();
  17666. }
  17667. inline bool VerifyContext::check_hostname(const char *hostname) const {
  17668. return cert ? verify_hostname(cert, hostname) : false;
  17669. }
  17670. inline std::vector<SanEntry> VerifyContext::sans() const {
  17671. std::vector<SanEntry> result;
  17672. if (cert) { get_cert_sans(cert, result); }
  17673. return result;
  17674. }
  17675. inline bool VerifyContext::validity(time_t &not_before,
  17676. time_t &not_after) const {
  17677. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  17678. }
  17679. inline std::string VerifyContext::serial() const {
  17680. return cert ? get_cert_serial(cert) : std::string();
  17681. }
  17682. // TlsError static method implementation
  17683. inline std::string TlsError::verify_error_to_string(long error_code) {
  17684. return verify_error_string(error_code);
  17685. }
  17686. } // namespace tls
  17687. // Request::peer_cert() implementation
  17688. inline tls::PeerCert Request::peer_cert() const {
  17689. return tls::get_peer_cert_from_session(ssl);
  17690. }
  17691. // Request::sni() implementation
  17692. inline std::string Request::sni() const {
  17693. if (!ssl) { return std::string(); }
  17694. const char *s = tls::get_sni(ssl);
  17695. return s ? std::string(s) : std::string();
  17696. }
  17697. #endif // CPPHTTPLIB_SSL_ENABLED
  17698. /*
  17699. * Group 8: TLS abstraction layer - OpenSSL backend
  17700. */
  17701. /*
  17702. * OpenSSL Backend Implementation
  17703. */
  17704. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17705. namespace tls {
  17706. namespace impl {
  17707. // Helper to map OpenSSL SSL_get_error to ErrorCode
  17708. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  17709. switch (ssl_error) {
  17710. case SSL_ERROR_NONE: return ErrorCode::Success;
  17711. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  17712. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  17713. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  17714. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  17715. case SSL_ERROR_SSL:
  17716. default: return ErrorCode::Fatal;
  17717. }
  17718. }
  17719. // Fills in a failed SSL_connect(). One that the server certificate's
  17720. // verification stopped reports the verify result, as the other backends and
  17721. // a check after the handshake do.
  17722. inline void fill_connect_error(SSL *ssl, int ret, TlsError &err) {
  17723. auto ssl_err = SSL_get_error(ssl, ret);
  17724. auto error = ERR_get_error();
  17725. err.code = map_ssl_error(ssl_err, err.sys_errno);
  17726. err.backend_code = error;
  17727. if (ssl_err != SSL_ERROR_SSL || ERR_GET_LIB(error) != ERR_LIB_SSL ||
  17728. ERR_GET_REASON(error) != SSL_R_CERTIFICATE_VERIFY_FAILED) {
  17729. return;
  17730. }
  17731. // A certificate only a verify callback turned down carries no verdict of
  17732. // its own, and fails as any other handshake does
  17733. auto verify_result = SSL_get_verify_result(ssl);
  17734. if (verify_result == X509_V_OK || verify_result == X509_V_ERR_UNSPECIFIED) {
  17735. return;
  17736. }
  17737. err.code = verify_result == X509_V_ERR_HOSTNAME_MISMATCH
  17738. ? ErrorCode::HostnameMismatch
  17739. : ErrorCode::CertVerifyFailed;
  17740. err.backend_code = static_cast<uint64_t>(verify_result);
  17741. }
  17742. // Helper: Create client CA list from PEM string
  17743. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  17744. // Caller takes ownership of returned list
  17745. inline STACK_OF(X509_NAME) *
  17746. create_client_ca_list_from_pem(const char *ca_pem) {
  17747. if (!ca_pem) { return nullptr; }
  17748. auto ca_list = sk_X509_NAME_new_null();
  17749. if (!ca_list) { return nullptr; }
  17750. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  17751. if (!bio) {
  17752. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  17753. return nullptr;
  17754. }
  17755. X509 *cert = nullptr;
  17756. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17757. nullptr) {
  17758. const X509_NAME *name = X509_get_subject_name(cert);
  17759. if (name) {
  17760. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  17761. }
  17762. X509_free(cert);
  17763. }
  17764. BIO_free(bio);
  17765. return ca_list;
  17766. }
  17767. inline void free_verify_callback(void * /*parent*/, void *ptr,
  17768. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  17769. long /*argl*/, void * /*argp*/) {
  17770. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  17771. }
  17772. // The SSL_CTX owns its verify callback, so each client or server sees only
  17773. // its own, on whichever thread runs the handshake.
  17774. inline int verify_callback_index() {
  17775. static const auto index = SSL_CTX_get_ex_new_index(
  17776. 0, nullptr, nullptr, nullptr, free_verify_callback);
  17777. return index;
  17778. }
  17779. // OpenSSL verify callback wrapper
  17780. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  17781. // Get SSL object from X509_STORE_CTX
  17782. auto ssl = static_cast<SSL *>(
  17783. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  17784. if (!ssl) { return preverify_ok; }
  17785. std::shared_ptr<VerifyCallback> callback;
  17786. {
  17787. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  17788. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  17789. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  17790. if (stored) { callback = *stored; }
  17791. }
  17792. if (!callback) { return preverify_ok; }
  17793. // Get current certificate and depth
  17794. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  17795. int depth = X509_STORE_CTX_get_error_depth(ctx);
  17796. int error = X509_STORE_CTX_get_error(ctx);
  17797. // Build context
  17798. VerifyContext verify_ctx;
  17799. verify_ctx.session = static_cast<session_t>(ssl);
  17800. verify_ctx.cert = static_cast<cert_t>(cert);
  17801. verify_ctx.depth = depth;
  17802. verify_ctx.preverify_ok = (preverify_ok != 0);
  17803. verify_ctx.error_code = error;
  17804. verify_ctx.error_string =
  17805. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  17806. auto accepted = run_verify_callback(*callback, verify_ctx);
  17807. // A client verifying the server during the handshake, which is what
  17808. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  17809. if (!SSL_is_server(ssl) &&
  17810. (SSL_get_verify_mode(ssl) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  17811. accepted = accepted && preverify_ok;
  17812. }
  17813. return accepted ? 1 : 0;
  17814. }
  17815. // Sets the verify mode from whether the peer's certificate is required and
  17816. // whether a verify callback is set.
  17817. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  17818. auto has_callback =
  17819. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  17820. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  17821. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  17822. SSL_CTX_set_verify(ssl_ctx, mode,
  17823. has_callback ? openssl_verify_callback : nullptr);
  17824. }
  17825. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  17826. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  17827. // that must be released with release_store_objects
  17828. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  17829. OPENSSL_VERSION_NUMBER >= 0x30300000L
  17830. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17831. #endif
  17832. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  17833. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17834. return X509_STORE_get1_objects(store);
  17835. #else
  17836. return X509_STORE_get0_objects(store);
  17837. #endif
  17838. }
  17839. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  17840. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17841. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  17842. #else
  17843. (void)objs; // get0 variant returns an internal pointer; nothing to free
  17844. #endif
  17845. }
  17846. } // namespace impl
  17847. inline ctx_t create_client_context() {
  17848. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  17849. if (ctx) {
  17850. // Disable auto-retry to properly handle non-blocking I/O
  17851. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  17852. // Set minimum TLS version
  17853. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17854. }
  17855. return static_cast<ctx_t>(ctx);
  17856. }
  17857. inline void free_context(ctx_t ctx) {
  17858. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  17859. }
  17860. inline bool set_min_version(ctx_t ctx, Version version) {
  17861. if (!ctx) return false;
  17862. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  17863. static_cast<uint16_t>(version)) == 1;
  17864. }
  17865. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17866. if (!ctx || !pem || len == 0) return false;
  17867. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17868. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17869. if (!store) return false;
  17870. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  17871. if (!bio) return false;
  17872. bool ok = true;
  17873. X509 *cert = nullptr;
  17874. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17875. nullptr) {
  17876. if (X509_STORE_add_cert(store, cert) != 1) {
  17877. // Ignore duplicate errors
  17878. auto err = ERR_peek_last_error();
  17879. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  17880. ok = false;
  17881. }
  17882. }
  17883. X509_free(cert);
  17884. if (!ok) break;
  17885. }
  17886. BIO_free(bio);
  17887. // Clear any "no more certificates" errors
  17888. ERR_clear_error();
  17889. return ok;
  17890. }
  17891. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17892. if (!ctx || !file_path) return false;
  17893. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  17894. nullptr) == 1;
  17895. }
  17896. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17897. if (!ctx || !dir_path) return false;
  17898. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  17899. dir_path) == 1;
  17900. }
  17901. inline bool load_system_certs(ctx_t ctx) {
  17902. if (!ctx) return false;
  17903. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17904. #ifdef _WIN32
  17905. // Windows: Load from system certificate store (ROOT and CA)
  17906. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17907. if (!store) return false;
  17908. bool loaded_any = false;
  17909. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17910. for (auto store_name : store_names) {
  17911. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  17912. if (!hStore) continue;
  17913. PCCERT_CONTEXT pContext = nullptr;
  17914. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17915. nullptr) {
  17916. const unsigned char *data = pContext->pbCertEncoded;
  17917. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  17918. if (x509) {
  17919. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17920. X509_free(x509);
  17921. }
  17922. }
  17923. CertCloseStore(hStore, 0);
  17924. }
  17925. return loaded_any;
  17926. #elif defined(__APPLE__)
  17927. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17928. // macOS: Load from Keychain
  17929. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17930. if (!store) return false;
  17931. auto loaded_any = impl::enumerate_macos_keychain_certs(
  17932. [&](const unsigned char *data, size_t len) {
  17933. auto x509 = d2i_X509(nullptr, &data, static_cast<long>(len));
  17934. if (!x509) { return false; }
  17935. auto added = X509_STORE_add_cert(store, x509) == 1;
  17936. X509_free(x509);
  17937. return added;
  17938. });
  17939. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17940. #else
  17941. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17942. #endif
  17943. #else
  17944. // Other Unix: use default verify paths
  17945. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17946. #endif
  17947. }
  17948. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17949. const char *password) {
  17950. if (!ctx || !cert || !key) return false;
  17951. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17952. // Load certificate
  17953. auto cert_bio = BIO_new_mem_buf(cert, -1);
  17954. if (!cert_bio) return false;
  17955. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17956. BIO_free(cert_bio);
  17957. if (!x509) return false;
  17958. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  17959. X509_free(x509);
  17960. if (!cert_ok) return false;
  17961. // Load private key
  17962. auto key_bio = BIO_new_mem_buf(key, -1);
  17963. if (!key_bio) return false;
  17964. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17965. password ? const_cast<char *>(password)
  17966. : nullptr);
  17967. BIO_free(key_bio);
  17968. if (!pkey) return false;
  17969. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  17970. EVP_PKEY_free(pkey);
  17971. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  17972. }
  17973. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17974. const char *key_path, const char *password) {
  17975. if (!ctx || !cert_path || !key_path) return false;
  17976. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17977. if (password && password[0] != '\0') {
  17978. SSL_CTX_set_default_passwd_cb_userdata(
  17979. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  17980. }
  17981. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  17982. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  17983. }
  17984. inline ctx_t create_server_context() {
  17985. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17986. if (ctx) {
  17987. // No renegotiation, as on the other backends: it would run a handshake
  17988. // that SSLServer::update_certs_pem() does not wait for
  17989. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  17990. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  17991. SSL_OP_NO_RENEGOTIATION);
  17992. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17993. // Without one, a client resuming its session is sent a fatal alert once
  17994. // client certificates are verified.
  17995. static const unsigned char sid_ctx[] = "cpp-httplib";
  17996. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  17997. }
  17998. return static_cast<ctx_t>(ctx);
  17999. }
  18000. inline void set_verify_client(ctx_t ctx, bool require) {
  18001. if (!ctx) return;
  18002. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  18003. }
  18004. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18005. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  18006. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18007. SSL *ssl = SSL_new(ssl_ctx);
  18008. if (!ssl) return nullptr;
  18009. // Disable auto-retry for proper non-blocking I/O handling
  18010. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  18011. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  18012. if (!bio) {
  18013. SSL_free(ssl);
  18014. return nullptr;
  18015. }
  18016. SSL_set_bio(ssl, bio, bio);
  18017. return static_cast<session_t>(ssl);
  18018. }
  18019. inline void free_session(session_t session) {
  18020. if (session) { SSL_free(static_cast<SSL *>(session)); }
  18021. }
  18022. inline bool set_sni(session_t session, const char *hostname,
  18023. bool verify_hostname) {
  18024. if (!session || !hostname) return false;
  18025. auto ssl = static_cast<SSL *>(session);
  18026. // The handshake's chain verification then checks the name as well
  18027. if (verify_hostname) {
  18028. auto param = SSL_get0_param(ssl);
  18029. X509_VERIFY_PARAM_set_hostflags(param, X509_CHECK_FLAG_NEVER_CHECK_SUBJECT);
  18030. if (X509_VERIFY_PARAM_set1_host(param, hostname, strlen(hostname)) != 1) {
  18031. return false;
  18032. }
  18033. }
  18034. #if defined(OPENSSL_IS_BORINGSSL)
  18035. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  18036. #else
  18037. // Direct call instead of macro to suppress -Wold-style-cast warning
  18038. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  18039. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  18040. #endif
  18041. }
  18042. inline TlsError connect(session_t session) {
  18043. if (!session) { return TlsError(); }
  18044. auto ssl = static_cast<SSL *>(session);
  18045. auto ret = SSL_connect(ssl);
  18046. TlsError err;
  18047. if (ret == 1) {
  18048. err.code = ErrorCode::Success;
  18049. } else {
  18050. impl::fill_connect_error(ssl, ret, err);
  18051. }
  18052. return err;
  18053. }
  18054. inline TlsError accept(session_t session) {
  18055. if (!session) { return TlsError(); }
  18056. auto ssl = static_cast<SSL *>(session);
  18057. auto ret = SSL_accept(ssl);
  18058. TlsError err;
  18059. if (ret == 1) {
  18060. err.code = ErrorCode::Success;
  18061. } else {
  18062. auto ssl_err = SSL_get_error(ssl, ret);
  18063. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  18064. err.backend_code = ERR_get_error();
  18065. }
  18066. return err;
  18067. }
  18068. inline bool connect_nonblocking(session_t session, socket_t sock,
  18069. time_t timeout_sec, time_t timeout_usec,
  18070. TlsError *err,
  18071. const std::function<bool()> &interrupted) {
  18072. if (!session) {
  18073. if (err) { err->code = ErrorCode::Fatal; }
  18074. return false;
  18075. }
  18076. auto ssl = static_cast<SSL *>(session);
  18077. auto bio = SSL_get_rbio(ssl);
  18078. // Set non-blocking mode for handshake
  18079. detail::set_nonblocking(sock, true);
  18080. if (bio) { BIO_set_nbio(bio, 1); }
  18081. auto cleanup = detail::scope_exit([&]() {
  18082. // Restore blocking mode after handshake
  18083. if (bio) { BIO_set_nbio(bio, 0); }
  18084. detail::set_nonblocking(sock, false);
  18085. });
  18086. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18087. auto res = 0;
  18088. while ((res = SSL_connect(ssl)) != 1) {
  18089. auto ssl_err = SSL_get_error(ssl, res);
  18090. switch (ssl_err) {
  18091. case SSL_ERROR_WANT_READ:
  18092. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  18093. continue;
  18094. }
  18095. break;
  18096. case SSL_ERROR_WANT_WRITE:
  18097. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  18098. continue;
  18099. }
  18100. break;
  18101. default: break;
  18102. }
  18103. if (err) { impl::fill_connect_error(ssl, res, *err); }
  18104. return false;
  18105. }
  18106. if (err) { err->code = ErrorCode::Success; }
  18107. return true;
  18108. }
  18109. inline bool accept_nonblocking(session_t session, socket_t sock,
  18110. time_t timeout_sec, time_t timeout_usec,
  18111. TlsError *err) {
  18112. if (!session) {
  18113. if (err) { err->code = ErrorCode::Fatal; }
  18114. return false;
  18115. }
  18116. auto ssl = static_cast<SSL *>(session);
  18117. auto bio = SSL_get_rbio(ssl);
  18118. // Set non-blocking mode for handshake
  18119. detail::set_nonblocking(sock, true);
  18120. if (bio) { BIO_set_nbio(bio, 1); }
  18121. auto cleanup = detail::scope_exit([&]() {
  18122. // Restore blocking mode after handshake
  18123. if (bio) { BIO_set_nbio(bio, 0); }
  18124. detail::set_nonblocking(sock, false);
  18125. });
  18126. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18127. auto res = 0;
  18128. while ((res = SSL_accept(ssl)) != 1) {
  18129. auto ssl_err = SSL_get_error(ssl, res);
  18130. switch (ssl_err) {
  18131. case SSL_ERROR_WANT_READ:
  18132. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18133. break;
  18134. case SSL_ERROR_WANT_WRITE:
  18135. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18136. break;
  18137. default: break;
  18138. }
  18139. if (err) {
  18140. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  18141. err->backend_code = ERR_get_error();
  18142. }
  18143. return false;
  18144. }
  18145. if (err) { err->code = ErrorCode::Success; }
  18146. return true;
  18147. }
  18148. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18149. if (!session || !buf) {
  18150. err.code = ErrorCode::Fatal;
  18151. return -1;
  18152. }
  18153. auto ssl = static_cast<SSL *>(session);
  18154. constexpr auto max_len =
  18155. static_cast<size_t>((std::numeric_limits<int>::max)());
  18156. if (len > max_len) { len = max_len; }
  18157. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  18158. if (ret > 0) {
  18159. err.code = ErrorCode::Success;
  18160. return ret;
  18161. }
  18162. auto ssl_err = SSL_get_error(ssl, ret);
  18163. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  18164. if (err.code == ErrorCode::PeerClosed) {
  18165. return 0;
  18166. } // Gracefully handle the peer closed state.
  18167. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  18168. return -1;
  18169. }
  18170. inline ssize_t write(session_t session, const void *buf, size_t len,
  18171. TlsError &err) {
  18172. if (!session || !buf) {
  18173. err.code = ErrorCode::Fatal;
  18174. return -1;
  18175. }
  18176. auto ssl = static_cast<SSL *>(session);
  18177. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  18178. if (ret > 0) {
  18179. err.code = ErrorCode::Success;
  18180. return ret;
  18181. }
  18182. auto ssl_err = SSL_get_error(ssl, ret);
  18183. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  18184. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  18185. return -1;
  18186. }
  18187. inline int pending(const_session_t session) {
  18188. if (!session) return 0;
  18189. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  18190. }
  18191. inline void shutdown(session_t session, bool graceful) {
  18192. if (!session) return;
  18193. auto ssl = static_cast<SSL *>(session);
  18194. if (graceful) {
  18195. // Send close_notify without waiting for the peer's. The connection is
  18196. // closed right after this, so a unidirectional shutdown is enough, and an
  18197. // idle peer that never answers would otherwise hold this thread until the
  18198. // read timeout. The other backends do not wait either.
  18199. SSL_shutdown(ssl);
  18200. }
  18201. }
  18202. inline bool is_peer_closed(session_t session, socket_t sock) {
  18203. if (!session) return true;
  18204. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  18205. detail::set_nonblocking(sock, true);
  18206. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18207. auto ssl = static_cast<SSL *>(session);
  18208. char buf;
  18209. auto ret = SSL_peek(ssl, &buf, 1);
  18210. if (ret > 0) return false;
  18211. auto err = SSL_get_error(ssl, ret);
  18212. return err == SSL_ERROR_ZERO_RETURN;
  18213. }
  18214. inline cert_t get_peer_cert(const_session_t session) {
  18215. if (!session) return nullptr;
  18216. return static_cast<cert_t>(SSL_get1_peer_certificate(
  18217. static_cast<SSL *>(const_cast<void *>(session))));
  18218. }
  18219. inline size_t get_peer_certs(const_session_t session,
  18220. std::vector<cert_t> &certs) {
  18221. certs.clear();
  18222. if (!session) { return 0; }
  18223. auto ssl = static_cast<const SSL *>(session);
  18224. // On the server side, the chain leaves out the peer's own certificate
  18225. if (SSL_is_server(ssl)) {
  18226. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  18227. }
  18228. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  18229. auto count = sk_X509_num(sk);
  18230. for (decltype(count) i = 0; i < count; i++) {
  18231. auto x509 = sk_X509_value(sk, i);
  18232. X509_up_ref(x509);
  18233. certs.push_back(static_cast<cert_t>(x509));
  18234. }
  18235. }
  18236. return certs.size();
  18237. }
  18238. inline void free_cert(cert_t cert) {
  18239. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  18240. }
  18241. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18242. if (!cert || !hostname) return false;
  18243. auto x509 = static_cast<X509 *>(cert);
  18244. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  18245. if (detail::is_ip_address(hostname)) {
  18246. return X509_check_ip_asc(x509, hostname, 0) == 1;
  18247. }
  18248. return X509_check_host(x509, hostname, strlen(hostname),
  18249. X509_CHECK_FLAG_NEVER_CHECK_SUBJECT, nullptr) == 1;
  18250. }
  18251. inline uint64_t hostname_mismatch_code() {
  18252. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  18253. }
  18254. inline long get_verify_result(const_session_t session) {
  18255. if (!session) return X509_V_ERR_UNSPECIFIED;
  18256. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  18257. }
  18258. inline std::string get_cert_subject_cn(cert_t cert) {
  18259. if (!cert) return "";
  18260. auto x509 = static_cast<X509 *>(cert);
  18261. auto subject_name = X509_get_subject_name(x509);
  18262. if (!subject_name) return "";
  18263. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  18264. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  18265. if (idx < 0) return "";
  18266. auto entry = X509_NAME_get_entry(subject_name, idx);
  18267. if (!entry) return "";
  18268. auto data = X509_NAME_ENTRY_get_data(entry);
  18269. if (!data) return "";
  18270. return std::string(
  18271. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  18272. static_cast<size_t>(ASN1_STRING_length(data)));
  18273. }
  18274. inline std::string get_cert_issuer_name(cert_t cert) {
  18275. if (!cert) return "";
  18276. auto x509 = static_cast<X509 *>(cert);
  18277. auto issuer_name = X509_get_issuer_name(x509);
  18278. if (!issuer_name) return "";
  18279. char buf[256];
  18280. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  18281. return std::string(buf);
  18282. }
  18283. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18284. sans.clear();
  18285. if (!cert) return false;
  18286. auto x509 = static_cast<X509 *>(cert);
  18287. auto names = static_cast<GENERAL_NAMES *>(
  18288. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18289. if (!names) return true; // No SANs is valid
  18290. auto count = sk_GENERAL_NAME_num(names);
  18291. for (decltype(count) i = 0; i < count; i++) {
  18292. auto gen = sk_GENERAL_NAME_value(names, i);
  18293. if (!gen) continue;
  18294. SanEntry entry;
  18295. switch (gen->type) {
  18296. case GEN_DNS:
  18297. entry.type = SanType::DNS;
  18298. if (gen->d.dNSName) {
  18299. entry.value = std::string(
  18300. reinterpret_cast<const char *>(
  18301. ASN1_STRING_get0_data(gen->d.dNSName)),
  18302. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  18303. }
  18304. break;
  18305. case GEN_IPADD:
  18306. entry.type = SanType::IP;
  18307. if (gen->d.iPAddress) {
  18308. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  18309. auto len = ASN1_STRING_length(gen->d.iPAddress);
  18310. if (len == 4) {
  18311. // IPv4
  18312. char buf[INET_ADDRSTRLEN];
  18313. inet_ntop(AF_INET, data, buf, sizeof(buf));
  18314. entry.value = buf;
  18315. } else if (len == 16) {
  18316. // IPv6
  18317. char buf[INET6_ADDRSTRLEN];
  18318. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  18319. entry.value = buf;
  18320. }
  18321. }
  18322. break;
  18323. case GEN_EMAIL:
  18324. entry.type = SanType::EMAIL;
  18325. if (gen->d.rfc822Name) {
  18326. entry.value = std::string(
  18327. reinterpret_cast<const char *>(
  18328. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  18329. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  18330. }
  18331. break;
  18332. case GEN_URI:
  18333. entry.type = SanType::URI;
  18334. if (gen->d.uniformResourceIdentifier) {
  18335. entry.value = std::string(
  18336. reinterpret_cast<const char *>(
  18337. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  18338. static_cast<size_t>(
  18339. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  18340. }
  18341. break;
  18342. default: entry.type = SanType::OTHER; break;
  18343. }
  18344. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18345. }
  18346. GENERAL_NAMES_free(names);
  18347. return true;
  18348. }
  18349. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18350. time_t &not_after) {
  18351. if (!cert) return false;
  18352. auto x509 = static_cast<X509 *>(cert);
  18353. auto nb = X509_get0_notBefore(x509);
  18354. auto na = X509_get0_notAfter(x509);
  18355. if (!nb || !na) return false;
  18356. ASN1_TIME *epoch = ASN1_TIME_new();
  18357. if (!epoch) return false;
  18358. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  18359. if (!ASN1_TIME_set(epoch, 0)) return false;
  18360. int pday, psec;
  18361. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  18362. not_before = 86400 * (time_t)pday + psec;
  18363. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  18364. not_after = 86400 * (time_t)pday + psec;
  18365. return true;
  18366. }
  18367. inline std::string get_cert_serial(cert_t cert) {
  18368. if (!cert) return "";
  18369. auto x509 = static_cast<X509 *>(cert);
  18370. auto serial = X509_get_serialNumber(x509);
  18371. if (!serial) return "";
  18372. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  18373. if (!bn) return "";
  18374. auto hex = BN_bn2hex(bn);
  18375. BN_free(bn);
  18376. if (!hex) return "";
  18377. std::string result(hex);
  18378. OPENSSL_free(hex);
  18379. return result;
  18380. }
  18381. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18382. if (!cert) return false;
  18383. auto x509 = static_cast<X509 *>(cert);
  18384. auto len = i2d_X509(x509, nullptr);
  18385. if (len < 0) return false;
  18386. der.resize(static_cast<size_t>(len));
  18387. auto p = der.data();
  18388. i2d_X509(x509, &p);
  18389. return true;
  18390. }
  18391. inline const char *get_sni(const_session_t session) {
  18392. if (!session) return nullptr;
  18393. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  18394. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  18395. }
  18396. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  18397. inline uint64_t get_error() { return ERR_get_error(); }
  18398. inline std::string error_string(uint64_t code) {
  18399. char buf[256];
  18400. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  18401. sizeof(buf));
  18402. return std::string(buf);
  18403. }
  18404. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18405. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  18406. if (!mem) { return nullptr; }
  18407. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  18408. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  18409. if (!inf) { return nullptr; }
  18410. auto store = X509_STORE_new();
  18411. if (store) {
  18412. auto count = sk_X509_INFO_num(inf);
  18413. for (decltype(count) i = 0; i < count; i++) {
  18414. auto itmp = sk_X509_INFO_value(inf, i);
  18415. if (!itmp) { continue; }
  18416. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  18417. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  18418. }
  18419. }
  18420. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  18421. return static_cast<ca_store_t>(store);
  18422. }
  18423. inline void free_ca_store(ca_store_t store) {
  18424. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  18425. }
  18426. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18427. if (!ctx || !store) { return false; }
  18428. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18429. auto x509_store = static_cast<X509_STORE *>(store);
  18430. // Check if same store is already set
  18431. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  18432. // SSL_CTX_set_cert_store takes ownership and frees the old store
  18433. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  18434. return true;
  18435. }
  18436. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18437. certs.clear();
  18438. if (!ctx) { return 0; }
  18439. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18440. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  18441. if (!store) { return 0; }
  18442. auto objs = impl::get_store_objects(store);
  18443. if (!objs) { return 0; }
  18444. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  18445. auto count = sk_X509_OBJECT_num(objs);
  18446. for (decltype(count) i = 0; i < count; i++) {
  18447. auto obj = sk_X509_OBJECT_value(objs, i);
  18448. if (!obj) { continue; }
  18449. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  18450. auto x509 = X509_OBJECT_get0_X509(obj);
  18451. if (x509) {
  18452. // Increment reference count so caller can free it
  18453. X509_up_ref(x509);
  18454. certs.push_back(static_cast<cert_t>(x509));
  18455. }
  18456. }
  18457. }
  18458. return certs.size();
  18459. }
  18460. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18461. std::vector<std::string> names;
  18462. if (!ctx) { return names; }
  18463. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18464. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  18465. if (!store) { return names; }
  18466. auto objs = impl::get_store_objects(store);
  18467. if (!objs) { return names; }
  18468. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  18469. auto count = sk_X509_OBJECT_num(objs);
  18470. for (decltype(count) i = 0; i < count; i++) {
  18471. auto obj = sk_X509_OBJECT_value(objs, i);
  18472. if (!obj) { continue; }
  18473. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  18474. auto x509 = X509_OBJECT_get0_X509(obj);
  18475. if (x509) {
  18476. auto subject = X509_get_subject_name(x509);
  18477. if (subject) {
  18478. char buf[512];
  18479. X509_NAME_oneline(subject, buf, sizeof(buf));
  18480. names.push_back(buf);
  18481. }
  18482. }
  18483. }
  18484. }
  18485. return names;
  18486. }
  18487. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18488. const char *key_pem, const char *password) {
  18489. if (!ctx || !cert_pem || !key_pem) { return false; }
  18490. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18491. // Load certificate from PEM
  18492. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  18493. if (!cert_bio) { return false; }
  18494. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  18495. BIO_free(cert_bio);
  18496. if (!cert) { return false; }
  18497. // Load private key from PEM
  18498. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  18499. if (!key_bio) {
  18500. X509_free(cert);
  18501. return false;
  18502. }
  18503. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  18504. password ? const_cast<char *>(password)
  18505. : nullptr);
  18506. BIO_free(key_bio);
  18507. if (!key) {
  18508. X509_free(cert);
  18509. return false;
  18510. }
  18511. // Update certificate and key
  18512. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  18513. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  18514. X509_free(cert);
  18515. EVP_PKEY_free(key);
  18516. return ret;
  18517. }
  18518. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18519. if (!ctx || !ca_pem) { return false; }
  18520. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18521. // Create new X509_STORE from PEM
  18522. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  18523. if (!store) { return false; }
  18524. // A resumed session is not verified again, so the ticket keys from before
  18525. // go, or a client verified under the old CAs could go on resuming.
  18526. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  18527. unsigned char ticket_keys[48];
  18528. #else
  18529. unsigned char ticket_keys[80];
  18530. #endif
  18531. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  18532. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  18533. sizeof(ticket_keys)) != 1) {
  18534. free_ca_store(store);
  18535. return false;
  18536. }
  18537. // SSL_CTX_set_cert_store takes ownership
  18538. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  18539. // Set client CA list for client certificate request
  18540. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  18541. if (ca_list) {
  18542. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  18543. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  18544. }
  18545. // The cached sessions go for the same reason.
  18546. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  18547. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  18548. #else
  18549. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  18550. #endif
  18551. return true;
  18552. }
  18553. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18554. if (!ctx) { return false; }
  18555. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18556. auto index = impl::verify_callback_index();
  18557. if (index < 0) { return false; }
  18558. std::shared_ptr<VerifyCallback> *stored = nullptr;
  18559. if (callback) {
  18560. stored = new std::shared_ptr<VerifyCallback>(
  18561. std::make_shared<VerifyCallback>(std::move(callback)));
  18562. }
  18563. std::shared_ptr<VerifyCallback> *previous = nullptr;
  18564. {
  18565. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  18566. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  18567. SSL_CTX_get_ex_data(ssl_ctx, index));
  18568. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  18569. delete stored;
  18570. return false;
  18571. }
  18572. }
  18573. // A handshake running the previous callback keeps it until it returns.
  18574. delete previous;
  18575. // A resumed handshake shows no certificate to run the callback on.
  18576. if (stored) {
  18577. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  18578. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  18579. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  18580. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  18581. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  18582. #endif
  18583. }
  18584. // Keep requiring the peer's certificate if set_verify_client() asked for it
  18585. auto require =
  18586. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  18587. impl::apply_verify_mode(ssl_ctx, require);
  18588. return true;
  18589. }
  18590. inline long get_verify_error(const_session_t session) {
  18591. if (!session) { return -1; }
  18592. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  18593. return SSL_get_verify_result(ssl);
  18594. }
  18595. inline std::string verify_error_string(long error_code) {
  18596. if (error_code == X509_V_OK) { return ""; }
  18597. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  18598. return str ? str : "unknown error";
  18599. }
  18600. } // namespace tls
  18601. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  18602. /*
  18603. * Group 9: TLS abstraction layer - Mbed TLS backend
  18604. */
  18605. /*
  18606. * Mbed TLS Backend Implementation
  18607. */
  18608. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  18609. namespace tls {
  18610. namespace impl {
  18611. // Mbed TLS session wrapper
  18612. struct MbedTlsSession {
  18613. mbedtls_ssl_context ssl;
  18614. socket_t sock = INVALID_SOCKET;
  18615. std::string hostname; // For client: set via set_sni
  18616. std::string sni_hostname; // For server: received from client via SNI callback
  18617. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  18618. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  18619. // (e.g. a response that arrived while this side was still in its post-write
  18620. // check), the byte is pushed back here and served by the next read().
  18621. unsigned char peeked_byte = 0;
  18622. bool has_peeked_byte = false;
  18623. // Set by set_sni() when the caller disabled hostname verification, so the
  18624. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  18625. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  18626. // OpenSSL and wolfSSL keep them independent).
  18627. bool suppress_hostname_mismatch = false;
  18628. // Copied from the owning MbedTlsContext at creation, so a handshake only
  18629. // ever runs the callback of its own context.
  18630. VerifyCallback verify_callback;
  18631. bool is_server = false;
  18632. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  18633. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  18634. MbedTlsSession(const MbedTlsSession &) = delete;
  18635. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  18636. };
  18637. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  18638. // queue)
  18639. inline int &mbedtls_last_error() {
  18640. static thread_local int err = 0;
  18641. return err;
  18642. }
  18643. // Helper to map Mbed TLS error to ErrorCode
  18644. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  18645. uint32_t verify_flags) {
  18646. if (ret == 0) { return ErrorCode::Success; }
  18647. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  18648. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  18649. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  18650. return ErrorCode::PeerClosed;
  18651. }
  18652. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  18653. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  18654. out_errno = errno;
  18655. return ErrorCode::SyscallError;
  18656. }
  18657. if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
  18658. // EOF without close_notify
  18659. out_errno = 0;
  18660. return ErrorCode::SyscallError;
  18661. }
  18662. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  18663. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  18664. // the handshake's chain verification (see set_sni()); a mismatch there
  18665. // is reported the same way as any other verify_flags bit. Report it as
  18666. // HostnameMismatch, matching the other backends and the post-handshake
  18667. // identity check below, but only when naming is the sole problem -
  18668. // if the chain itself is also untrusted/expired/etc., that takes
  18669. // priority over the naming detail.
  18670. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  18671. return ErrorCode::HostnameMismatch;
  18672. }
  18673. return ErrorCode::CertVerifyFailed;
  18674. }
  18675. return ErrorCode::Fatal;
  18676. }
  18677. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  18678. // return value, including the verify-flags-dependent HostnameMismatch
  18679. // mapping; shared by connect() and connect_nonblocking() so the
  18680. // backend_code policy for that mapping only lives in one place.
  18681. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  18682. int ret) {
  18683. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  18684. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  18685. err.backend_code = err.code == ErrorCode::HostnameMismatch
  18686. ? static_cast<uint64_t>(verify_flags)
  18687. : static_cast<uint64_t>(-ret);
  18688. }
  18689. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  18690. // non-fatal notification delivered between records, not an error and not
  18691. // application data, so I/O calls that see it should just be retried. Kept in
  18692. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  18693. // splitting the closing brace across an #if.
  18694. inline bool mbedtls_is_session_ticket(int ret) {
  18695. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  18696. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  18697. #else
  18698. (void)ret;
  18699. return false;
  18700. #endif
  18701. }
  18702. // BIO-like send callback for Mbed TLS
  18703. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  18704. size_t len) {
  18705. auto sock = *static_cast<socket_t *>(ctx);
  18706. #ifdef _WIN32
  18707. auto ret =
  18708. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  18709. if (ret == SOCKET_ERROR) {
  18710. int err = WSAGetLastError();
  18711. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  18712. return MBEDTLS_ERR_NET_SEND_FAILED;
  18713. }
  18714. #else
  18715. auto ret = send(sock, buf, len, 0);
  18716. if (ret < 0) {
  18717. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18718. return MBEDTLS_ERR_SSL_WANT_WRITE;
  18719. }
  18720. return MBEDTLS_ERR_NET_SEND_FAILED;
  18721. }
  18722. #endif
  18723. return static_cast<int>(ret);
  18724. }
  18725. // BIO-like recv callback for Mbed TLS
  18726. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  18727. auto sock = *static_cast<socket_t *>(ctx);
  18728. #ifdef _WIN32
  18729. auto ret =
  18730. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  18731. if (ret == SOCKET_ERROR) {
  18732. int err = WSAGetLastError();
  18733. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  18734. return MBEDTLS_ERR_NET_RECV_FAILED;
  18735. }
  18736. #else
  18737. auto ret = recv(sock, buf, len, 0);
  18738. if (ret < 0) {
  18739. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18740. return MBEDTLS_ERR_SSL_WANT_READ;
  18741. }
  18742. return MBEDTLS_ERR_NET_RECV_FAILED;
  18743. }
  18744. #endif
  18745. // EOF is MBEDTLS_ERR_SSL_CONN_EOF; only a close_notify is a clean end
  18746. return static_cast<int>(ret);
  18747. }
  18748. // MbedTlsContext constructor/destructor implementations
  18749. inline MbedTlsContext::MbedTlsContext() {
  18750. mbedtls_ssl_config_init(&conf);
  18751. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18752. mbedtls_entropy_init(&entropy);
  18753. mbedtls_ctr_drbg_init(&ctr_drbg);
  18754. #endif
  18755. mbedtls_x509_crt_init(&ca_chain);
  18756. mbedtls_x509_crt_init(&own_cert);
  18757. mbedtls_pk_init(&own_key);
  18758. }
  18759. inline MbedTlsContext::~MbedTlsContext() {
  18760. mbedtls_pk_free(&own_key);
  18761. mbedtls_x509_crt_free(&own_cert);
  18762. mbedtls_x509_crt_free(&ca_chain);
  18763. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18764. mbedtls_ctr_drbg_free(&ctr_drbg);
  18765. mbedtls_entropy_free(&entropy);
  18766. #endif
  18767. mbedtls_ssl_config_free(&conf);
  18768. }
  18769. // Thread-local storage for SNI captured during handshake
  18770. // This is needed because the SNI callback doesn't have a way to pass
  18771. // session-specific data before the session is fully set up
  18772. inline std::string &mbedpending_sni() {
  18773. static thread_local std::string sni;
  18774. return sni;
  18775. }
  18776. // SNI callback for Mbed TLS server to capture client's SNI hostname
  18777. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  18778. const unsigned char *name, size_t name_len) {
  18779. (void)p_ctx;
  18780. (void)ssl;
  18781. // Store SNI name in thread-local storage
  18782. // It will be retrieved and stored in the session after handshake
  18783. if (name && name_len > 0) {
  18784. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  18785. } else {
  18786. mbedpending_sni().clear();
  18787. }
  18788. return 0; // Accept any SNI
  18789. }
  18790. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  18791. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  18792. }
  18793. // MbedTLS verify callback wrapper
  18794. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  18795. int cert_depth, uint32_t *flags) {
  18796. // data points to the MbedTlsSession
  18797. auto *session = static_cast<MbedTlsSession *>(data);
  18798. // set_sni() disabled hostname verification for this session: ignore the
  18799. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  18800. // pass/fail decision still comes from the remaining flags (and, below, from
  18801. // the user's own verify callback).
  18802. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  18803. const auto &callback = session->verify_callback;
  18804. if (!callback) { return 0; } // Continue with default verification
  18805. // Build context
  18806. VerifyContext verify_ctx;
  18807. verify_ctx.session = static_cast<session_t>(session);
  18808. verify_ctx.cert = static_cast<cert_t>(crt);
  18809. verify_ctx.depth = cert_depth;
  18810. verify_ctx.preverify_ok = (*flags == 0);
  18811. verify_ctx.error_code = static_cast<long>(*flags);
  18812. // Convert Mbed TLS flags to error string
  18813. static thread_local char error_buf[256];
  18814. if (*flags != 0) {
  18815. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  18816. verify_ctx.error_string = error_buf;
  18817. } else {
  18818. verify_ctx.error_string = nullptr;
  18819. }
  18820. bool accepted = run_verify_callback(callback, verify_ctx);
  18821. if (accepted) {
  18822. // Overrides the built-in verification only on a server, as on OpenSSL and
  18823. // wolfSSL, whose clients check the verify result after the handshake
  18824. if (session->is_server) { *flags = 0; }
  18825. return 0;
  18826. }
  18827. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  18828. }
  18829. // Sets the authentication mode from whether the peer's certificate is required
  18830. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  18831. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  18832. inline void apply_verify_mode(MbedTlsContext &mctx) {
  18833. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  18834. if (mctx.verify_client) {
  18835. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  18836. } else if (mctx.verify_callback) {
  18837. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  18838. }
  18839. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  18840. }
  18841. } // namespace impl
  18842. inline ctx_t create_client_context() {
  18843. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18844. if (!ctx) { return nullptr; }
  18845. ctx->is_server = false;
  18846. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18847. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18848. if (!detail::ensure_mbedtls_psa_crypto()) {
  18849. delete ctx;
  18850. return nullptr;
  18851. }
  18852. int ret;
  18853. #else
  18854. // Seed the random number generator
  18855. const char *pers = "httplib_client";
  18856. int ret = mbedtls_ctr_drbg_seed(
  18857. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18858. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18859. if (ret != 0) {
  18860. impl::mbedtls_last_error() = ret;
  18861. delete ctx;
  18862. return nullptr;
  18863. }
  18864. #endif
  18865. // Set up SSL config for client
  18866. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  18867. MBEDTLS_SSL_TRANSPORT_STREAM,
  18868. MBEDTLS_SSL_PRESET_DEFAULT);
  18869. if (ret != 0) {
  18870. impl::mbedtls_last_error() = ret;
  18871. delete ctx;
  18872. return nullptr;
  18873. }
  18874. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18875. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18876. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18877. #endif
  18878. // Default: verify peer certificate
  18879. ctx->verify_client = true;
  18880. impl::apply_verify_mode(*ctx);
  18881. // Set minimum TLS version to 1.2
  18882. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18883. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18884. #else
  18885. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18886. MBEDTLS_SSL_MINOR_VERSION_3);
  18887. #endif
  18888. return static_cast<ctx_t>(ctx);
  18889. }
  18890. inline ctx_t create_server_context() {
  18891. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18892. if (!ctx) { return nullptr; }
  18893. ctx->is_server = true;
  18894. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18895. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18896. if (!detail::ensure_mbedtls_psa_crypto()) {
  18897. delete ctx;
  18898. return nullptr;
  18899. }
  18900. int ret;
  18901. #else
  18902. // Seed the random number generator
  18903. const char *pers = "httplib_server";
  18904. int ret = mbedtls_ctr_drbg_seed(
  18905. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18906. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18907. if (ret != 0) {
  18908. impl::mbedtls_last_error() = ret;
  18909. delete ctx;
  18910. return nullptr;
  18911. }
  18912. #endif
  18913. // Set up SSL config for server
  18914. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  18915. MBEDTLS_SSL_TRANSPORT_STREAM,
  18916. MBEDTLS_SSL_PRESET_DEFAULT);
  18917. if (ret != 0) {
  18918. impl::mbedtls_last_error() = ret;
  18919. delete ctx;
  18920. return nullptr;
  18921. }
  18922. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18923. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18924. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18925. #endif
  18926. // Default: don't verify client
  18927. impl::apply_verify_mode(*ctx);
  18928. // Set minimum TLS version to 1.2
  18929. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18930. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18931. #else
  18932. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18933. MBEDTLS_SSL_MINOR_VERSION_3);
  18934. #endif
  18935. // Set SNI callback to capture client's SNI hostname
  18936. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  18937. return static_cast<ctx_t>(ctx);
  18938. }
  18939. inline void free_context(ctx_t ctx) {
  18940. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  18941. }
  18942. inline bool set_min_version(ctx_t ctx, Version version) {
  18943. if (!ctx) { return false; }
  18944. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18945. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18946. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  18947. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  18948. if (version >= Version::TLS1_3) {
  18949. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18950. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  18951. #endif
  18952. }
  18953. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  18954. #else
  18955. // Mbed TLS 2.x uses major/minor version numbers
  18956. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  18957. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  18958. if (version >= Version::TLS1_3) {
  18959. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18960. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  18961. #else
  18962. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  18963. #endif
  18964. }
  18965. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  18966. #endif
  18967. return true;
  18968. }
  18969. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18970. if (!ctx || !pem) { return false; }
  18971. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18972. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  18973. // Add null terminator if not present
  18974. std::string pem_str(pem, len);
  18975. int ret = mbedtls_x509_crt_parse(
  18976. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18977. pem_str.size() + 1);
  18978. if (ret != 0) {
  18979. impl::mbedtls_last_error() = ret;
  18980. return false;
  18981. }
  18982. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18983. return true;
  18984. }
  18985. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18986. if (!ctx || !file_path) { return false; }
  18987. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18988. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  18989. if (ret != 0) {
  18990. impl::mbedtls_last_error() = ret;
  18991. return false;
  18992. }
  18993. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18994. return true;
  18995. }
  18996. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18997. if (!ctx || !dir_path) { return false; }
  18998. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18999. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  19000. if (ret < 0) { // Returns number of certs on success, negative on error
  19001. impl::mbedtls_last_error() = ret;
  19002. return false;
  19003. }
  19004. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  19005. return true;
  19006. }
  19007. inline bool load_system_certs(ctx_t ctx) {
  19008. if (!ctx) { return false; }
  19009. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19010. bool loaded = false;
  19011. #ifdef _WIN32
  19012. loaded = impl::enumerate_windows_system_certs(
  19013. [&](const unsigned char *data, size_t len) {
  19014. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  19015. });
  19016. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19017. loaded = impl::enumerate_macos_keychain_certs(
  19018. [&](const unsigned char *data, size_t len) {
  19019. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  19020. });
  19021. #else
  19022. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19023. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  19024. loaded = true;
  19025. break;
  19026. }
  19027. }
  19028. if (!loaded) {
  19029. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19030. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  19031. loaded = true;
  19032. break;
  19033. }
  19034. }
  19035. }
  19036. #endif
  19037. if (loaded) {
  19038. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  19039. }
  19040. return loaded;
  19041. }
  19042. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19043. const char *password) {
  19044. if (!ctx || !cert || !key) { return false; }
  19045. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19046. // Parse certificate
  19047. std::string cert_str(cert);
  19048. int ret = mbedtls_x509_crt_parse(
  19049. &mctx->own_cert,
  19050. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  19051. cert_str.size() + 1);
  19052. if (ret != 0) {
  19053. impl::mbedtls_last_error() = ret;
  19054. return false;
  19055. }
  19056. // Parse private key
  19057. std::string key_str(key);
  19058. const unsigned char *pwd =
  19059. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  19060. size_t pwd_len = password ? strlen(password) : 0;
  19061. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  19062. ret = mbedtls_pk_parse_key(
  19063. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  19064. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  19065. &mctx->ctr_drbg);
  19066. #else
  19067. ret = mbedtls_pk_parse_key(
  19068. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  19069. key_str.size() + 1, pwd, pwd_len);
  19070. #endif
  19071. if (ret != 0) {
  19072. impl::mbedtls_last_error() = ret;
  19073. return false;
  19074. }
  19075. // Verify that the certificate and private key match.
  19076. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  19077. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  19078. #ifndef CPPHTTPLIB_MBEDTLS_V4
  19079. #ifdef CPPHTTPLIB_MBEDTLS_V3
  19080. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  19081. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  19082. #else
  19083. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  19084. #endif
  19085. if (ret != 0) {
  19086. impl::mbedtls_last_error() = ret;
  19087. return false;
  19088. }
  19089. #endif
  19090. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  19091. if (ret != 0) {
  19092. impl::mbedtls_last_error() = ret;
  19093. return false;
  19094. }
  19095. return true;
  19096. }
  19097. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19098. const char *key_path, const char *password) {
  19099. if (!ctx || !cert_path || !key_path) { return false; }
  19100. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19101. // Parse certificate file
  19102. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  19103. if (ret != 0) {
  19104. impl::mbedtls_last_error() = ret;
  19105. return false;
  19106. }
  19107. // Parse private key file
  19108. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  19109. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  19110. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  19111. #else
  19112. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  19113. #endif
  19114. if (ret != 0) {
  19115. impl::mbedtls_last_error() = ret;
  19116. return false;
  19117. }
  19118. // Verify that the certificate and private key match.
  19119. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  19120. #ifndef CPPHTTPLIB_MBEDTLS_V4
  19121. #ifdef CPPHTTPLIB_MBEDTLS_V3
  19122. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  19123. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  19124. #else
  19125. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  19126. #endif
  19127. if (ret != 0) {
  19128. impl::mbedtls_last_error() = ret;
  19129. return false;
  19130. }
  19131. #endif
  19132. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  19133. if (ret != 0) {
  19134. impl::mbedtls_last_error() = ret;
  19135. return false;
  19136. }
  19137. return true;
  19138. }
  19139. inline void set_verify_client(ctx_t ctx, bool require) {
  19140. if (!ctx) { return; }
  19141. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19142. mctx->verify_client = require;
  19143. impl::apply_verify_mode(*mctx);
  19144. }
  19145. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19146. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19147. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19148. auto session = new (std::nothrow) impl::MbedTlsSession();
  19149. if (!session) { return nullptr; }
  19150. session->sock = sock;
  19151. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  19152. if (ret != 0) {
  19153. impl::mbedtls_last_error() = ret;
  19154. delete session;
  19155. return nullptr;
  19156. }
  19157. // Explicitly opt out of in-handshake hostname verification by default;
  19158. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  19159. // fails outright when no hostname was set. set_sni() installs the real
  19160. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  19161. // caller verifies the certificate identity post-handshake via
  19162. // verify_hostname().
  19163. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  19164. // Set BIO callbacks
  19165. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  19166. impl::mbedtls_net_recv_cb, nullptr);
  19167. // Installed always, as it also masks the hostname mismatch that set_sni()
  19168. // may ask for. The session runs its own copy of the user's callback, which
  19169. // set_verify_callback() cannot replace under a handshake.
  19170. session->verify_callback = mctx->verify_callback;
  19171. session->is_server = mctx->is_server;
  19172. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  19173. return static_cast<session_t>(session);
  19174. }
  19175. inline void free_session(session_t session) {
  19176. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  19177. }
  19178. inline bool set_sni(session_t session, const char *hostname,
  19179. bool verify_hostname) {
  19180. if (!session || !hostname) { return false; }
  19181. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19182. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  19183. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  19184. // independently, so a disabled hostname check is handled below by masking
  19185. // the resulting mismatch flag instead of skipping this call.
  19186. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  19187. if (ret != 0) {
  19188. impl::mbedtls_last_error() = ret;
  19189. return false;
  19190. }
  19191. msession->hostname = hostname;
  19192. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  19193. return true;
  19194. }
  19195. inline TlsError connect(session_t session) {
  19196. TlsError err;
  19197. if (!session) {
  19198. err.code = ErrorCode::Fatal;
  19199. return err;
  19200. }
  19201. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19202. int ret;
  19203. do {
  19204. ret = mbedtls_ssl_handshake(&msession->ssl);
  19205. } while (impl::mbedtls_is_session_ticket(ret));
  19206. if (ret == 0) {
  19207. err.code = ErrorCode::Success;
  19208. } else {
  19209. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  19210. impl::mbedtls_last_error() = ret;
  19211. }
  19212. return err;
  19213. }
  19214. inline TlsError accept(session_t session) {
  19215. // A failed handshake leaves its SNI behind, so start without it
  19216. impl::mbedpending_sni().clear();
  19217. // Same as connect for Mbed TLS - handshake works for both client and server
  19218. auto result = connect(session);
  19219. // After successful handshake, capture SNI from thread-local storage
  19220. if (result.code == ErrorCode::Success && session) {
  19221. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19222. msession->sni_hostname = std::move(impl::mbedpending_sni());
  19223. }
  19224. return result;
  19225. }
  19226. inline bool connect_nonblocking(session_t session, socket_t sock,
  19227. time_t timeout_sec, time_t timeout_usec,
  19228. TlsError *err,
  19229. const std::function<bool()> &interrupted) {
  19230. if (!session) {
  19231. if (err) { err->code = ErrorCode::Fatal; }
  19232. return false;
  19233. }
  19234. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19235. // Set socket to non-blocking mode
  19236. detail::set_nonblocking(sock, true);
  19237. auto cleanup =
  19238. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19239. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19240. int ret;
  19241. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  19242. // Non-fatal TLS 1.3 ticket; retry immediately.
  19243. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  19244. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  19245. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  19246. continue;
  19247. }
  19248. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  19249. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  19250. continue;
  19251. }
  19252. }
  19253. // TlsError or timeout
  19254. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  19255. impl::mbedtls_last_error() = ret;
  19256. return false;
  19257. }
  19258. if (err) { err->code = ErrorCode::Success; }
  19259. return true;
  19260. }
  19261. inline bool accept_nonblocking(session_t session, socket_t sock,
  19262. time_t timeout_sec, time_t timeout_usec,
  19263. TlsError *err) {
  19264. // A failed handshake leaves its SNI behind, so start without it
  19265. impl::mbedpending_sni().clear();
  19266. // Same implementation as connect for Mbed TLS
  19267. bool result =
  19268. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  19269. // After successful handshake, capture SNI from thread-local storage
  19270. if (result && session) {
  19271. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19272. msession->sni_hostname = std::move(impl::mbedpending_sni());
  19273. }
  19274. return result;
  19275. }
  19276. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19277. if (!session || !buf) {
  19278. err.code = ErrorCode::Fatal;
  19279. return -1;
  19280. }
  19281. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19282. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  19283. if (msession->has_peeked_byte) {
  19284. if (len == 0) { return 0; }
  19285. auto p = static_cast<unsigned char *>(buf);
  19286. p[0] = msession->peeked_byte;
  19287. msession->has_peeked_byte = false;
  19288. size_t n = 1;
  19289. // Top up with any already-decrypted bytes without risking a block.
  19290. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  19291. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  19292. if (extra > 0) { n += static_cast<size_t>(extra); }
  19293. }
  19294. err.code = ErrorCode::Success;
  19295. return static_cast<ssize_t>(n);
  19296. }
  19297. int ret;
  19298. do {
  19299. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  19300. len);
  19301. } while (impl::mbedtls_is_session_ticket(ret));
  19302. if (ret > 0) {
  19303. err.code = ErrorCode::Success;
  19304. return static_cast<ssize_t>(ret);
  19305. }
  19306. // 0 means EOF without close_notify, which is an error as on OpenSSL
  19307. if (ret == 0) { ret = MBEDTLS_ERR_SSL_CONN_EOF; }
  19308. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  19309. err.backend_code = static_cast<uint64_t>(-ret);
  19310. impl::mbedtls_last_error() = ret;
  19311. // mbedTLS signals a clean close_notify via a negative error code rather
  19312. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  19313. if (err.code == ErrorCode::PeerClosed) { return 0; }
  19314. return -1;
  19315. }
  19316. inline ssize_t write(session_t session, const void *buf, size_t len,
  19317. TlsError &err) {
  19318. if (!session || !buf) {
  19319. err.code = ErrorCode::Fatal;
  19320. return -1;
  19321. }
  19322. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19323. int ret;
  19324. do {
  19325. ret = mbedtls_ssl_write(&msession->ssl,
  19326. static_cast<const unsigned char *>(buf), len);
  19327. } while (impl::mbedtls_is_session_ticket(ret));
  19328. if (ret > 0) {
  19329. err.code = ErrorCode::Success;
  19330. return static_cast<ssize_t>(ret);
  19331. }
  19332. if (ret == 0) {
  19333. err.code = ErrorCode::PeerClosed;
  19334. return 0;
  19335. }
  19336. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  19337. err.backend_code = static_cast<uint64_t>(-ret);
  19338. impl::mbedtls_last_error() = ret;
  19339. return -1;
  19340. }
  19341. inline int pending(const_session_t session) {
  19342. if (!session) { return 0; }
  19343. auto msession =
  19344. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19345. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  19346. (msession->has_peeked_byte ? 1 : 0);
  19347. }
  19348. inline void shutdown(session_t session, bool graceful) {
  19349. if (!session) { return; }
  19350. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19351. if (graceful) {
  19352. // Try to send close_notify, but don't block forever
  19353. int ret;
  19354. int attempts = 0;
  19355. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  19356. attempts < 3) {
  19357. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  19358. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  19359. break;
  19360. }
  19361. attempts++;
  19362. }
  19363. }
  19364. }
  19365. inline bool is_peer_closed(session_t session, socket_t sock) {
  19366. if (!session || sock == INVALID_SOCKET) { return true; }
  19367. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19368. // Check if there's already decrypted or pushed-back data available.
  19369. // If so, the connection is definitely alive.
  19370. if (msession->has_peeked_byte ||
  19371. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  19372. return false;
  19373. }
  19374. // Set socket to non-blocking to avoid blocking on read
  19375. detail::set_nonblocking(sock, true);
  19376. auto cleanup =
  19377. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19378. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  19379. // on application data — e.g. a response that already arrived — push the
  19380. // byte back so the next read() delivers it instead of losing it.
  19381. unsigned char buf;
  19382. int ret;
  19383. do {
  19384. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  19385. } while (impl::mbedtls_is_session_ticket(ret));
  19386. // If we got data or WANT_READ (would block), connection is alive
  19387. if (ret > 0) {
  19388. msession->peeked_byte = buf;
  19389. msession->has_peeked_byte = true;
  19390. return false;
  19391. }
  19392. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  19393. // If we get a peer close notify or a connection reset, the peer is closed
  19394. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  19395. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  19396. }
  19397. inline cert_t get_peer_cert(const_session_t session) {
  19398. if (!session) { return nullptr; }
  19399. auto msession =
  19400. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19401. // Mbed TLS returns a pointer to the internal peer cert chain.
  19402. // WARNING: This pointer is only valid while the session is active.
  19403. // Do not use the certificate after calling free_session().
  19404. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  19405. return const_cast<mbedtls_x509_crt *>(cert);
  19406. }
  19407. inline size_t get_peer_certs(const_session_t session,
  19408. std::vector<cert_t> &certs) {
  19409. certs.clear();
  19410. // Mbed TLS parses the whole received chain into a list headed by the peer
  19411. // certificate, owned by the session like get_peer_cert()'s result
  19412. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  19413. crt && crt->raw.len > 0; crt = crt->next) {
  19414. certs.push_back(static_cast<cert_t>(crt));
  19415. }
  19416. return certs.size();
  19417. }
  19418. inline void free_cert(cert_t cert) {
  19419. // Mbed TLS: every cert_t handed out points into a session's or a context's
  19420. // chain, so there is nothing to free. Callers still call this for the other
  19421. // backends.
  19422. (void)cert;
  19423. }
  19424. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19425. if (!cert || !hostname) { return false; }
  19426. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  19427. std::string host_str(hostname);
  19428. // Check if hostname is an IP address (IPv4 or IPv6)
  19429. unsigned char ip_bytes[16];
  19430. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19431. auto is_ip = ip_len > 0;
  19432. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  19433. // in buf.tag and the raw value in buf.p / buf.len.
  19434. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  19435. if (!san->buf.p || san->buf.len == 0) { continue; }
  19436. const unsigned char *p = san->buf.p;
  19437. size_t len = san->buf.len;
  19438. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  19439. if (is_ip) {
  19440. // For an IP host, only a matching iPAddress SAN of the same family
  19441. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  19442. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  19443. memcmp(p, ip_bytes, ip_len) == 0) {
  19444. return true;
  19445. }
  19446. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  19447. std::string san_name(reinterpret_cast<const char *>(p), len);
  19448. if (detail::match_hostname(san_name, host_str)) { return true; }
  19449. }
  19450. }
  19451. return false;
  19452. }
  19453. inline uint64_t hostname_mismatch_code() {
  19454. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  19455. }
  19456. inline long get_verify_result(const_session_t session) {
  19457. if (!session) { return -1; }
  19458. auto msession =
  19459. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19460. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  19461. // Return 0 (X509_V_OK equivalent) if verification passed
  19462. return flags == 0 ? 0 : static_cast<long>(flags);
  19463. }
  19464. inline std::string get_cert_subject_cn(cert_t cert) {
  19465. if (!cert) return "";
  19466. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19467. // Find the CN in the subject
  19468. const mbedtls_x509_name *name = &x509->subject;
  19469. while (name != nullptr) {
  19470. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  19471. return std::string(reinterpret_cast<const char *>(name->val.p),
  19472. name->val.len);
  19473. }
  19474. name = name->next;
  19475. }
  19476. return "";
  19477. }
  19478. inline std::string get_cert_issuer_name(cert_t cert) {
  19479. if (!cert) return "";
  19480. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19481. // Build a human-readable issuer name string
  19482. char buf[512];
  19483. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  19484. if (ret < 0) return "";
  19485. return std::string(buf);
  19486. }
  19487. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19488. sans.clear();
  19489. if (!cert) return false;
  19490. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19491. // Parse the Subject Alternative Name extension
  19492. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  19493. while (cur != nullptr) {
  19494. if (cur->buf.len > 0) {
  19495. const unsigned char *p = cur->buf.p;
  19496. size_t value_len = cur->buf.len;
  19497. SanEntry entry;
  19498. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  19499. case MBEDTLS_X509_SAN_DNS_NAME:
  19500. entry.type = SanType::DNS;
  19501. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19502. break;
  19503. case MBEDTLS_X509_SAN_IP_ADDRESS:
  19504. entry.type = SanType::IP;
  19505. if (value_len == 4) {
  19506. // IPv4
  19507. char buf[16];
  19508. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  19509. entry.value = buf;
  19510. } else if (value_len == 16) {
  19511. // IPv6
  19512. char buf[64];
  19513. snprintf(buf, sizeof(buf),
  19514. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19515. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19516. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  19517. p[10], p[11], p[12], p[13], p[14], p[15]);
  19518. entry.value = buf;
  19519. }
  19520. break;
  19521. case MBEDTLS_X509_SAN_RFC822_NAME:
  19522. entry.type = SanType::EMAIL;
  19523. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19524. break;
  19525. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  19526. entry.type = SanType::URI;
  19527. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19528. break;
  19529. default: entry.type = SanType::OTHER; break;
  19530. }
  19531. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19532. }
  19533. cur = cur->next;
  19534. }
  19535. return true;
  19536. }
  19537. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19538. time_t &not_after) {
  19539. if (!cert) return false;
  19540. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19541. // Convert mbedtls_x509_time to time_t
  19542. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  19543. struct tm tm_time = {};
  19544. tm_time.tm_year = t.year - 1900;
  19545. tm_time.tm_mon = t.mon - 1;
  19546. tm_time.tm_mday = t.day;
  19547. tm_time.tm_hour = t.hour;
  19548. tm_time.tm_min = t.min;
  19549. tm_time.tm_sec = t.sec;
  19550. #ifdef _WIN32
  19551. return _mkgmtime(&tm_time);
  19552. #else
  19553. return timegm(&tm_time);
  19554. #endif
  19555. };
  19556. not_before = to_time_t(x509->valid_from);
  19557. not_after = to_time_t(x509->valid_to);
  19558. return true;
  19559. }
  19560. inline std::string get_cert_serial(cert_t cert) {
  19561. if (!cert) return "";
  19562. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19563. // Convert serial number to hex string
  19564. std::string result;
  19565. result.reserve(x509->serial.len * 2);
  19566. for (size_t i = 0; i < x509->serial.len; i++) {
  19567. char hex[3];
  19568. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  19569. result += hex;
  19570. }
  19571. return result;
  19572. }
  19573. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19574. if (!cert) return false;
  19575. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  19576. if (!crt->raw.p || crt->raw.len == 0) return false;
  19577. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  19578. return true;
  19579. }
  19580. inline const char *get_sni(const_session_t session) {
  19581. if (!session) return nullptr;
  19582. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  19583. // For server: return SNI received from client during handshake
  19584. if (!msession->sni_hostname.empty()) {
  19585. return msession->sni_hostname.c_str();
  19586. }
  19587. // For client: return the hostname set via set_sni
  19588. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  19589. return nullptr;
  19590. }
  19591. inline uint64_t peek_error() {
  19592. // Mbed TLS doesn't have an error queue, return the last error
  19593. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  19594. }
  19595. inline uint64_t get_error() {
  19596. // Mbed TLS doesn't have an error queue, return and clear the last error
  19597. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  19598. impl::mbedtls_last_error() = 0;
  19599. return err;
  19600. }
  19601. inline std::string error_string(uint64_t code) {
  19602. char buf[256];
  19603. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  19604. return std::string(buf);
  19605. }
  19606. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19607. #ifdef CPPHTTPLIB_MBEDTLS_V4
  19608. // Parsing certificates needs PSA Crypto, and no context may exist yet
  19609. if (!detail::ensure_mbedtls_psa_crypto()) { return nullptr; }
  19610. #endif
  19611. if (!pem) { return nullptr; }
  19612. // mbedtls_x509_crt_parse expects null-terminated PEM
  19613. std::string pem_str(pem, len);
  19614. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  19615. if (!ca_chain) { return nullptr; }
  19616. mbedtls_x509_crt_init(ca_chain);
  19617. auto ret = mbedtls_x509_crt_parse(
  19618. ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  19619. pem_str.size() + 1);
  19620. if (ret != 0) {
  19621. mbedtls_x509_crt_free(ca_chain);
  19622. delete ca_chain;
  19623. return nullptr;
  19624. }
  19625. return static_cast<ca_store_t>(ca_chain);
  19626. }
  19627. inline void free_ca_store(ca_store_t store) {
  19628. if (store) {
  19629. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19630. mbedtls_x509_crt_free(ca_chain);
  19631. delete ca_chain;
  19632. }
  19633. }
  19634. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19635. if (!ctx || !store) { return false; }
  19636. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19637. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19638. // Free existing CA chain
  19639. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  19640. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  19641. // Copy the CA chain (deep copy)
  19642. // Parse from the raw data of the source cert
  19643. mbedtls_x509_crt *src = ca_chain;
  19644. while (src != nullptr) {
  19645. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  19646. src->raw.len);
  19647. if (ret != 0) {
  19648. free_ca_store(store);
  19649. return false;
  19650. }
  19651. src = src->next;
  19652. }
  19653. // This function takes ownership of the store; the chain was deep-copied
  19654. // above, so release the source
  19655. free_ca_store(store);
  19656. // Update the SSL config to use the new CA chain
  19657. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19658. return true;
  19659. }
  19660. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19661. certs.clear();
  19662. if (!ctx) { return 0; }
  19663. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19664. // Owned by the context; see free_cert()
  19665. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  19666. cert = cert->next) {
  19667. certs.push_back(static_cast<cert_t>(cert));
  19668. }
  19669. return certs.size();
  19670. }
  19671. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19672. std::vector<std::string> names;
  19673. if (!ctx) { return names; }
  19674. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19675. // Iterate through the CA chain
  19676. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  19677. while (cert != nullptr && cert->raw.len > 0) {
  19678. char buf[512];
  19679. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  19680. if (ret > 0) { names.push_back(buf); }
  19681. cert = cert->next;
  19682. }
  19683. return names;
  19684. }
  19685. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19686. const char *key_pem, const char *password) {
  19687. if (!ctx || !cert_pem || !key_pem) { return false; }
  19688. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19689. // Parse into new objects first, so that a bad pair leaves the old one in
  19690. // place, and swap them in after; the old ones are freed on the way out.
  19691. mbedtls_x509_crt cert;
  19692. mbedtls_pk_context key;
  19693. mbedtls_x509_crt_init(&cert);
  19694. mbedtls_pk_init(&key);
  19695. auto se = detail::scope_exit([&] {
  19696. mbedtls_x509_crt_free(&cert);
  19697. mbedtls_pk_free(&key);
  19698. });
  19699. // Parse certificate PEM
  19700. int ret = mbedtls_x509_crt_parse(
  19701. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  19702. strlen(cert_pem) + 1);
  19703. if (ret != 0) {
  19704. impl::mbedtls_last_error() = ret;
  19705. return false;
  19706. }
  19707. // Parse private key PEM
  19708. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  19709. ret = mbedtls_pk_parse_key(
  19710. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19711. strlen(key_pem) + 1,
  19712. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19713. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  19714. &mbed_ctx->ctr_drbg);
  19715. #else
  19716. ret = mbedtls_pk_parse_key(
  19717. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19718. strlen(key_pem) + 1,
  19719. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19720. password ? strlen(password) : 0);
  19721. #endif
  19722. if (ret != 0) {
  19723. impl::mbedtls_last_error() = ret;
  19724. return false;
  19725. }
  19726. std::swap(mbed_ctx->own_cert, cert);
  19727. std::swap(mbed_ctx->own_key, key);
  19728. // Configure SSL to use the new certificate and key
  19729. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  19730. &mbed_ctx->own_key);
  19731. if (ret != 0) {
  19732. impl::mbedtls_last_error() = ret;
  19733. return false;
  19734. }
  19735. return true;
  19736. }
  19737. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19738. if (!ctx || !ca_pem) { return false; }
  19739. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19740. // Parse into a new chain first, so that a bad one leaves the old in place
  19741. mbedtls_x509_crt chain;
  19742. mbedtls_x509_crt_init(&chain);
  19743. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  19744. // Parse CA PEM
  19745. int ret = mbedtls_x509_crt_parse(
  19746. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  19747. strlen(ca_pem) + 1);
  19748. if (ret != 0) {
  19749. impl::mbedtls_last_error() = ret;
  19750. return false;
  19751. }
  19752. std::swap(mbed_ctx->ca_chain, chain);
  19753. // Update SSL config to use new CA chain
  19754. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19755. return true;
  19756. }
  19757. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19758. if (!ctx) { return false; }
  19759. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19760. // create_session() hands each session its own copy to run.
  19761. mbed_ctx->verify_callback = std::move(callback);
  19762. impl::apply_verify_mode(*mbed_ctx);
  19763. return true;
  19764. }
  19765. inline long get_verify_error(const_session_t session) {
  19766. if (!session) { return -1; }
  19767. auto *msession =
  19768. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19769. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  19770. }
  19771. inline std::string verify_error_string(long error_code) {
  19772. if (error_code == 0) { return ""; }
  19773. char buf[256];
  19774. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  19775. static_cast<uint32_t>(error_code));
  19776. // Remove trailing newline if present
  19777. std::string result(buf);
  19778. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  19779. result.pop_back();
  19780. }
  19781. return result;
  19782. }
  19783. } // namespace tls
  19784. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  19785. /*
  19786. * Group 10: TLS abstraction layer - wolfSSL backend
  19787. */
  19788. /*
  19789. * wolfSSL Backend Implementation
  19790. */
  19791. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  19792. namespace tls {
  19793. namespace impl {
  19794. // wolfSSL session wrapper
  19795. struct WolfSSLSession {
  19796. WOLFSSL *ssl = nullptr;
  19797. socket_t sock = INVALID_SOCKET;
  19798. std::string hostname; // For client: set via set_sni
  19799. std::string sni_hostname; // For server: received from client via SNI callback
  19800. WolfSSLSession() = default;
  19801. ~WolfSSLSession() {
  19802. if (ssl) { wolfSSL_free(ssl); }
  19803. }
  19804. WolfSSLSession(const WolfSSLSession &) = delete;
  19805. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  19806. };
  19807. // Thread-local error code accessor for wolfSSL
  19808. inline uint64_t &wolfssl_last_error() {
  19809. static thread_local uint64_t err = 0;
  19810. return err;
  19811. }
  19812. // Helper to map wolfSSL error to ErrorCode.
  19813. // ssl_error is the value from wolfSSL_get_error().
  19814. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  19815. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  19816. int &out_errno) {
  19817. switch (ssl_error) {
  19818. case SSL_ERROR_NONE: return ErrorCode::Success;
  19819. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  19820. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  19821. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  19822. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  19823. // EOF without close_notify
  19824. case SOCKET_PEER_CLOSED_E: out_errno = 0; return ErrorCode::SyscallError;
  19825. default:
  19826. if (ssl) {
  19827. // wolfSSL stores the low-level error code as a negative value.
  19828. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  19829. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  19830. if (low_err == DOMAIN_NAME_MISMATCH) {
  19831. return ErrorCode::HostnameMismatch;
  19832. }
  19833. // Check verify result to distinguish cert verification from generic SSL
  19834. // errors.
  19835. long vr = wolfSSL_get_verify_result(ssl);
  19836. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  19837. }
  19838. return ErrorCode::Fatal;
  19839. }
  19840. }
  19841. // WolfSSLContext constructor/destructor implementations
  19842. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  19843. inline WolfSSLContext::~WolfSSLContext() {
  19844. if (ctx) { wolfSSL_CTX_free(ctx); }
  19845. }
  19846. // Thread-local storage for SNI captured during handshake
  19847. inline std::string &wolfssl_pending_sni() {
  19848. static thread_local std::string sni;
  19849. return sni;
  19850. }
  19851. // SNI callback for wolfSSL server to capture client's SNI hostname
  19852. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  19853. (void)ret;
  19854. (void)exArg;
  19855. void *name_data = nullptr;
  19856. unsigned short name_len =
  19857. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  19858. if (name_data && name_len > 0) {
  19859. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  19860. name_len);
  19861. } else {
  19862. wolfssl_pending_sni().clear();
  19863. }
  19864. return 0; // Continue regardless
  19865. }
  19866. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  19867. // runs the verify callback of its own context.
  19868. inline int context_ex_data_index() {
  19869. static const auto index =
  19870. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19871. return index;
  19872. }
  19873. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  19874. // other tls:: function takes.
  19875. inline int session_ex_data_index() {
  19876. static const auto index =
  19877. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19878. return index;
  19879. }
  19880. // A resumed session skips the client's certificate, so a server that checks
  19881. // one would let in a certificate checked against another server's CA, as
  19882. // wolfSSL shares its session cache between contexts, or against a CA since
  19883. // replaced by update_server_client_ca().
  19884. inline void disable_server_resumption(WolfSSLContext *wctx) {
  19885. if (!wctx->is_server) { return; }
  19886. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  19887. #ifdef HAVE_SESSION_TICKET
  19888. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  19889. #endif
  19890. }
  19891. // wolfSSL verify callback wrapper
  19892. inline int wolfssl_verify_callback(int preverify_ok,
  19893. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  19894. // Get the WOLFSSL object from the X509_STORE_CTX
  19895. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  19896. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  19897. if (!ssl) { return preverify_ok; }
  19898. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  19899. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  19900. if (!wctx) { return preverify_ok; }
  19901. std::shared_ptr<VerifyCallback> callback;
  19902. {
  19903. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  19904. callback = wctx->verify_callback;
  19905. }
  19906. if (!callback) { return preverify_ok; }
  19907. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  19908. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  19909. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  19910. VerifyContext verify_ctx;
  19911. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  19912. verify_ctx.cert = static_cast<cert_t>(cert);
  19913. verify_ctx.depth = depth;
  19914. verify_ctx.preverify_ok = (preverify_ok != 0);
  19915. verify_ctx.error_code = static_cast<long>(err);
  19916. if (err != 0) {
  19917. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  19918. } else {
  19919. verify_ctx.error_string = nullptr;
  19920. }
  19921. auto accepted = run_verify_callback(*callback, verify_ctx);
  19922. // A client verifying the server during the handshake, which is what
  19923. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  19924. if (!wolfSSL_is_server(ssl) &&
  19925. (wolfSSL_get_verify_mode(ssl) & WOLFSSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  19926. accepted = accepted && preverify_ok;
  19927. }
  19928. return accepted ? 1 : 0;
  19929. }
  19930. // Sets the verify mode from whether the peer's certificate is required and
  19931. // whether a verify callback is set.
  19932. inline void apply_verify_mode(WolfSSLContext &wctx) {
  19933. auto has_callback = static_cast<bool>(wctx.verify_callback);
  19934. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  19935. auto mode = wctx.verify_client
  19936. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19937. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  19938. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  19939. has_callback ? wolfssl_verify_callback : nullptr);
  19940. }
  19941. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  19942. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  19943. wolfSSL_CTX_set_default_passwd_cb(
  19944. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  19945. auto *pwd = static_cast<const char *>(userdata);
  19946. if (!pwd) return 0;
  19947. auto len = static_cast<int>(strlen(pwd));
  19948. if (len > size) len = size;
  19949. memcpy(buf, pwd, static_cast<size_t>(len));
  19950. return len;
  19951. });
  19952. }
  19953. } // namespace impl
  19954. inline ctx_t create_client_context() {
  19955. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19956. if (!ctx) { return nullptr; }
  19957. ctx->is_server = false;
  19958. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  19959. if (!method) {
  19960. delete ctx;
  19961. return nullptr;
  19962. }
  19963. ctx->ctx = wolfSSL_CTX_new(method);
  19964. if (!ctx->ctx ||
  19965. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19966. WOLFSSL_SUCCESS) {
  19967. delete ctx;
  19968. return nullptr;
  19969. }
  19970. // Default: verify peer certificate
  19971. ctx->verify_client = true;
  19972. impl::apply_verify_mode(*ctx);
  19973. return static_cast<ctx_t>(ctx);
  19974. }
  19975. inline ctx_t create_server_context() {
  19976. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19977. if (!ctx) { return nullptr; }
  19978. ctx->is_server = true;
  19979. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  19980. if (!method) {
  19981. delete ctx;
  19982. return nullptr;
  19983. }
  19984. ctx->ctx = wolfSSL_CTX_new(method);
  19985. if (!ctx->ctx ||
  19986. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19987. WOLFSSL_SUCCESS) {
  19988. delete ctx;
  19989. return nullptr;
  19990. }
  19991. // Default: don't verify client
  19992. impl::apply_verify_mode(*ctx);
  19993. // Enable SNI on server
  19994. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  19995. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  19996. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  19997. return static_cast<ctx_t>(ctx);
  19998. }
  19999. inline void free_context(ctx_t ctx) {
  20000. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  20001. }
  20002. inline bool set_min_version(ctx_t ctx, Version version) {
  20003. if (!ctx) { return false; }
  20004. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20005. int min_ver = WOLFSSL_TLSV1_2;
  20006. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  20007. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  20008. }
  20009. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  20010. if (!ctx || !pem) { return false; }
  20011. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20012. int ret = wolfSSL_CTX_load_verify_buffer(
  20013. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  20014. static_cast<long>(len), SSL_FILETYPE_PEM);
  20015. if (ret != SSL_SUCCESS) {
  20016. impl::wolfssl_last_error() =
  20017. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20018. return false;
  20019. }
  20020. wctx->ca_pem_data_.append(pem, len);
  20021. return true;
  20022. }
  20023. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  20024. if (!ctx || !file_path) { return false; }
  20025. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20026. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  20027. if (ret != SSL_SUCCESS) {
  20028. impl::wolfssl_last_error() =
  20029. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20030. return false;
  20031. }
  20032. return true;
  20033. }
  20034. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  20035. if (!ctx || !dir_path) { return false; }
  20036. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20037. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  20038. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  20039. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  20040. // immediately. Return true even on failure since the CA file may have
  20041. // already been loaded, matching OpenSSL's lenient behavior.
  20042. (void)ret;
  20043. return true;
  20044. }
  20045. inline bool load_system_certs(ctx_t ctx) {
  20046. if (!ctx) { return false; }
  20047. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20048. bool loaded = false;
  20049. #ifdef _WIN32
  20050. loaded = impl::enumerate_windows_system_certs(
  20051. [&](const unsigned char *data, size_t len) {
  20052. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  20053. static_cast<long>(len),
  20054. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  20055. });
  20056. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  20057. loaded = impl::enumerate_macos_keychain_certs(
  20058. [&](const unsigned char *data, size_t len) {
  20059. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  20060. static_cast<long>(len),
  20061. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  20062. });
  20063. #else
  20064. for (auto path = impl::system_ca_paths(); *path; ++path) {
  20065. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  20066. SSL_SUCCESS) {
  20067. loaded = true;
  20068. break;
  20069. }
  20070. }
  20071. if (!loaded) {
  20072. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  20073. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  20074. SSL_SUCCESS) {
  20075. loaded = true;
  20076. break;
  20077. }
  20078. }
  20079. }
  20080. #endif
  20081. return loaded;
  20082. }
  20083. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  20084. const char *password) {
  20085. if (!ctx || !cert || !key) { return false; }
  20086. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20087. // Load certificate
  20088. int ret = wolfSSL_CTX_use_certificate_buffer(
  20089. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  20090. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  20091. if (ret != SSL_SUCCESS) {
  20092. impl::wolfssl_last_error() =
  20093. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20094. return false;
  20095. }
  20096. // Set password callback if password is provided
  20097. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  20098. // Load private key
  20099. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  20100. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  20101. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  20102. if (ret != SSL_SUCCESS) {
  20103. impl::wolfssl_last_error() =
  20104. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20105. return false;
  20106. }
  20107. // Verify that the certificate and private key match
  20108. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  20109. }
  20110. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  20111. const char *key_path, const char *password) {
  20112. if (!ctx || !cert_path || !key_path) { return false; }
  20113. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20114. // Load certificate file
  20115. int ret =
  20116. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  20117. if (ret != SSL_SUCCESS) {
  20118. impl::wolfssl_last_error() =
  20119. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20120. return false;
  20121. }
  20122. // Set password callback if password is provided
  20123. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  20124. // Load private key file
  20125. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  20126. if (ret != SSL_SUCCESS) {
  20127. impl::wolfssl_last_error() =
  20128. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20129. return false;
  20130. }
  20131. // Verify that the certificate and private key match
  20132. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  20133. }
  20134. inline void set_verify_client(ctx_t ctx, bool require) {
  20135. if (!ctx) { return; }
  20136. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20137. wctx->verify_client = require;
  20138. impl::apply_verify_mode(*wctx);
  20139. }
  20140. inline session_t create_session(ctx_t ctx, socket_t sock) {
  20141. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  20142. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20143. auto session = new (std::nothrow) impl::WolfSSLSession();
  20144. if (!session) { return nullptr; }
  20145. session->sock = sock;
  20146. session->ssl = wolfSSL_new(wctx->ctx);
  20147. if (!session->ssl) {
  20148. impl::wolfssl_last_error() =
  20149. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20150. delete session;
  20151. return nullptr;
  20152. }
  20153. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  20154. session) != WOLFSSL_SUCCESS) {
  20155. delete session;
  20156. return nullptr;
  20157. }
  20158. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  20159. return static_cast<session_t>(session);
  20160. }
  20161. inline void free_session(session_t session) {
  20162. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  20163. }
  20164. inline bool set_sni(session_t session, const char *hostname,
  20165. bool verify_hostname) {
  20166. if (!session || !hostname) { return false; }
  20167. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20168. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  20169. static_cast<word16>(strlen(hostname)));
  20170. if (ret != WOLFSSL_SUCCESS) {
  20171. impl::wolfssl_last_error() =
  20172. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20173. return false;
  20174. }
  20175. // wolfSSL_check_domain_name binds identity checking to the handshake,
  20176. // separately from the SNI extension sent above; skip it when hostname
  20177. // verification is disabled so only the chain is checked, matching OpenSSL.
  20178. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  20179. wsession->hostname = hostname;
  20180. return true;
  20181. }
  20182. inline TlsError connect(session_t session) {
  20183. TlsError err;
  20184. if (!session) {
  20185. err.code = ErrorCode::Fatal;
  20186. return err;
  20187. }
  20188. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20189. int ret = wolfSSL_connect(wsession->ssl);
  20190. if (ret == SSL_SUCCESS) {
  20191. err.code = ErrorCode::Success;
  20192. } else {
  20193. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20194. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  20195. err.backend_code = static_cast<uint64_t>(ssl_error);
  20196. impl::wolfssl_last_error() = err.backend_code;
  20197. }
  20198. return err;
  20199. }
  20200. inline TlsError accept(session_t session) {
  20201. TlsError err;
  20202. if (!session) {
  20203. err.code = ErrorCode::Fatal;
  20204. return err;
  20205. }
  20206. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20207. int ret = wolfSSL_accept(wsession->ssl);
  20208. if (ret == SSL_SUCCESS) {
  20209. err.code = ErrorCode::Success;
  20210. // Capture SNI from thread-local storage after successful handshake
  20211. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  20212. impl::wolfssl_pending_sni().clear();
  20213. } else {
  20214. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20215. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  20216. err.backend_code = static_cast<uint64_t>(ssl_error);
  20217. impl::wolfssl_last_error() = err.backend_code;
  20218. }
  20219. return err;
  20220. }
  20221. inline bool connect_nonblocking(session_t session, socket_t sock,
  20222. time_t timeout_sec, time_t timeout_usec,
  20223. TlsError *err,
  20224. const std::function<bool()> &interrupted) {
  20225. if (!session) {
  20226. if (err) { err->code = ErrorCode::Fatal; }
  20227. return false;
  20228. }
  20229. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20230. // Set socket to non-blocking mode
  20231. detail::set_nonblocking(sock, true);
  20232. auto cleanup =
  20233. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  20234. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  20235. int ret;
  20236. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  20237. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20238. if (ssl_error == SSL_ERROR_WANT_READ) {
  20239. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  20240. continue;
  20241. }
  20242. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  20243. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  20244. continue;
  20245. }
  20246. }
  20247. // Error or timeout
  20248. if (err) {
  20249. err->code =
  20250. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  20251. err->backend_code = static_cast<uint64_t>(ssl_error);
  20252. }
  20253. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  20254. return false;
  20255. }
  20256. if (err) { err->code = ErrorCode::Success; }
  20257. return true;
  20258. }
  20259. inline bool accept_nonblocking(session_t session, socket_t sock,
  20260. time_t timeout_sec, time_t timeout_usec,
  20261. TlsError *err) {
  20262. if (!session) {
  20263. if (err) { err->code = ErrorCode::Fatal; }
  20264. return false;
  20265. }
  20266. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20267. // Set socket to non-blocking mode
  20268. detail::set_nonblocking(sock, true);
  20269. auto cleanup =
  20270. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  20271. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  20272. int ret;
  20273. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  20274. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20275. if (ssl_error == SSL_ERROR_WANT_READ) {
  20276. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  20277. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  20278. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  20279. }
  20280. // Error or timeout
  20281. if (err) {
  20282. err->code =
  20283. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  20284. err->backend_code = static_cast<uint64_t>(ssl_error);
  20285. }
  20286. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  20287. return false;
  20288. }
  20289. if (err) { err->code = ErrorCode::Success; }
  20290. // Capture SNI from thread-local storage after successful handshake
  20291. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  20292. impl::wolfssl_pending_sni().clear();
  20293. return true;
  20294. }
  20295. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  20296. if (!session || !buf) {
  20297. err.code = ErrorCode::Fatal;
  20298. return -1;
  20299. }
  20300. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20301. constexpr auto max_len =
  20302. static_cast<size_t>((std::numeric_limits<int>::max)());
  20303. if (len > max_len) { len = max_len; }
  20304. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  20305. if (ret > 0) {
  20306. err.code = ErrorCode::Success;
  20307. return static_cast<ssize_t>(ret);
  20308. }
  20309. // 0 is also returned for EOF without close_notify; get_error tells them apart
  20310. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20311. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  20312. if (err.code == ErrorCode::PeerClosed) { return 0; }
  20313. err.backend_code = static_cast<uint64_t>(ssl_error);
  20314. impl::wolfssl_last_error() = err.backend_code;
  20315. return -1;
  20316. }
  20317. inline ssize_t write(session_t session, const void *buf, size_t len,
  20318. TlsError &err) {
  20319. if (!session || !buf) {
  20320. err.code = ErrorCode::Fatal;
  20321. return -1;
  20322. }
  20323. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20324. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  20325. if (ret > 0) {
  20326. err.code = ErrorCode::Success;
  20327. return static_cast<ssize_t>(ret);
  20328. }
  20329. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  20330. // Treat this as an error (return -1) so callers don't spin in a
  20331. // write loop adding zero to the offset.
  20332. if (ret == 0) {
  20333. err.code = ErrorCode::PeerClosed;
  20334. return -1;
  20335. }
  20336. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20337. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  20338. err.backend_code = static_cast<uint64_t>(ssl_error);
  20339. impl::wolfssl_last_error() = err.backend_code;
  20340. return -1;
  20341. }
  20342. inline int pending(const_session_t session) {
  20343. if (!session) { return 0; }
  20344. auto wsession =
  20345. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20346. return wolfSSL_pending(wsession->ssl);
  20347. }
  20348. inline void shutdown(session_t session, bool graceful) {
  20349. if (!session) { return; }
  20350. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20351. if (graceful) {
  20352. int ret;
  20353. int attempts = 0;
  20354. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  20355. attempts < 3) {
  20356. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20357. if (ssl_error != SSL_ERROR_WANT_READ &&
  20358. ssl_error != SSL_ERROR_WANT_WRITE) {
  20359. break;
  20360. }
  20361. attempts++;
  20362. }
  20363. } else {
  20364. wolfSSL_shutdown(wsession->ssl);
  20365. }
  20366. }
  20367. inline bool is_peer_closed(session_t session, socket_t sock) {
  20368. if (!session || sock == INVALID_SOCKET) { return true; }
  20369. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20370. // Check if there's already decrypted data available
  20371. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  20372. // Set socket to non-blocking to avoid blocking on read
  20373. detail::set_nonblocking(sock, true);
  20374. auto cleanup =
  20375. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  20376. // Peek 1 byte to check connection status without consuming data
  20377. unsigned char buf;
  20378. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  20379. // If we got data or WANT_READ (would block), connection is alive
  20380. if (ret > 0) { return false; }
  20381. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20382. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  20383. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  20384. ret == 0;
  20385. }
  20386. inline cert_t get_peer_cert(const_session_t session) {
  20387. if (!session) { return nullptr; }
  20388. auto wsession =
  20389. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20390. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  20391. return static_cast<cert_t>(cert);
  20392. }
  20393. inline size_t get_peer_certs(const_session_t session,
  20394. std::vector<cert_t> &certs) {
  20395. certs.clear();
  20396. if (!session) { return 0; }
  20397. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  20398. #ifdef SESSION_CERTS
  20399. auto wsession =
  20400. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20401. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  20402. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  20403. for (int i = 0; i < count; i++) {
  20404. auto x509 = wolfSSL_get_chain_X509(chain, i);
  20405. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  20406. }
  20407. #endif
  20408. return certs.size();
  20409. }
  20410. inline void free_cert(cert_t cert) {
  20411. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  20412. }
  20413. inline bool verify_hostname(cert_t cert, const char *hostname) {
  20414. if (!cert || !hostname) { return false; }
  20415. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20416. std::string host_str(hostname);
  20417. // Check if hostname is an IP address (IPv4 or IPv6)
  20418. unsigned char ip_bytes[16];
  20419. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  20420. auto is_ip = ip_len > 0;
  20421. // Check Subject Alternative Names
  20422. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  20423. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  20424. if (san_names) {
  20425. int san_count = wolfSSL_sk_num(san_names);
  20426. for (int i = 0; i < san_count; i++) {
  20427. auto *names =
  20428. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  20429. if (!names) continue;
  20430. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  20431. // DNS name
  20432. unsigned char *dns_name = nullptr;
  20433. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  20434. if (dns_name && dns_len > 0) {
  20435. std::string san_name(reinterpret_cast<char *>(dns_name),
  20436. static_cast<size_t>(dns_len));
  20437. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  20438. if (detail::match_hostname(san_name, host_str)) {
  20439. wolfSSL_sk_free(san_names);
  20440. return true;
  20441. }
  20442. }
  20443. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  20444. // IP address: only an iPAddress SAN of the same family (4 bytes for
  20445. // IPv4, 16 bytes for IPv6) may authenticate the host.
  20446. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  20447. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  20448. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  20449. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  20450. wolfSSL_sk_free(san_names);
  20451. return true;
  20452. }
  20453. }
  20454. }
  20455. wolfSSL_sk_free(san_names);
  20456. }
  20457. return false;
  20458. }
  20459. inline uint64_t hostname_mismatch_code() {
  20460. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  20461. }
  20462. inline long get_verify_result(const_session_t session) {
  20463. if (!session) { return -1; }
  20464. auto wsession =
  20465. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20466. long result = wolfSSL_get_verify_result(wsession->ssl);
  20467. return result;
  20468. }
  20469. inline std::string get_cert_subject_cn(cert_t cert) {
  20470. if (!cert) return "";
  20471. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20472. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  20473. if (!subject) return "";
  20474. char cn[256] = {};
  20475. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  20476. sizeof(cn));
  20477. if (cn_len <= 0) return "";
  20478. return std::string(cn, static_cast<size_t>(cn_len));
  20479. }
  20480. inline std::string get_cert_issuer_name(cert_t cert) {
  20481. if (!cert) return "";
  20482. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20483. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  20484. if (!issuer) return "";
  20485. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  20486. if (!name_str) return "";
  20487. std::string result(name_str);
  20488. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  20489. return result;
  20490. }
  20491. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  20492. sans.clear();
  20493. if (!cert) return false;
  20494. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20495. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  20496. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  20497. if (!san_names) return true; // No SANs is not an error
  20498. int count = wolfSSL_sk_num(san_names);
  20499. for (int i = 0; i < count; i++) {
  20500. auto *name =
  20501. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  20502. if (!name) continue;
  20503. SanEntry entry;
  20504. switch (name->type) {
  20505. case WOLFSSL_GEN_DNS: {
  20506. entry.type = SanType::DNS;
  20507. unsigned char *dns_name = nullptr;
  20508. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  20509. if (dns_name && dns_len > 0) {
  20510. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  20511. static_cast<size_t>(dns_len));
  20512. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  20513. }
  20514. break;
  20515. }
  20516. case WOLFSSL_GEN_IPADD: {
  20517. entry.type = SanType::IP;
  20518. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  20519. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  20520. if (ip_data && ip_len == 4) {
  20521. char buf[16];
  20522. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  20523. ip_data[2], ip_data[3]);
  20524. entry.value = buf;
  20525. } else if (ip_data && ip_len == 16) {
  20526. char buf[64];
  20527. snprintf(buf, sizeof(buf),
  20528. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  20529. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  20530. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  20531. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  20532. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  20533. ip_data[14], ip_data[15]);
  20534. entry.value = buf;
  20535. }
  20536. break;
  20537. }
  20538. case WOLFSSL_GEN_EMAIL:
  20539. entry.type = SanType::EMAIL;
  20540. {
  20541. unsigned char *email = nullptr;
  20542. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  20543. if (email && email_len > 0) {
  20544. entry.value = std::string(reinterpret_cast<char *>(email),
  20545. static_cast<size_t>(email_len));
  20546. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  20547. }
  20548. }
  20549. break;
  20550. case WOLFSSL_GEN_URI:
  20551. entry.type = SanType::URI;
  20552. {
  20553. unsigned char *uri = nullptr;
  20554. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  20555. &uri, name->d.uniformResourceIdentifier);
  20556. if (uri && uri_len > 0) {
  20557. entry.value = std::string(reinterpret_cast<char *>(uri),
  20558. static_cast<size_t>(uri_len));
  20559. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  20560. }
  20561. }
  20562. break;
  20563. default: entry.type = SanType::OTHER; break;
  20564. }
  20565. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  20566. }
  20567. wolfSSL_sk_free(san_names);
  20568. return true;
  20569. }
  20570. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  20571. time_t &not_after) {
  20572. if (!cert) return false;
  20573. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20574. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  20575. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  20576. if (!nb || !na) return false;
  20577. // wolfSSL_ASN1_TIME_to_tm is available
  20578. struct tm tm_nb = {}, tm_na = {};
  20579. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  20580. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  20581. #ifdef _WIN32
  20582. not_before = _mkgmtime(&tm_nb);
  20583. not_after = _mkgmtime(&tm_na);
  20584. #else
  20585. not_before = timegm(&tm_nb);
  20586. not_after = timegm(&tm_na);
  20587. #endif
  20588. return true;
  20589. }
  20590. inline std::string get_cert_serial(cert_t cert) {
  20591. if (!cert) return "";
  20592. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20593. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  20594. if (!serial_asn1) return "";
  20595. // Get the serial number data
  20596. int len = serial_asn1->length;
  20597. unsigned char *data = serial_asn1->data;
  20598. if (!data || len <= 0) return "";
  20599. std::string result;
  20600. result.reserve(static_cast<size_t>(len) * 2);
  20601. for (int i = 0; i < len; i++) {
  20602. char hex[3];
  20603. snprintf(hex, sizeof(hex), "%02X", data[i]);
  20604. result += hex;
  20605. }
  20606. return result;
  20607. }
  20608. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  20609. if (!cert) return false;
  20610. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20611. int der_len = 0;
  20612. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  20613. if (!der_data || der_len <= 0) return false;
  20614. der.assign(der_data, der_data + der_len);
  20615. return true;
  20616. }
  20617. inline const char *get_sni(const_session_t session) {
  20618. if (!session) return nullptr;
  20619. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  20620. // For server: return SNI received from client during handshake
  20621. if (!wsession->sni_hostname.empty()) {
  20622. return wsession->sni_hostname.c_str();
  20623. }
  20624. // For client: return the hostname set via set_sni
  20625. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  20626. return nullptr;
  20627. }
  20628. inline uint64_t peek_error() {
  20629. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20630. }
  20631. inline uint64_t get_error() {
  20632. uint64_t err = impl::wolfssl_last_error();
  20633. impl::wolfssl_last_error() = 0;
  20634. return err;
  20635. }
  20636. inline std::string error_string(uint64_t code) {
  20637. char buf[256];
  20638. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  20639. return std::string(buf);
  20640. }
  20641. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  20642. if (!pem || len == 0) { return nullptr; }
  20643. // Validate by attempting to load into a temporary ctx
  20644. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  20645. if (!tmp_ctx) { return nullptr; }
  20646. int ret = wolfSSL_CTX_load_verify_buffer(
  20647. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  20648. static_cast<long>(len), SSL_FILETYPE_PEM);
  20649. wolfSSL_CTX_free(tmp_ctx);
  20650. if (ret != SSL_SUCCESS) { return nullptr; }
  20651. return static_cast<ca_store_t>(
  20652. new impl::WolfSSLCAStore{std::string(pem, len)});
  20653. }
  20654. inline void free_ca_store(ca_store_t store) {
  20655. delete static_cast<impl::WolfSSLCAStore *>(store);
  20656. }
  20657. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  20658. if (!ctx || !store) { return false; }
  20659. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20660. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  20661. int ret = wolfSSL_CTX_load_verify_buffer(
  20662. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  20663. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  20664. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  20665. // This function takes ownership of the store; the PEM data was copied into
  20666. // the context, so release the source
  20667. free_ca_store(store);
  20668. return ret == SSL_SUCCESS;
  20669. }
  20670. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  20671. certs.clear();
  20672. if (!ctx) { return 0; }
  20673. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20674. if (wctx->ca_pem_data_.empty()) { return 0; }
  20675. const std::string &pem = wctx->ca_pem_data_;
  20676. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20677. const std::string end_marker = "-----END CERTIFICATE-----";
  20678. size_t pos = 0;
  20679. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20680. size_t end_pos = pem.find(end_marker, pos);
  20681. if (end_pos == std::string::npos) { break; }
  20682. end_pos += end_marker.size();
  20683. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20684. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20685. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20686. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20687. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  20688. pos = end_pos;
  20689. }
  20690. return certs.size();
  20691. }
  20692. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  20693. std::vector<std::string> names;
  20694. if (!ctx) { return names; }
  20695. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20696. if (wctx->ca_pem_data_.empty()) { return names; }
  20697. const std::string &pem = wctx->ca_pem_data_;
  20698. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20699. const std::string end_marker = "-----END CERTIFICATE-----";
  20700. size_t pos = 0;
  20701. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20702. size_t end_pos = pem.find(end_marker, pos);
  20703. if (end_pos == std::string::npos) { break; }
  20704. end_pos += end_marker.size();
  20705. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20706. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20707. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20708. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20709. if (x509) {
  20710. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  20711. if (subject) {
  20712. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  20713. if (name_str) {
  20714. names.push_back(name_str);
  20715. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  20716. }
  20717. }
  20718. wolfSSL_X509_free(x509);
  20719. }
  20720. pos = end_pos;
  20721. }
  20722. return names;
  20723. }
  20724. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  20725. const char *key_pem, const char *password) {
  20726. if (!ctx || !cert_pem || !key_pem) { return false; }
  20727. // Try the pair on a scratch context first, so that a bad one leaves the
  20728. // server's certificate and key as they were
  20729. auto tmp = create_server_context();
  20730. if (!tmp) { return false; }
  20731. auto se = detail::scope_exit([&] { free_context(tmp); });
  20732. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  20733. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  20734. }
  20735. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  20736. if (!ctx || !ca_pem) { return false; }
  20737. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20738. // Replace the CAs rather than add to them, as the other backends do, once
  20739. // the new ones are known to load
  20740. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  20741. if (!store) { return false; }
  20742. free_ca_store(store);
  20743. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  20744. wctx->ca_pem_data_.clear();
  20745. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  20746. }
  20747. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  20748. if (!ctx) { return false; }
  20749. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20750. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  20751. : nullptr;
  20752. {
  20753. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  20754. // A handshake running the previous callback keeps it until it returns.
  20755. wctx->verify_callback.swap(stored);
  20756. }
  20757. impl::apply_verify_mode(*wctx);
  20758. return true;
  20759. }
  20760. inline long get_verify_error(const_session_t session) {
  20761. if (!session) { return -1; }
  20762. auto *wsession =
  20763. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20764. return wolfSSL_get_verify_result(wsession->ssl);
  20765. }
  20766. inline std::string verify_error_string(long error_code) {
  20767. if (error_code == 0) { return ""; }
  20768. const char *str =
  20769. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  20770. return str ? std::string(str) : std::string();
  20771. }
  20772. } // namespace tls
  20773. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  20774. // WebSocket implementation
  20775. namespace ws {
  20776. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  20777. bool fin) {
  20778. std::lock_guard<std::mutex> lock(write_mutex_);
  20779. if (closed_) { return false; }
  20780. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  20781. }
  20782. inline ReadResult WebSocket::read(std::string &msg) {
  20783. // Answers a control frame; any other opcode here is a protocol error.
  20784. // Returns false when the connection is done.
  20785. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  20786. switch (op) {
  20787. case Opcode::Ping: {
  20788. std::lock_guard<std::mutex> lock(write_mutex_);
  20789. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  20790. payload.size(), true, !is_server_);
  20791. return true;
  20792. }
  20793. case Opcode::Pong: {
  20794. std::lock_guard<std::mutex> lock(ping_mutex_);
  20795. unacked_pings_ = 0;
  20796. return true;
  20797. }
  20798. case Opcode::Close: {
  20799. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  20800. // malformed, which is answered with a protocol error instead.
  20801. if (closed_.exchange(true)) { return false; }
  20802. auto reply = payload;
  20803. if (!impl::is_valid_close_payload(payload)) {
  20804. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  20805. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  20806. }
  20807. std::lock_guard<std::mutex> lock(write_mutex_);
  20808. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  20809. reply.size(), true, !is_server_);
  20810. return false;
  20811. }
  20812. default: closed_ = true; return false;
  20813. }
  20814. };
  20815. std::unique_lock<std::mutex> read_lock(read_mutex_);
  20816. // A server going down closes the connection rather than wait on it: its
  20817. // listen() waits for this handler to return.
  20818. auto going_away = [&]() -> ReadResult {
  20819. read_lock.unlock();
  20820. close(CloseStatus::GoingAway, "server stopping");
  20821. return Fail;
  20822. };
  20823. // close() ends the read, even while the peer keeps sending fragments
  20824. while (!closed_) {
  20825. Opcode opcode;
  20826. std::string payload;
  20827. bool fin;
  20828. // While a message is assembled, only what is left of the limit, but room
  20829. // for a control frame, which may come between its fragments.
  20830. auto max_len =
  20831. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0 || message_kind_ == Fail
  20832. ? size_t(CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH)
  20833. : (std::max)(size_t(125), CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  20834. message_.size());
  20835. auto r = frames_.read(strm_, opcode, payload, fin, is_server_, max_len);
  20836. if (r != impl::FrameRead::Ok && server_stopping()) { return going_away(); }
  20837. // A timeout leaves what was read of the frame and of the message for the
  20838. // next read(), so the connection is still usable wherever it landed: hand
  20839. // control back without closing it. That is only useful to a caller who
  20840. // asked for the timeout; the compile-time default is a backstop against a
  20841. // peer gone quiet, and elapsing it closes the connection so a plain
  20842. // `while (ws.read(msg))` loop ends. A wait that a pong timeout cut short
  20843. // finds the connection closed.
  20844. if (r == impl::FrameRead::Timeout && read_timeout_set_ && !closed_) {
  20845. return Timeout;
  20846. }
  20847. if (r != impl::FrameRead::Ok) {
  20848. closed_ = true;
  20849. return Fail;
  20850. }
  20851. auto continues = opcode == Opcode::Continuation;
  20852. if (opcode != Opcode::Text && opcode != Opcode::Binary && !continues) {
  20853. if (handle_control(opcode, payload)) { continue; }
  20854. return Fail;
  20855. }
  20856. // RFC 6455 5.4: a message is a Text or Binary frame and the continuation
  20857. // frames after it, with only control frames between them.
  20858. if (continues == (message_kind_ == Fail)) {
  20859. closed_ = true;
  20860. return Fail;
  20861. }
  20862. if (continues) {
  20863. message_ += payload;
  20864. } else {
  20865. message_ = std::move(payload);
  20866. message_kind_ = opcode == Opcode::Text ? Text : Binary;
  20867. }
  20868. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  20869. message_.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  20870. closed_ = true;
  20871. return Fail;
  20872. }
  20873. if (!fin) { continue; }
  20874. auto result = message_kind_;
  20875. msg = std::move(message_);
  20876. message_.clear();
  20877. message_kind_ = Fail;
  20878. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  20879. if (result == Text && !impl::is_valid_utf8(msg)) {
  20880. // close() takes the read lock to wait for the peer's Close reply, so
  20881. // it must not run while this thread still holds it.
  20882. read_lock.unlock();
  20883. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  20884. return Fail;
  20885. }
  20886. return result;
  20887. }
  20888. return Fail;
  20889. }
  20890. inline bool WebSocket::send(const std::string &data) {
  20891. return send_frame(Opcode::Text, data.data(), data.size());
  20892. }
  20893. inline bool WebSocket::send(const char *data, size_t len) {
  20894. return send_frame(Opcode::Binary, data, len);
  20895. }
  20896. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  20897. if (closed_.exchange(true)) { return; }
  20898. ping_cv_.notify_all();
  20899. std::string payload;
  20900. auto code = static_cast<uint16_t>(status);
  20901. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  20902. payload.push_back(static_cast<char>(code & 0xFF));
  20903. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  20904. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  20905. // cut back to a whole UTF-8 character
  20906. auto short_reason = reason.substr(0, 123);
  20907. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  20908. short_reason.pop_back();
  20909. }
  20910. payload += short_reason;
  20911. // A code that may not be sent, such as NoStatus, goes without a payload
  20912. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  20913. {
  20914. std::lock_guard<std::mutex> lock(write_mutex_);
  20915. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  20916. payload.size(), true, !is_server_);
  20917. }
  20918. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  20919. // Close response before closing the TCP connection.
  20920. //
  20921. // Wait only when no other thread is parsing frames. When one is, it is the
  20922. // thread positioned to see the peer's reply, and reading here would take
  20923. // bytes out of the message it is assembling. Bailing out also leaves the
  20924. // stream, including its read timeout, entirely to that thread.
  20925. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  20926. if (!read_lock.owns_lock()) { return; }
  20927. // A max timeout turns a negative (unbounded) read timeout into 0
  20928. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20929. strm_.set_max_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND * 1000);
  20930. // The max timeout cuts a trickled frame short, the deadline a frame flood
  20931. auto deadline =
  20932. detail::deadline_after(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20933. // From where the last read() left the stream, inside a frame as it may be
  20934. Opcode op;
  20935. std::string resp;
  20936. bool fin;
  20937. while (std::chrono::steady_clock::now() < deadline &&
  20938. frames_.read(strm_, op, resp, fin, is_server_, 125) ==
  20939. impl::FrameRead::Ok) {
  20940. if (op == Opcode::Close) { break; }
  20941. }
  20942. }
  20943. inline WebSocket::~WebSocket() {
  20944. {
  20945. std::lock_guard<std::mutex> lock(ping_mutex_);
  20946. closed_ = true;
  20947. }
  20948. ping_cv_.notify_all();
  20949. if (ping_thread_.joinable()) { ping_thread_.join(); }
  20950. // A server's stream outlives this object
  20951. strm_.set_read_interrupt(nullptr);
  20952. }
  20953. // A pong timeout ends a read() blocked on the silent peer, and so does the
  20954. // server stopping: its listen() waits for every handler to return.
  20955. inline void WebSocket::interrupt_reads() {
  20956. auto watches_pongs = ping_interval_sec_ > 0 && max_missed_pongs_ > 0;
  20957. if (!watches_pongs && !server_stopping_) { return; }
  20958. strm_.set_read_interrupt(
  20959. [this] { return pong_timed_out_.load() || server_stopping(); });
  20960. }
  20961. inline void WebSocket::start_heartbeat() {
  20962. if (ping_interval_sec_ <= 0) { return; }
  20963. ping_thread_ = std::thread([this]() {
  20964. std::unique_lock<std::mutex> lock(ping_mutex_);
  20965. // The predicate keeps a spurious wakeup from sending a ping early
  20966. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  20967. [this]() { return closed_.load(); })) {
  20968. // If the peer has failed to respond to the previous pings, give up.
  20969. // RFC 6455 does not define a pong-timeout mechanism; this is an
  20970. // opt-in liveness check controlled by max_missed_pongs_.
  20971. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  20972. lock.unlock();
  20973. close(CloseStatus::GoingAway, "pong timeout");
  20974. pong_timed_out_ = true;
  20975. return;
  20976. }
  20977. lock.unlock();
  20978. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  20979. lock.lock();
  20980. closed_ = true;
  20981. break;
  20982. }
  20983. lock.lock();
  20984. unacked_pings_++;
  20985. }
  20986. });
  20987. }
  20988. inline const Request &WebSocket::request() const { return req_; }
  20989. inline bool WebSocket::is_open() const { return !closed_; }
  20990. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  20991. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  20992. // poll(), where 0 would instead mean "return immediately", so hand it the
  20993. // negative poll uses for an unbounded wait.
  20994. if (sec == 0 && usec == 0) { sec = -1; }
  20995. strm_.set_read_timeout(sec, usec);
  20996. read_timeout_set_ = true;
  20997. }
  20998. // WebSocketClient implementation
  20999. inline WebSocketClient::WebSocketClient(
  21000. const std::string &scheme_host_port_path, const Headers &headers)
  21001. : headers_(headers) {
  21002. detail::UrlComponents uc;
  21003. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  21004. !uc.host.empty() && !uc.path.empty()) {
  21005. auto &scheme = uc.scheme;
  21006. #ifdef CPPHTTPLIB_SSL_ENABLED
  21007. if (scheme != "ws" && scheme != "wss") {
  21008. #else
  21009. if (scheme != "ws") {
  21010. #endif
  21011. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  21012. std::string msg = "'" + scheme + "' scheme is not supported.";
  21013. throw std::invalid_argument(msg);
  21014. #endif
  21015. return;
  21016. }
  21017. auto is_ssl = scheme == "wss";
  21018. host_ = std::move(uc.host);
  21019. port_ = is_ssl ? 443 : 80;
  21020. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  21021. path_ = std::move(uc.path);
  21022. if (!uc.query.empty()) { path_ += uc.query; }
  21023. #ifdef CPPHTTPLIB_SSL_ENABLED
  21024. is_ssl_ = is_ssl;
  21025. if (is_ssl_) {
  21026. // The context lives as long as the client so that CA configuration
  21027. // survives reconnects; sessions are created per connection.
  21028. tls_ctx_ = tls::create_client_context();
  21029. if (!tls_ctx_) { return; }
  21030. }
  21031. #else
  21032. if (is_ssl) { return; }
  21033. #endif
  21034. is_valid_ = true;
  21035. }
  21036. }
  21037. #ifdef CPPHTTPLIB_SSL_ENABLED
  21038. inline WebSocketClient::WebSocketClient(
  21039. const std::string &scheme_host_port_path, const PemMemory &pem,
  21040. const Headers &headers)
  21041. : WebSocketClient(scheme_host_port_path, headers) {
  21042. // For ws:// URLs the client certificate is silently ignored, consistent
  21043. // with the TLS-only setters such as set_ca_cert_path().
  21044. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  21045. std::string cert_buf, key_buf;
  21046. if (!tls::set_client_cert_pem(
  21047. tls_ctx_,
  21048. detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  21049. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  21050. pem.private_key_password)) {
  21051. tls::free_context(tls_ctx_);
  21052. tls_ctx_ = nullptr;
  21053. is_valid_ = false;
  21054. }
  21055. }
  21056. }
  21057. #endif
  21058. inline WebSocketClient::~WebSocketClient() {
  21059. shutdown_and_close();
  21060. #ifdef CPPHTTPLIB_SSL_ENABLED
  21061. if (tls_ctx_) {
  21062. tls::free_context(tls_ctx_);
  21063. tls_ctx_ = nullptr;
  21064. }
  21065. #endif
  21066. }
  21067. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  21068. inline void WebSocketClient::shutdown_and_close() {
  21069. // Send the close frame while the TLS session is still alive: ws_ holds an
  21070. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  21071. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  21072. if (ws_ && ws_->is_open()) { ws_->close(); }
  21073. ws_.reset();
  21074. #ifdef CPPHTTPLIB_SSL_ENABLED
  21075. if (is_ssl_) {
  21076. if (tls_session_) {
  21077. tls::shutdown(tls_session_, true);
  21078. tls::free_session(tls_session_);
  21079. tls_session_ = nullptr;
  21080. }
  21081. }
  21082. #endif
  21083. if (sock_ != INVALID_SOCKET) {
  21084. detail::shutdown_socket(sock_);
  21085. detail::close_socket(sock_);
  21086. sock_ = INVALID_SOCKET;
  21087. }
  21088. }
  21089. // The handshakes belong to establishing the connection, so an unset read
  21090. // timeout leaves them bounded by the connection timeout instead of forever.
  21091. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  21092. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  21093. return {connection_timeout_sec_, connection_timeout_usec_};
  21094. }
  21095. return {read_timeout_sec_, read_timeout_usec_};
  21096. }
  21097. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  21098. Error &error, int &ssl_error,
  21099. uint64_t &ssl_backend_error) {
  21100. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  21101. // The streams wait with poll(), where 0 instead means "return immediately",
  21102. // so they are given the negative poll uses for an unbounded wait.
  21103. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  21104. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  21105. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  21106. #ifdef CPPHTTPLIB_SSL_ENABLED
  21107. if (is_ssl_) {
  21108. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  21109. // is not safe to call concurrently on one client to begin with, since
  21110. // nothing else here is guarded either.
  21111. if (server_certificate_verification_ && !certs_loaded_) {
  21112. uint64_t backend_error = 0;
  21113. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  21114. ca_cert_dir_path_, custom_ca_loaded_,
  21115. system_ca_mode_, backend_error);
  21116. certs_loaded_ = true;
  21117. }
  21118. detail::ClientTlsSessionOptions options;
  21119. options.server_hostname_verification = server_hostname_verification_;
  21120. options.session_verifier = session_verifier_;
  21121. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  21122. options.windows_cert_verification = detail::use_windows_cert_verification(
  21123. enable_windows_cert_verification_, ca_cert_file_path_,
  21124. ca_cert_dir_path_, custom_ca_loaded_, system_ca_mode_);
  21125. options.server_certificate_verifier_set = server_certificate_verifier_set_;
  21126. #endif
  21127. auto timeout = handshake_timeout();
  21128. detail::ClientTlsSessionError tls_error;
  21129. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  21130. server_certificate_verification_,
  21131. timeout.first, timeout.second,
  21132. &tls_error, options)) {
  21133. error = tls_error.error;
  21134. ssl_error = tls_error.ssl_error;
  21135. ssl_backend_error = tls_error.backend_error;
  21136. return false;
  21137. }
  21138. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  21139. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  21140. write_timeout_usec_));
  21141. return true;
  21142. }
  21143. #else
  21144. (void)error;
  21145. (void)ssl_error;
  21146. (void)ssl_backend_error;
  21147. #endif
  21148. strm = std::unique_ptr<Stream>(
  21149. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  21150. write_timeout_sec_, write_timeout_usec_));
  21151. return true;
  21152. }
  21153. inline void WebSocketClient::prepare_default_headers(Request &req) {
  21154. #ifdef CPPHTTPLIB_SSL_ENABLED
  21155. auto is_ssl = is_ssl_;
  21156. #else
  21157. auto is_ssl = false;
  21158. #endif
  21159. if (!req.has_header("Host")) {
  21160. req.headers.emplace("Host", detail::make_default_host_header_value(
  21161. host_, port_, is_ssl, address_family_));
  21162. }
  21163. detail::add_default_user_agent_header(req);
  21164. detail::add_authorization_header(req, basic_auth_username_,
  21165. basic_auth_password_,
  21166. bearer_token_auth_token_, false);
  21167. }
  21168. inline Result WebSocketClient::connect() {
  21169. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  21170. shutdown_and_close();
  21171. auto error = Error::Success;
  21172. if (!create_and_connect_socket(error)) {
  21173. return Result{error, -1, Headers{}};
  21174. }
  21175. if (is_proxy_enabled()) {
  21176. Response proxy_res;
  21177. if (!connect_with_proxy(proxy_res, error)) {
  21178. shutdown_and_close();
  21179. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  21180. }
  21181. }
  21182. std::unique_ptr<Stream> strm;
  21183. auto stream_error = Error::SSLConnection;
  21184. int ssl_error = 0;
  21185. uint64_t ssl_backend_error = 0;
  21186. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  21187. shutdown_and_close();
  21188. #ifdef CPPHTTPLIB_SSL_ENABLED
  21189. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  21190. #else
  21191. return Result{stream_error, -1, Headers{}};
  21192. #endif
  21193. }
  21194. Request req;
  21195. req.method = "GET";
  21196. req.path = path_;
  21197. req.headers = headers_;
  21198. prepare_default_headers(req);
  21199. detail::WebSocketUpgradeResponse upgrade;
  21200. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  21201. shutdown_and_close();
  21202. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  21203. }
  21204. subprotocol_ = std::move(upgrade.selected_subprotocol);
  21205. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  21206. websocket_ping_interval_sec_,
  21207. websocket_max_missed_pongs_));
  21208. // The stream was created with the timeout already; tell the WebSocket
  21209. // whether it came from the caller, so read() knows to report it as Timeout.
  21210. ws_->read_timeout_set_ = read_timeout_set_;
  21211. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  21212. }
  21213. inline ReadResult WebSocketClient::read(std::string &msg) {
  21214. if (!ws_) { return Fail; }
  21215. return ws_->read(msg);
  21216. }
  21217. inline bool WebSocketClient::send(const std::string &data) {
  21218. if (!ws_) { return false; }
  21219. return ws_->send(data);
  21220. }
  21221. inline bool WebSocketClient::send(const char *data, size_t len) {
  21222. if (!ws_) { return false; }
  21223. return ws_->send(data, len);
  21224. }
  21225. inline void WebSocketClient::close(CloseStatus status,
  21226. const std::string &reason) {
  21227. if (ws_) { ws_->close(status, reason); }
  21228. }
  21229. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  21230. inline const std::string &WebSocketClient::subprotocol() const {
  21231. return subprotocol_;
  21232. }
  21233. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  21234. read_timeout_sec_ = sec;
  21235. read_timeout_usec_ = usec;
  21236. read_timeout_set_ = true;
  21237. // The members above only seed the next connect(); read() consults the
  21238. // stream, so an already-open connection has to be told directly.
  21239. if (ws_) { ws_->set_read_timeout(sec, usec); }
  21240. }
  21241. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  21242. write_timeout_sec_ = sec;
  21243. write_timeout_usec_ = usec;
  21244. }
  21245. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  21246. websocket_ping_interval_sec_ = sec;
  21247. }
  21248. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  21249. websocket_max_missed_pongs_ = count;
  21250. }
  21251. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  21252. inline void WebSocketClient::set_address_family(int family) {
  21253. address_family_ = family;
  21254. }
  21255. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  21256. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  21257. socket_options_ = std::move(socket_options);
  21258. }
  21259. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  21260. connection_timeout_sec_ = sec;
  21261. connection_timeout_usec_ = usec;
  21262. }
  21263. inline void WebSocketClient::set_interface(const std::string &intf) {
  21264. interface_ = intf;
  21265. }
  21266. inline void WebSocketClient::set_hostname_addr_map(
  21267. std::map<std::string, std::string> addr_map) {
  21268. set_direct_hostname_addr_map(std::move(addr_map));
  21269. }
  21270. inline void WebSocketClient::set_direct_hostname_addr_map(
  21271. std::map<std::string, std::string> addr_map) {
  21272. addr_map_ = std::move(addr_map);
  21273. }
  21274. inline void WebSocketClient::set_tunnel_hostname_addr_map(
  21275. std::map<std::string, std::string> addr_map) {
  21276. tunnel_addr_map_ = std::move(addr_map);
  21277. }
  21278. inline bool WebSocketClient::is_proxy_enabled() const {
  21279. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  21280. if (no_proxy_entries_.empty()) { return true; }
  21281. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  21282. no_proxy_entries_);
  21283. }
  21284. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  21285. std::string connect_host;
  21286. std::string ip;
  21287. auto port = port_;
  21288. if (is_proxy_enabled()) {
  21289. connect_host = proxy_host_;
  21290. port = proxy_port_;
  21291. } else {
  21292. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  21293. }
  21294. sock_ = detail::create_client_socket(
  21295. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  21296. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  21297. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  21298. write_timeout_usec_, interface_, error);
  21299. if (sock_ != INVALID_SOCKET) { return true; }
  21300. if (error == Error::Success) { error = Error::Connection; }
  21301. return false;
  21302. }
  21303. inline bool WebSocketClient::send_proxy_connect(Request &req,
  21304. Response &proxy_res,
  21305. Error &error) {
  21306. auto timeout = handshake_timeout();
  21307. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  21308. write_timeout_sec_, write_timeout_usec_);
  21309. if (!detail::write_request_head(strm, req, error)) { return false; }
  21310. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  21311. error = Error::Read;
  21312. return false;
  21313. }
  21314. return true;
  21315. }
  21316. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  21317. // forward an Upgrade request.
  21318. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  21319. Error &error) {
  21320. Request req;
  21321. req.method = "CONNECT";
  21322. req.path =
  21323. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  21324. req.headers.emplace("Host", req.path);
  21325. detail::add_default_user_agent_header(req);
  21326. detail::add_authorization_header(req, proxy_basic_auth_username_,
  21327. proxy_basic_auth_password_,
  21328. proxy_bearer_token_auth_token_, true);
  21329. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  21330. #ifdef CPPHTTPLIB_SSL_ENABLED
  21331. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  21332. std::map<std::string, std::string> auth;
  21333. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  21334. !proxy_digest_auth_username_.empty() &&
  21335. !proxy_digest_auth_password_.empty() &&
  21336. detail::parse_www_authenticate(proxy_res, auth, true)) {
  21337. proxy_res = Response();
  21338. shutdown_and_close();
  21339. if (!create_and_connect_socket(error)) { return false; }
  21340. req.headers.erase("Proxy-Authorization");
  21341. req.headers.insert(detail::make_digest_authentication_header(
  21342. req, req.path, auth, 1, detail::random_string(10),
  21343. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  21344. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  21345. }
  21346. #endif
  21347. if (proxy_res.status != StatusCode::OK_200) {
  21348. error = Error::ProxyConnection;
  21349. return false;
  21350. }
  21351. return true;
  21352. }
  21353. inline void WebSocketClient::set_basic_auth(const std::string &username,
  21354. const std::string &password) {
  21355. basic_auth_username_ = username;
  21356. basic_auth_password_ = password;
  21357. }
  21358. inline void WebSocketClient::set_bearer_token_auth(const std::string &token) {
  21359. bearer_token_auth_token_ = token;
  21360. }
  21361. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  21362. proxy_host_ = host;
  21363. proxy_port_ = port;
  21364. }
  21365. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  21366. const std::string &password) {
  21367. proxy_basic_auth_username_ = username;
  21368. proxy_basic_auth_password_ = password;
  21369. }
  21370. inline void
  21371. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  21372. proxy_bearer_token_auth_token_ = token;
  21373. }
  21374. inline void
  21375. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  21376. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  21377. }
  21378. #ifdef CPPHTTPLIB_SSL_ENABLED
  21379. inline void
  21380. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  21381. const std::string &ca_cert_dir_path) {
  21382. ca_cert_file_path_ = ca_cert_file_path;
  21383. ca_cert_dir_path_ = ca_cert_dir_path;
  21384. }
  21385. inline void
  21386. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  21387. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  21388. server_certificate_verifier_set_ = static_cast<bool>(verifier);
  21389. #endif
  21390. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  21391. }
  21392. inline void WebSocketClient::set_session_verifier(
  21393. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  21394. session_verifier_ = std::move(verifier);
  21395. }
  21396. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  21397. if (store && tls_ctx_) {
  21398. // set_ca_store takes ownership of store
  21399. tls::set_ca_store(tls_ctx_, store);
  21400. } else if (store) {
  21401. tls::free_ca_store(store);
  21402. }
  21403. custom_ca_loaded_ = true;
  21404. }
  21405. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  21406. std::size_t size) {
  21407. if (tls_ctx_ && ca_cert && size > 0) {
  21408. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  21409. }
  21410. custom_ca_loaded_ = true;
  21411. }
  21412. inline void
  21413. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  21414. server_certificate_verification_ = enabled;
  21415. }
  21416. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  21417. server_hostname_verification_ = enabled;
  21418. }
  21419. inline void WebSocketClient::enable_system_ca(bool enabled) {
  21420. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  21421. }
  21422. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  21423. inline void
  21424. WebSocketClient::enable_windows_certificate_verification(bool enabled) {
  21425. enable_windows_cert_verification_ = enabled;
  21426. }
  21427. #endif
  21428. inline void
  21429. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  21430. const std::string &password) {
  21431. proxy_digest_auth_username_ = username;
  21432. proxy_digest_auth_password_ = password;
  21433. }
  21434. #endif // CPPHTTPLIB_SSL_ENABLED
  21435. } // namespace ws
  21436. // ----------------------------------------------------------------------------
  21437. } // namespace httplib
  21438. #endif // CPPHTTPLIB_HTTPLIB_H