httplib.h 865 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005240062400724008240092401024011240122401324014240152401624017240182401924020240212402224023240242402524026240272402824029240302403124032240332403424035240362403724038240392404024041240422404324044240452404624047240482404924050240512405224053240542405524056240572405824059240602406124062240632406424065240662406724068240692407024071240722407324074240752407624077240782407924080240812408224083240842408524086240872408824089240902409124092240932409424095240962409724098240992410024101241022410324104241052410624107241082410924110241112411224113241142411524116241172411824119241202412124122241232412424125241262412724128241292413024131241322413324134241352413624137241382413924140241412414224143241442414524146241472414824149241502415124152241532415424155241562415724158241592416024161241622416324164241652416624167241682416924170241712417224173241742417524176241772417824179241802418124182241832418424185241862418724188241892419024191241922419324194241952419624197241982419924200242012420224203242042420524206242072420824209242102421124212242132421424215242162421724218242192422024221242222422324224242252422624227242282422924230242312423224233242342423524236242372423824239242402424124242242432424424245242462424724248242492425024251242522425324254242552425624257242582425924260242612426224263242642426524266242672426824269242702427124272242732427424275242762427724278242792428024281242822428324284242852428624287242882428924290242912429224293242942429524296242972429824299243002430124302243032430424305243062430724308243092431024311243122431324314243152431624317243182431924320243212432224323243242432524326243272432824329243302433124332243332433424335243362433724338243392434024341243422434324344243452434624347243482434924350243512435224353243542435524356243572435824359243602436124362243632436424365243662436724368243692437024371243722437324374243752437624377243782437924380243812438224383243842438524386243872438824389243902439124392243932439424395243962439724398243992440024401244022440324404244052440624407244082440924410244112441224413244142441524416244172441824419244202442124422244232442424425244262442724428244292443024431244322443324434244352443624437244382443924440244412444224443244442444524446244472444824449244502445124452244532445424455244562445724458244592446024461244622446324464244652446624467244682446924470244712447224473244742447524476244772447824479244802448124482244832448424485244862448724488244892449024491244922449324494244952449624497244982449924500245012450224503245042450524506245072450824509245102451124512245132451424515245162451724518245192452024521245222452324524245252452624527245282452924530245312453224533245342453524536245372453824539245402454124542245432454424545245462454724548245492455024551245522455324554245552455624557245582455924560245612456224563245642456524566245672456824569245702457124572245732457424575245762457724578245792458024581245822458324584245852458624587245882458924590245912459224593245942459524596245972459824599246002460124602246032460424605246062460724608246092461024611246122461324614246152461624617246182461924620246212462224623246242462524626246272462824629246302463124632246332463424635246362463724638246392464024641246422464324644246452464624647246482464924650246512465224653246542465524656246572465824659246602466124662246632466424665246662466724668246692467024671246722467324674246752467624677246782467924680246812468224683246842468524686246872468824689246902469124692246932469424695246962469724698246992470024701247022470324704247052470624707247082470924710247112471224713247142471524716247172471824719247202472124722247232472424725247262472724728247292473024731247322473324734247352473624737247382473924740247412474224743247442474524746247472474824749247502475124752247532475424755247562475724758247592476024761247622476324764247652476624767247682476924770247712477224773247742477524776247772477824779247802478124782247832478424785247862478724788247892479024791247922479324794247952479624797247982479924800248012480224803248042480524806248072480824809248102481124812248132481424815248162481724818248192482024821248222482324824248252482624827248282482924830248312483224833248342483524836248372483824839248402484124842248432484424845248462484724848248492485024851248522485324854248552485624857248582485924860248612486224863248642486524866248672486824869248702487124872248732487424875248762487724878248792488024881248822488324884248852488624887248882488924890248912489224893248942489524896248972489824899249002490124902249032490424905249062490724908249092491024911249122491324914249152491624917249182491924920249212492224923249242492524926249272492824929249302493124932249332493424935249362493724938249392494024941249422494324944249452494624947249482494924950249512495224953249542495524956249572495824959249602496124962249632496424965249662496724968249692497024971249722497324974249752497624977249782497924980249812498224983249842498524986249872498824989249902499124992249932499424995249962499724998249992500025001250022500325004250052500625007250082500925010250112501225013250142501525016250172501825019250202502125022250232502425025250262502725028250292503025031250322503325034250352503625037250382503925040250412504225043250442504525046250472504825049250502505125052250532505425055250562505725058
  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. // Otherwise `wait_for_next_request` waits for the socket, and returning false
  6064. // ends the loop. `callback` is told whether the socket has just been seen
  6065. // readable. `served` counts the requests served on this connection so far.
  6066. template <typename W, typename P, typename T>
  6067. inline bool process_server_socket_core(size_t &served,
  6068. size_t keep_alive_max_count,
  6069. W wait_for_next_request,
  6070. P has_buffered_request, T callback) {
  6071. auto ret = false;
  6072. // A keep_alive_max_count of 0 sets no limit.
  6073. for (; keep_alive_max_count == 0 || served < keep_alive_max_count; served++) {
  6074. auto socket_readable = false;
  6075. if (!has_buffered_request()) {
  6076. if (!wait_for_next_request()) { 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. size_t served = 0;
  6098. return process_server_socket_core(
  6099. served, keep_alive_max_count,
  6100. [&]() { return keep_alive(svr_sock, sock, keep_alive_timeout_sec); },
  6101. [&]() { return strm.is_readable(); },
  6102. [&](bool socket_readable, bool close_connection,
  6103. bool &connection_closed) {
  6104. if (socket_readable) { strm.set_readable_hint(); }
  6105. return callback(strm, close_connection, connection_closed);
  6106. });
  6107. }
  6108. inline bool process_client_socket(
  6109. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  6110. time_t write_timeout_sec, time_t write_timeout_usec,
  6111. time_t max_timeout_msec,
  6112. std::chrono::time_point<std::chrono::steady_clock> start_time,
  6113. std::function<bool(Stream &)> callback) {
  6114. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  6115. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  6116. start_time);
  6117. return callback(strm);
  6118. }
  6119. inline int shutdown_socket(socket_t sock) noexcept {
  6120. #ifdef _WIN32
  6121. return shutdown(sock, SD_BOTH);
  6122. #else
  6123. return shutdown(sock, SHUT_RDWR);
  6124. #endif
  6125. }
  6126. // Half-closes the write side and drains any in-flight/queued bytes before
  6127. // the final shutdown+close. Closing with unread data in the receive queue
  6128. // (or bytes arriving after the receive side is closed) makes the stack send
  6129. // an abortive RST instead of a graceful FIN, which can make the peer see the
  6130. // response as a failed read even though it was fully written.
  6131. inline void drain_and_close_socket(socket_t sock) noexcept {
  6132. #ifdef _WIN32
  6133. shutdown(sock, SD_SEND);
  6134. #else
  6135. shutdown(sock, SHUT_WR);
  6136. #endif
  6137. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6138. size_t total = 0;
  6139. const auto deadline = std::chrono::steady_clock::now() +
  6140. std::chrono::milliseconds(100); // bound #1
  6141. while (total < size_t(1024u * 1024u)) { // bound #2
  6142. const auto remaining =
  6143. std::chrono::duration_cast<std::chrono::microseconds>(
  6144. deadline - std::chrono::steady_clock::now())
  6145. .count();
  6146. if (remaining <= 0) { break; }
  6147. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  6148. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  6149. if (n <= 0) { break; }
  6150. total += static_cast<size_t>(n);
  6151. }
  6152. shutdown_socket(sock);
  6153. close_socket(sock);
  6154. }
  6155. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  6156. if (s.size() > 1 && s[0] == '\0') {
  6157. auto ret = s;
  6158. ret[0] = '@';
  6159. return ret;
  6160. }
  6161. return s;
  6162. }
  6163. inline std::string
  6164. unescape_abstract_namespace_unix_domain(const std::string &s) {
  6165. if (s.size() > 1 && s[0] == '@') {
  6166. auto ret = s;
  6167. ret[0] = '\0';
  6168. return ret;
  6169. }
  6170. return s;
  6171. }
  6172. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  6173. const struct addrinfo *hints,
  6174. struct addrinfo **res, time_t timeout_sec) {
  6175. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  6176. if (timeout_sec <= 0) {
  6177. // No timeout specified, use standard getaddrinfo
  6178. return getaddrinfo(node, service, hints, res);
  6179. }
  6180. #ifdef _WIN32
  6181. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  6182. OVERLAPPED overlapped = {};
  6183. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  6184. if (!event) { return EAI_FAIL; }
  6185. overlapped.hEvent = event;
  6186. PADDRINFOEXW result_addrinfo = nullptr;
  6187. HANDLE cancel_handle = nullptr;
  6188. ADDRINFOEXW hints_ex = {};
  6189. if (hints) {
  6190. hints_ex.ai_flags = hints->ai_flags;
  6191. hints_ex.ai_family = hints->ai_family;
  6192. hints_ex.ai_socktype = hints->ai_socktype;
  6193. hints_ex.ai_protocol = hints->ai_protocol;
  6194. }
  6195. auto wnode = u8string_to_wstring(node);
  6196. auto wservice = u8string_to_wstring(service);
  6197. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  6198. hints ? &hints_ex : nullptr, &result_addrinfo,
  6199. nullptr, &overlapped, nullptr, &cancel_handle);
  6200. if (ret == WSA_IO_PENDING) {
  6201. auto wait_result =
  6202. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  6203. if (wait_result == WAIT_TIMEOUT) {
  6204. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  6205. ::CloseHandle(event);
  6206. return EAI_AGAIN;
  6207. }
  6208. DWORD bytes_returned;
  6209. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  6210. &bytes_returned, FALSE)) {
  6211. ::CloseHandle(event);
  6212. return ::WSAGetLastError();
  6213. }
  6214. }
  6215. ::CloseHandle(event);
  6216. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  6217. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  6218. return 0;
  6219. }
  6220. return ret;
  6221. #elif TARGET_OS_MAC && defined(__clang__)
  6222. if (!node) { return EAI_NONAME; }
  6223. // macOS implementation using CFHost API for asynchronous DNS resolution
  6224. CFStringRef hostname_ref = CFStringCreateWithCString(
  6225. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  6226. if (!hostname_ref) { return EAI_MEMORY; }
  6227. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  6228. CFRelease(hostname_ref);
  6229. if (!host_ref) { return EAI_MEMORY; }
  6230. // Set up context for callback
  6231. struct CFHostContext {
  6232. bool completed = false;
  6233. bool success = false;
  6234. CFArrayRef addresses = nullptr;
  6235. std::mutex mutex;
  6236. std::condition_variable cv;
  6237. } context;
  6238. CFHostClientContext client_context;
  6239. memset(&client_context, 0, sizeof(client_context));
  6240. client_context.info = &context;
  6241. // Set callback
  6242. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  6243. const CFStreamError *error, void *info) {
  6244. auto ctx = static_cast<CFHostContext *>(info);
  6245. std::lock_guard<std::mutex> lock(ctx->mutex);
  6246. if (error && error->error != 0) {
  6247. ctx->success = false;
  6248. } else {
  6249. Boolean hasBeenResolved;
  6250. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  6251. if (ctx->addresses && hasBeenResolved) {
  6252. CFRetain(ctx->addresses);
  6253. ctx->success = true;
  6254. } else {
  6255. ctx->success = false;
  6256. }
  6257. }
  6258. ctx->completed = true;
  6259. ctx->cv.notify_one();
  6260. };
  6261. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  6262. CFRelease(host_ref);
  6263. return EAI_SYSTEM;
  6264. }
  6265. // Schedule on run loop
  6266. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  6267. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6268. // Start resolution
  6269. CFStreamError stream_error;
  6270. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  6271. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6272. CFRelease(host_ref);
  6273. return EAI_FAIL;
  6274. }
  6275. // Wait for completion with timeout
  6276. auto timeout_time =
  6277. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  6278. bool timed_out = false;
  6279. {
  6280. std::unique_lock<std::mutex> lock(context.mutex);
  6281. while (!context.completed) {
  6282. auto now = std::chrono::steady_clock::now();
  6283. if (now >= timeout_time) {
  6284. timed_out = true;
  6285. break;
  6286. }
  6287. // Run the runloop for a short time
  6288. lock.unlock();
  6289. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  6290. lock.lock();
  6291. }
  6292. }
  6293. // Clean up
  6294. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6295. CFHostSetClient(host_ref, nullptr, nullptr);
  6296. if (timed_out || !context.completed) {
  6297. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  6298. CFRelease(host_ref);
  6299. return EAI_AGAIN;
  6300. }
  6301. if (!context.success || !context.addresses) {
  6302. CFRelease(host_ref);
  6303. return EAI_NODATA;
  6304. }
  6305. // Convert CFArray to addrinfo
  6306. CFIndex count = CFArrayGetCount(context.addresses);
  6307. if (count == 0) {
  6308. CFRelease(context.addresses);
  6309. CFRelease(host_ref);
  6310. return EAI_NODATA;
  6311. }
  6312. struct addrinfo *result_addrinfo = nullptr;
  6313. struct addrinfo **current = &result_addrinfo;
  6314. for (CFIndex i = 0; i < count; i++) {
  6315. CFDataRef addr_data =
  6316. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  6317. if (!addr_data) continue;
  6318. const struct sockaddr *sockaddr_ptr =
  6319. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  6320. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  6321. // Allocate addrinfo structure
  6322. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  6323. if (!*current) {
  6324. freeaddrinfo(result_addrinfo);
  6325. CFRelease(context.addresses);
  6326. CFRelease(host_ref);
  6327. return EAI_MEMORY;
  6328. }
  6329. memset(*current, 0, sizeof(struct addrinfo));
  6330. // Set up addrinfo fields
  6331. (*current)->ai_family = sockaddr_ptr->sa_family;
  6332. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  6333. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  6334. (*current)->ai_addrlen = sockaddr_len;
  6335. // Copy sockaddr
  6336. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  6337. if (!(*current)->ai_addr) {
  6338. freeaddrinfo(result_addrinfo);
  6339. CFRelease(context.addresses);
  6340. CFRelease(host_ref);
  6341. return EAI_MEMORY;
  6342. }
  6343. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  6344. // Set port if service is specified
  6345. if (service && *service) {
  6346. int port = 0;
  6347. if (parse_port(service, strlen(service), port)) {
  6348. if (sockaddr_ptr->sa_family == AF_INET) {
  6349. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  6350. ->sin_port = htons(static_cast<uint16_t>(port));
  6351. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  6352. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  6353. ->sin6_port = htons(static_cast<uint16_t>(port));
  6354. }
  6355. }
  6356. }
  6357. current = &((*current)->ai_next);
  6358. }
  6359. CFRelease(context.addresses);
  6360. CFRelease(host_ref);
  6361. *res = result_addrinfo;
  6362. return 0;
  6363. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  6364. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  6365. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  6366. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  6367. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  6368. // the resolver worker still references the stack-local gaicb. The cancel
  6369. // path therefore waits (gai_suspend with no timeout) for the worker to
  6370. // actually finish before letting the stack frame go. The trade-off is that
  6371. // a wedged DNS server can hold this thread for the system resolver timeout
  6372. // (~30s by default) past the caller's connection timeout.
  6373. struct gaicb request{};
  6374. struct gaicb *requests[1] = {&request};
  6375. struct sigevent sevp{};
  6376. struct timespec timeout{timeout_sec, 0};
  6377. request.ar_name = node;
  6378. request.ar_service = service;
  6379. request.ar_request = hints;
  6380. sevp.sigev_notify = SIGEV_NONE;
  6381. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  6382. if (rc != 0) { return rc; }
  6383. auto cleanup = scope_exit([&] {
  6384. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  6385. });
  6386. int wait_result = gai_suspend(requests, 1, &timeout);
  6387. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  6388. int gai_result = gai_error(&request);
  6389. if (gai_result == 0) {
  6390. *res = request.ar_result;
  6391. request.ar_result = nullptr;
  6392. return 0;
  6393. }
  6394. return gai_result;
  6395. }
  6396. gai_cancel(&request);
  6397. while (gai_error(&request) == EAI_INPROGRESS) {
  6398. gai_suspend(requests, 1, nullptr);
  6399. }
  6400. return wait_result;
  6401. #else
  6402. // Fallback implementation using thread-based timeout for other Unix systems.
  6403. struct GetAddrInfoState {
  6404. ~GetAddrInfoState() {
  6405. if (info) { freeaddrinfo(info); }
  6406. }
  6407. std::mutex mutex;
  6408. std::condition_variable result_cv;
  6409. bool completed = false;
  6410. int result = EAI_SYSTEM;
  6411. std::string node;
  6412. std::string service;
  6413. struct addrinfo hints;
  6414. struct addrinfo *info = nullptr;
  6415. };
  6416. // Allocate on the heap, so the resolver thread can keep using the data.
  6417. auto state = std::make_shared<GetAddrInfoState>();
  6418. if (node) { state->node = node; }
  6419. state->service = service;
  6420. state->hints = *hints;
  6421. std::thread resolve_thread([state]() {
  6422. auto thread_result =
  6423. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6424. &state->info);
  6425. std::lock_guard<std::mutex> lock(state->mutex);
  6426. state->result = thread_result;
  6427. state->completed = true;
  6428. state->result_cv.notify_one();
  6429. });
  6430. // Wait for completion or timeout
  6431. std::unique_lock<std::mutex> lock(state->mutex);
  6432. auto finished =
  6433. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6434. [&] { return state->completed; });
  6435. if (finished) {
  6436. // Operation completed within timeout
  6437. resolve_thread.join();
  6438. *res = state->info;
  6439. state->info = nullptr; // Pass ownership to caller
  6440. return state->result;
  6441. } else {
  6442. // Timeout occurred
  6443. resolve_thread.detach(); // Let the thread finish in background
  6444. return EAI_AGAIN; // Return timeout error
  6445. }
  6446. #endif
  6447. #else
  6448. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6449. return getaddrinfo(node, service, hints, res);
  6450. #endif
  6451. }
  6452. template <typename BindOrConnect>
  6453. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6454. int address_family, int socket_flags, bool tcp_nodelay,
  6455. bool ipv6_v6only, SocketOptions socket_options,
  6456. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6457. // Get address info
  6458. const char *node = nullptr;
  6459. struct addrinfo hints;
  6460. struct addrinfo *result;
  6461. memset(&hints, 0, sizeof(struct addrinfo));
  6462. hints.ai_socktype = SOCK_STREAM;
  6463. hints.ai_protocol = IPPROTO_IP;
  6464. if (!ip.empty()) {
  6465. node = ip.c_str();
  6466. // Ask getaddrinfo to convert IP in c-string to address
  6467. hints.ai_family = AF_UNSPEC;
  6468. hints.ai_flags = AI_NUMERICHOST;
  6469. } else {
  6470. if (!host.empty()) { node = host.c_str(); }
  6471. hints.ai_family = address_family;
  6472. hints.ai_flags = socket_flags;
  6473. }
  6474. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6475. if (hints.ai_family == AF_UNIX) {
  6476. const auto addrlen = host.length();
  6477. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6478. #ifdef SOCK_CLOEXEC
  6479. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6480. hints.ai_protocol);
  6481. #else
  6482. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6483. #endif
  6484. if (sock != INVALID_SOCKET) {
  6485. sockaddr_un addr{};
  6486. addr.sun_family = AF_UNIX;
  6487. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6488. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6489. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6490. hints.ai_addrlen = static_cast<socklen_t>(
  6491. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6492. #ifndef SOCK_CLOEXEC
  6493. #ifndef _WIN32
  6494. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6495. #endif
  6496. #endif
  6497. if (socket_options) { socket_options(sock); }
  6498. #ifdef _WIN32
  6499. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6500. // remove the option.
  6501. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6502. #endif
  6503. bool dummy;
  6504. if (!bind_or_connect(sock, hints, dummy)) {
  6505. close_socket(sock);
  6506. sock = INVALID_SOCKET;
  6507. }
  6508. }
  6509. return sock;
  6510. }
  6511. #endif
  6512. auto service = std::to_string(port);
  6513. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6514. timeout_sec)) {
  6515. #if defined __linux__ && !defined __ANDROID__
  6516. res_init();
  6517. #endif
  6518. return INVALID_SOCKET;
  6519. }
  6520. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6521. for (auto rp = result; rp; rp = rp->ai_next) {
  6522. // Create a socket
  6523. #ifdef _WIN32
  6524. auto sock =
  6525. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6526. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6527. /**
  6528. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6529. * and above the socket creation fails on older Windows Systems.
  6530. *
  6531. * Let's try to create a socket the old way in this case.
  6532. *
  6533. * Reference:
  6534. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6535. *
  6536. * WSA_FLAG_NO_HANDLE_INHERIT:
  6537. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6538. * SP1, and later
  6539. *
  6540. */
  6541. if (sock == INVALID_SOCKET) {
  6542. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6543. }
  6544. #else
  6545. #ifdef SOCK_CLOEXEC
  6546. auto sock =
  6547. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6548. #else
  6549. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6550. #endif
  6551. #endif
  6552. if (sock == INVALID_SOCKET) { continue; }
  6553. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6554. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6555. close_socket(sock);
  6556. continue;
  6557. }
  6558. #endif
  6559. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6560. if (rp->ai_family == AF_INET6) {
  6561. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6562. }
  6563. if (socket_options) { socket_options(sock); }
  6564. // bind or connect
  6565. auto quit = false;
  6566. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6567. close_socket(sock);
  6568. if (quit) { break; }
  6569. }
  6570. return INVALID_SOCKET;
  6571. }
  6572. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6573. #ifdef _WIN32
  6574. auto flags = nonblocking ? 1UL : 0UL;
  6575. ioctlsocket(sock, FIONBIO, &flags);
  6576. #else
  6577. auto flags = fcntl(sock, F_GETFL, 0);
  6578. fcntl(sock, F_SETFL,
  6579. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6580. #endif
  6581. }
  6582. inline bool is_connection_error() {
  6583. #ifdef _WIN32
  6584. return WSAGetLastError() != WSAEWOULDBLOCK;
  6585. #else
  6586. return errno != EINPROGRESS;
  6587. #endif
  6588. }
  6589. // accept() failed because the process or the network stack is temporarily out
  6590. // of resources. The listening socket is still usable, so back off briefly and
  6591. // try again.
  6592. inline bool is_accept_resource_error() {
  6593. #ifdef _WIN32
  6594. auto err = WSAGetLastError();
  6595. return err == WSAEMFILE || err == WSAENOBUFS;
  6596. #else
  6597. auto err = errno;
  6598. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6599. #endif
  6600. }
  6601. // accept() failed for a reason that says nothing about the listening socket:
  6602. // the pending connection went away before it could be accepted, or the call
  6603. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6604. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6605. // connection that way.
  6606. inline bool is_accept_transient_error() {
  6607. #ifdef _WIN32
  6608. auto err = WSAGetLastError();
  6609. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6610. err == WSAECONNABORTED;
  6611. #else
  6612. auto err = errno;
  6613. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6614. err == ECONNABORTED;
  6615. #endif
  6616. }
  6617. inline bool create_socket_pair(socket_t sv[2]) {
  6618. #ifdef _WIN32
  6619. auto listener = create_socket(
  6620. std::string(), "127.0.0.1", 0, AF_INET, 0, false, false, nullptr,
  6621. [](socket_t sock, struct addrinfo &ai, bool &) {
  6622. return ::bind(sock, ai.ai_addr, static_cast<int>(ai.ai_addrlen)) == 0 &&
  6623. ::listen(sock, 1) == 0;
  6624. });
  6625. if (listener == INVALID_SOCKET) { return false; }
  6626. socket_t a = INVALID_SOCKET;
  6627. socket_t b = INVALID_SOCKET;
  6628. sockaddr_in addr{};
  6629. auto addr_len = static_cast<int>(sizeof(addr));
  6630. if (::getsockname(listener, reinterpret_cast<sockaddr *>(&addr), &addr_len) ==
  6631. 0) {
  6632. a = create_socket(std::string(), "127.0.0.1", ntohs(addr.sin_port), AF_INET,
  6633. 0, true, false, nullptr,
  6634. [](socket_t sock, struct addrinfo &ai, bool &) {
  6635. return ::connect(sock, ai.ai_addr,
  6636. static_cast<int>(ai.ai_addrlen)) == 0;
  6637. });
  6638. // Unlike accept(), this keeps the listener's no-inherit flag.
  6639. if (a != INVALID_SOCKET) {
  6640. b = WSAAccept(listener, nullptr, nullptr, nullptr, 0);
  6641. }
  6642. }
  6643. close_socket(listener);
  6644. // Any local process could connect while the listener was open, so make sure
  6645. // that the connection we accepted is the one we made.
  6646. if (b != INVALID_SOCKET) {
  6647. sockaddr_in local{}, peer{};
  6648. auto local_len = static_cast<int>(sizeof(local));
  6649. auto peer_len = static_cast<int>(sizeof(peer));
  6650. if (::getsockname(a, reinterpret_cast<sockaddr *>(&local), &local_len) !=
  6651. 0 ||
  6652. ::getpeername(b, reinterpret_cast<sockaddr *>(&peer), &peer_len) != 0 ||
  6653. local.sin_port != peer.sin_port ||
  6654. local.sin_addr.s_addr != peer.sin_addr.s_addr) {
  6655. close_socket(b);
  6656. b = INVALID_SOCKET;
  6657. }
  6658. }
  6659. if (b == INVALID_SOCKET) {
  6660. if (a != INVALID_SOCKET) { close_socket(a); }
  6661. return false;
  6662. }
  6663. sv[0] = a;
  6664. sv[1] = b;
  6665. return true;
  6666. #else
  6667. #ifdef SOCK_CLOEXEC
  6668. return ::socketpair(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0, sv) == 0;
  6669. #else
  6670. if (::socketpair(AF_UNIX, SOCK_STREAM, 0, sv) != 0) { return false; }
  6671. fcntl(sv[0], F_SETFD, FD_CLOEXEC);
  6672. fcntl(sv[1], F_SETFD, FD_CLOEXEC);
  6673. return true;
  6674. #endif
  6675. #endif
  6676. }
  6677. inline PollerWaker::~PollerWaker() {
  6678. if (pair_fd_ != INVALID_SOCKET) { close_socket(pair_fd_); }
  6679. if (fd_ != INVALID_SOCKET) { close_socket(fd_); }
  6680. }
  6681. inline bool PollerWaker::open() {
  6682. // wake() must not block its caller, and drain() must not block the poller.
  6683. #ifdef __linux__
  6684. fd_ = eventfd(0, EFD_NONBLOCK | EFD_CLOEXEC);
  6685. return fd_ != INVALID_SOCKET;
  6686. #else
  6687. socket_t sv[2];
  6688. if (!create_socket_pair(sv)) { return false; }
  6689. fd_ = sv[0];
  6690. pair_fd_ = sv[1];
  6691. set_nonblocking(fd_, true);
  6692. set_nonblocking(pair_fd_, true);
  6693. return true;
  6694. #endif
  6695. }
  6696. inline void PollerWaker::wake() noexcept {
  6697. if (pending_.exchange(true)) { return; }
  6698. #ifdef __linux__
  6699. const uint64_t one = 1;
  6700. auto r = write(fd_, &one, sizeof(one));
  6701. (void)r;
  6702. #else
  6703. const char c = 1;
  6704. send_socket(pair_fd_, &c, 1, CPPHTTPLIB_SEND_FLAGS);
  6705. #endif
  6706. }
  6707. inline void PollerWaker::drain() noexcept {
  6708. // While pending_ is set, at most one wake is unread, and one read takes it.
  6709. #ifdef __linux__
  6710. uint64_t count;
  6711. auto r = read(fd_, &count, sizeof(count));
  6712. (void)r;
  6713. #else
  6714. char buf[64];
  6715. read_socket(fd_, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  6716. #endif
  6717. // Only after the read: cleared before it, a wake() in between would be read
  6718. // here and leave pending_ set with nothing to read. One skipped during the
  6719. // read is fine, as the caller checks what it was woken for afterwards.
  6720. pending_ = false;
  6721. }
  6722. inline std::unique_ptr<Poller> PollPoller::create() {
  6723. std::unique_ptr<PollPoller> poller(new PollPoller());
  6724. if (!poller->waker_.open()) { return nullptr; }
  6725. struct pollfd pfd;
  6726. pfd.fd = poller->waker_.fd();
  6727. pfd.events = POLLIN;
  6728. pfd.revents = 0;
  6729. poller->fds_.push_back(pfd);
  6730. poller->tokens_.push_back(0);
  6731. return std::unique_ptr<Poller>(poller.release());
  6732. }
  6733. inline bool PollPoller::arm(socket_t fd, Token token) {
  6734. assert(index_.find(fd) == index_.end());
  6735. struct pollfd pfd;
  6736. pfd.fd = fd;
  6737. pfd.events = POLLIN;
  6738. pfd.revents = 0;
  6739. index_[fd] = fds_.size();
  6740. fds_.push_back(pfd);
  6741. tokens_.push_back(token);
  6742. return true;
  6743. }
  6744. inline void PollPoller::disarm(socket_t fd) {
  6745. auto it = index_.find(fd);
  6746. if (it != index_.end()) { remove_at(it->second); }
  6747. }
  6748. // Fills the hole with the last entry, so that arm() and disarm() are O(1).
  6749. inline void PollPoller::remove_at(size_t index) {
  6750. assert(index > 0 && index < fds_.size());
  6751. auto last = fds_.size() - 1;
  6752. index_.erase(fds_[index].fd);
  6753. if (index != last) {
  6754. fds_[index] = fds_[last];
  6755. tokens_[index] = tokens_[last];
  6756. index_[fds_[index].fd] = index;
  6757. }
  6758. fds_.pop_back();
  6759. tokens_.pop_back();
  6760. }
  6761. inline bool PollPoller::wait(int timeout_ms, std::vector<Token> &ready) {
  6762. ready.clear();
  6763. auto n = handle_EINTR([&]() {
  6764. return poll_wrapper(fds_.data(), static_cast<nfds_t>(fds_.size()),
  6765. timeout_ms);
  6766. });
  6767. if (n <= 0) { return false; }
  6768. auto woken = fds_[0].revents != 0;
  6769. if (woken) {
  6770. n--;
  6771. waker_.drain();
  6772. }
  6773. // Walk backwards: remove_at() moves the last entry, already seen, into the
  6774. // freed slot.
  6775. for (auto i = fds_.size(); n > 0 && i-- > 1;) {
  6776. auto revents = fds_[i].revents;
  6777. if (revents == 0) { continue; }
  6778. n--;
  6779. assert(!(revents & POLLNVAL)); // closed while armed
  6780. if (!(revents & POLLNVAL)) { ready.push_back(tokens_[i]); }
  6781. remove_at(i);
  6782. }
  6783. return woken;
  6784. }
  6785. #ifdef __linux__
  6786. inline std::unique_ptr<Poller> EpollPoller::create() {
  6787. std::unique_ptr<EpollPoller> poller(new EpollPoller());
  6788. poller->epfd_ = epoll_create1(EPOLL_CLOEXEC);
  6789. if (poller->epfd_ < 0 || !poller->waker_.open()) { return nullptr; }
  6790. epoll_event ev{};
  6791. ev.events = EPOLLIN; // level-triggered: it stays readable until drained
  6792. ev.data.u64 = poller->waker_.token();
  6793. if (epoll_ctl(poller->epfd_, EPOLL_CTL_ADD, poller->waker_.fd(), &ev) != 0) {
  6794. return nullptr;
  6795. }
  6796. poller->events_.resize(256);
  6797. return std::unique_ptr<Poller>(poller.release());
  6798. }
  6799. inline EpollPoller::~EpollPoller() {
  6800. if (epfd_ >= 0) { close(epfd_); }
  6801. }
  6802. inline bool EpollPoller::arm(socket_t fd, Token token) {
  6803. epoll_event ev{};
  6804. ev.events = EPOLLIN | EPOLLONESHOT;
  6805. ev.data.u64 = token;
  6806. // A delivered descriptor stays registered, only disabled, so modify it.
  6807. // One that was closed in between, or never armed, has to be added.
  6808. return epoll_ctl(epfd_, EPOLL_CTL_MOD, fd, &ev) == 0 ||
  6809. (errno == ENOENT && epoll_ctl(epfd_, EPOLL_CTL_ADD, fd, &ev) == 0);
  6810. }
  6811. inline void EpollPoller::disarm(socket_t fd) {
  6812. epoll_ctl(epfd_, EPOLL_CTL_DEL, fd, nullptr);
  6813. }
  6814. inline bool EpollPoller::wait(int timeout_ms, std::vector<Token> &ready) {
  6815. ready.clear();
  6816. auto n = handle_EINTR([&]() {
  6817. return epoll_wait(epfd_, events_.data(), static_cast<int>(events_.size()),
  6818. timeout_ms);
  6819. });
  6820. auto woken = false;
  6821. for (auto i = 0; i < n; i++) {
  6822. auto token = static_cast<Token>(events_[static_cast<size_t>(i)].data.u64);
  6823. if (token == waker_.token()) {
  6824. woken = true;
  6825. waker_.drain();
  6826. } else {
  6827. ready.push_back(token);
  6828. }
  6829. }
  6830. return woken;
  6831. }
  6832. #endif
  6833. #ifdef CPPHTTPLIB_KQUEUE_POLLER
  6834. inline std::unique_ptr<Poller> KqueuePoller::create() {
  6835. std::unique_ptr<KqueuePoller> poller(new KqueuePoller());
  6836. poller->kq_ = kqueue();
  6837. if (poller->kq_ < 0) { return nullptr; }
  6838. fcntl(poller->kq_, F_SETFD, FD_CLOEXEC);
  6839. if (!poller->waker_.open()) { return nullptr; }
  6840. // Level-triggered: it stays readable until drained.
  6841. struct kevent ev;
  6842. EV_SET(&ev, poller->waker_.fd(), EVFILT_READ, EV_ADD, 0, 0,
  6843. reinterpret_cast<void *>(poller->waker_.token()));
  6844. if (kevent(poller->kq_, &ev, 1, nullptr, 0, nullptr) != 0) { return nullptr; }
  6845. poller->events_.resize(256);
  6846. return std::unique_ptr<Poller>(poller.release());
  6847. }
  6848. inline KqueuePoller::~KqueuePoller() {
  6849. if (kq_ >= 0) { close(kq_); }
  6850. }
  6851. inline bool KqueuePoller::arm(socket_t fd, Token token) {
  6852. // EV_ONESHOT deletes the event once it is delivered.
  6853. struct kevent ev;
  6854. EV_SET(&ev, fd, EVFILT_READ, EV_ADD | EV_ONESHOT, 0, 0,
  6855. reinterpret_cast<void *>(token));
  6856. return kevent(kq_, &ev, 1, nullptr, 0, nullptr) == 0;
  6857. }
  6858. inline void KqueuePoller::disarm(socket_t fd) {
  6859. struct kevent ev;
  6860. EV_SET(&ev, fd, EVFILT_READ, EV_DELETE, 0, 0, nullptr);
  6861. kevent(kq_, &ev, 1, nullptr, 0, nullptr);
  6862. }
  6863. inline bool KqueuePoller::wait(int timeout_ms, std::vector<Token> &ready) {
  6864. ready.clear();
  6865. struct timespec ts;
  6866. ts.tv_sec = timeout_ms / 1000;
  6867. ts.tv_nsec = static_cast<long>(timeout_ms % 1000) * 1000000;
  6868. auto n = handle_EINTR([&]() {
  6869. return kevent(kq_, nullptr, 0, events_.data(),
  6870. static_cast<int>(events_.size()),
  6871. timeout_ms < 0 ? nullptr : &ts);
  6872. });
  6873. auto woken = false;
  6874. for (auto i = 0; i < n; i++) {
  6875. auto token = reinterpret_cast<Token>(events_[static_cast<size_t>(i)].udata);
  6876. if (token == waker_.token()) {
  6877. woken = true;
  6878. waker_.drain();
  6879. } else {
  6880. ready.push_back(token);
  6881. }
  6882. }
  6883. return woken;
  6884. }
  6885. #endif
  6886. inline std::unique_ptr<Poller> make_poller() {
  6887. #if defined(__linux__)
  6888. auto poller = EpollPoller::create();
  6889. if (poller) { return poller; }
  6890. #elif defined(CPPHTTPLIB_KQUEUE_POLLER)
  6891. auto poller = KqueuePoller::create();
  6892. if (poller) { return poller; }
  6893. #endif
  6894. return PollPoller::create();
  6895. }
  6896. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6897. struct addrinfo hints;
  6898. struct addrinfo *result;
  6899. memset(&hints, 0, sizeof(struct addrinfo));
  6900. hints.ai_family = AF_UNSPEC;
  6901. hints.ai_socktype = SOCK_STREAM;
  6902. hints.ai_protocol = 0;
  6903. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6904. return false;
  6905. }
  6906. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6907. auto ret = false;
  6908. for (auto rp = result; rp; rp = rp->ai_next) {
  6909. const auto &ai = *rp;
  6910. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6911. ret = true;
  6912. break;
  6913. }
  6914. }
  6915. return ret;
  6916. }
  6917. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6918. #define USE_IF2IP
  6919. #endif
  6920. #ifdef USE_IF2IP
  6921. inline std::string if2ip(int address_family, const std::string &ifn) {
  6922. struct ifaddrs *ifap;
  6923. getifaddrs(&ifap);
  6924. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6925. std::string addr_candidate;
  6926. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6927. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6928. (AF_UNSPEC == address_family ||
  6929. ifa->ifa_addr->sa_family == address_family)) {
  6930. if (ifa->ifa_addr->sa_family == AF_INET) {
  6931. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6932. char buf[INET_ADDRSTRLEN];
  6933. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6934. return std::string(buf, INET_ADDRSTRLEN);
  6935. }
  6936. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6937. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6938. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6939. char buf[INET6_ADDRSTRLEN] = {};
  6940. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6941. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6942. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6943. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6944. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6945. } else {
  6946. return std::string(buf, INET6_ADDRSTRLEN);
  6947. }
  6948. }
  6949. }
  6950. }
  6951. }
  6952. }
  6953. return addr_candidate;
  6954. }
  6955. #endif
  6956. inline socket_t
  6957. create_client_socket(const std::string &host, const std::string &ip, int port,
  6958. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6959. SocketOptions socket_options,
  6960. time_t connection_timeout_sec,
  6961. time_t connection_timeout_usec, time_t read_timeout_sec,
  6962. time_t read_timeout_usec, time_t write_timeout_sec,
  6963. time_t write_timeout_usec, const std::string &intf,
  6964. Error &error, const std::function<bool()> &interrupted) {
  6965. auto sock = create_socket(
  6966. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6967. std::move(socket_options),
  6968. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6969. if (!intf.empty()) {
  6970. #ifdef USE_IF2IP
  6971. auto ip_from_if = if2ip(address_family, intf);
  6972. if (ip_from_if.empty()) { ip_from_if = intf; }
  6973. if (!bind_ip_address(sock2, ip_from_if)) {
  6974. error = Error::BindIPAddress;
  6975. return false;
  6976. }
  6977. #endif
  6978. }
  6979. set_nonblocking(sock2, true);
  6980. auto ret =
  6981. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6982. if (ret < 0) {
  6983. if (is_connection_error()) {
  6984. error = Error::Connection;
  6985. return false;
  6986. }
  6987. error =
  6988. wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6989. connection_timeout_usec, interrupted);
  6990. if (error != Error::Success) {
  6991. if (error == Error::ConnectionTimeout || error == Error::Canceled) {
  6992. quit = true;
  6993. }
  6994. return false;
  6995. }
  6996. }
  6997. set_nonblocking(sock2, false);
  6998. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6999. read_timeout_usec);
  7000. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  7001. write_timeout_usec);
  7002. error = Error::Success;
  7003. return true;
  7004. },
  7005. connection_timeout_sec); // Pass DNS timeout
  7006. if (sock != INVALID_SOCKET) {
  7007. error = Error::Success;
  7008. } else {
  7009. if (error == Error::Success) { error = Error::Connection; }
  7010. }
  7011. return sock;
  7012. }
  7013. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  7014. socklen_t addr_len, std::string &ip, int &port) {
  7015. if (addr.ss_family == AF_INET) {
  7016. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  7017. } else if (addr.ss_family == AF_INET6) {
  7018. port =
  7019. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  7020. } else {
  7021. return false;
  7022. }
  7023. std::array<char, NI_MAXHOST> ipstr{};
  7024. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  7025. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  7026. 0, NI_NUMERICHOST)) {
  7027. return false;
  7028. }
  7029. ip = ipstr.data();
  7030. return true;
  7031. }
  7032. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  7033. struct sockaddr_storage addr;
  7034. socklen_t addr_len = sizeof(addr);
  7035. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  7036. &addr_len)) {
  7037. get_ip_and_port(addr, addr_len, ip, port);
  7038. }
  7039. }
  7040. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  7041. struct sockaddr_storage addr;
  7042. socklen_t addr_len = sizeof(addr);
  7043. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  7044. &addr_len)) {
  7045. #ifndef _WIN32
  7046. if (addr.ss_family == AF_UNIX) {
  7047. #if defined(__linux__)
  7048. struct ucred ucred;
  7049. socklen_t len = sizeof(ucred);
  7050. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  7051. port = ucred.pid;
  7052. }
  7053. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  7054. pid_t pid;
  7055. socklen_t len = sizeof(pid);
  7056. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  7057. port = pid;
  7058. }
  7059. #endif
  7060. return;
  7061. }
  7062. #endif
  7063. get_ip_and_port(addr, addr_len, ip, port);
  7064. }
  7065. }
  7066. inline std::string
  7067. find_content_type(const std::string &path,
  7068. const std::map<std::string, std::string> &user_data,
  7069. const std::string &default_content_type) {
  7070. // Extensions are matched regardless of case, as web servers do
  7071. auto ext = case_ignore::to_lower(file_extension(path));
  7072. auto it = user_data.find(ext);
  7073. if (it != user_data.end()) { return it->second; }
  7074. static const struct {
  7075. const char *ext;
  7076. const char *type;
  7077. } types[] = {
  7078. {"css", "text/css"},
  7079. {"csv", "text/csv"},
  7080. {"htm", "text/html"},
  7081. {"html", "text/html"},
  7082. {"js", "text/javascript"},
  7083. {"mjs", "text/javascript"},
  7084. {"txt", "text/plain"},
  7085. {"vtt", "text/vtt"},
  7086. {"apng", "image/apng"},
  7087. {"avif", "image/avif"},
  7088. {"bmp", "image/bmp"},
  7089. {"gif", "image/gif"},
  7090. {"png", "image/png"},
  7091. {"svg", "image/svg+xml"},
  7092. {"webp", "image/webp"},
  7093. {"ico", "image/x-icon"},
  7094. {"tif", "image/tiff"},
  7095. {"tiff", "image/tiff"},
  7096. {"jpg", "image/jpeg"},
  7097. {"jpeg", "image/jpeg"},
  7098. {"mp4", "video/mp4"},
  7099. {"mpeg", "video/mpeg"},
  7100. {"webm", "video/webm"},
  7101. {"mp3", "audio/mp3"},
  7102. {"mpga", "audio/mpeg"},
  7103. {"weba", "audio/webm"},
  7104. {"wav", "audio/wave"},
  7105. {"otf", "font/otf"},
  7106. {"ttf", "font/ttf"},
  7107. {"woff", "font/woff"},
  7108. {"woff2", "font/woff2"},
  7109. {"7z", "application/x-7z-compressed"},
  7110. {"atom", "application/atom+xml"},
  7111. {"pdf", "application/pdf"},
  7112. {"json", "application/json"},
  7113. {"rss", "application/rss+xml"},
  7114. {"tar", "application/x-tar"},
  7115. {"xht", "application/xhtml+xml"},
  7116. {"xhtml", "application/xhtml+xml"},
  7117. {"xslt", "application/xslt+xml"},
  7118. {"xml", "application/xml"},
  7119. {"gz", "application/gzip"},
  7120. {"zip", "application/zip"},
  7121. {"wasm", "application/wasm"},
  7122. };
  7123. for (const auto &t : types) {
  7124. if (ext == t.ext) { return t.type; }
  7125. }
  7126. return default_content_type;
  7127. }
  7128. inline std::string
  7129. extract_media_type(const std::string &content_type,
  7130. std::map<std::string, std::string> *params = nullptr) {
  7131. // Extract type/subtype from Content-Type value (RFC 2045)
  7132. // e.g. "application/json; charset=utf-8" -> "application/json"
  7133. auto media_type = content_type;
  7134. auto semicolon_pos = media_type.find(';');
  7135. if (semicolon_pos != std::string::npos) {
  7136. auto param_str = media_type.substr(semicolon_pos + 1);
  7137. media_type = media_type.substr(0, semicolon_pos);
  7138. if (params) {
  7139. // Parse parameters: key=value pairs separated by ';'
  7140. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  7141. [&](const char *b, const char *e) {
  7142. std::string key;
  7143. std::string val;
  7144. divide_param_pair(b, e, key, val);
  7145. // Parameter names are case-insensitive (RFC 9110
  7146. // §5.6.6)
  7147. if (!key.empty()) {
  7148. params->emplace(case_ignore::to_lower(trim_copy(key)),
  7149. unquote_param(val));
  7150. }
  7151. });
  7152. }
  7153. }
  7154. // Trim whitespace from media type
  7155. return trim_copy(media_type);
  7156. }
  7157. inline bool can_compress_content_type(const std::string &content_type) {
  7158. // Media types are case-insensitive (RFC 9110 §8.3.1)
  7159. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  7160. static const char *const compressible[] = {
  7161. "image/svg+xml",
  7162. "application/javascript",
  7163. "application/x-javascript",
  7164. "application/json",
  7165. "application/ld+json",
  7166. "application/xml",
  7167. "application/xhtml+xml",
  7168. "application/rss+xml",
  7169. "application/atom+xml",
  7170. "application/xslt+xml",
  7171. "application/protobuf",
  7172. };
  7173. for (auto type : compressible) {
  7174. if (mime_type == type) { return true; }
  7175. }
  7176. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  7177. }
  7178. inline bool parse_quality(const char *b, const char *e, std::string &token,
  7179. double &quality) {
  7180. quality = 1.0;
  7181. token.clear();
  7182. // Split on first ';': left = token name, right = parameters
  7183. const char *params_b = nullptr;
  7184. std::size_t params_len = 0;
  7185. divide(
  7186. b, static_cast<std::size_t>(e - b), ';',
  7187. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  7188. auto r = trim(lb, lb + llen, 0, llen);
  7189. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  7190. params_b = rb;
  7191. params_len = rlen;
  7192. });
  7193. if (token.empty()) { return false; }
  7194. if (params_len == 0) { return true; }
  7195. // Scan parameters for q= (stops on first match)
  7196. bool invalid = false;
  7197. split_find(params_b, params_b + params_len, ';',
  7198. (std::numeric_limits<size_t>::max)(),
  7199. [&](const char *pb, const char *pe) -> bool {
  7200. // Match exactly "q=" or "Q=" (not "query=" etc.)
  7201. auto len = static_cast<size_t>(pe - pb);
  7202. if (len < 2) { return false; }
  7203. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  7204. return false;
  7205. }
  7206. // Trim the value portion
  7207. auto r = trim(pb, pe, 2, len);
  7208. if (r.first >= r.second) {
  7209. invalid = true;
  7210. return true;
  7211. }
  7212. double v = 0.0;
  7213. auto res = from_chars(pb + r.first, pb + r.second, v);
  7214. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  7215. v < 0.0 || v > 1.0) {
  7216. invalid = true;
  7217. return true;
  7218. }
  7219. quality = v;
  7220. return true;
  7221. });
  7222. return !invalid;
  7223. }
  7224. inline EncodingType encoding_type(const Request &req,
  7225. const std::string &content_type) {
  7226. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  7227. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  7228. if (s.empty()) { return EncodingType::None; }
  7229. // Single-pass: iterate tokens and track the best supported encoding.
  7230. // Server preference breaks ties (br > gzip > zstd).
  7231. EncodingType best = EncodingType::None;
  7232. double best_q = 0.0; // q=0 means "not acceptable"
  7233. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  7234. auto priority = [](EncodingType t) -> int {
  7235. switch (t) {
  7236. case EncodingType::Brotli: return 0;
  7237. case EncodingType::Gzip: return 1;
  7238. case EncodingType::Zstd: return 2;
  7239. default: return 3;
  7240. }
  7241. };
  7242. std::string name;
  7243. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7244. double quality = 1.0;
  7245. if (!parse_quality(b, e, name, quality)) { return; }
  7246. if (quality <= 0.0) { return; }
  7247. EncodingType type = EncodingType::None;
  7248. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7249. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  7250. #endif
  7251. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7252. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  7253. type = EncodingType::Gzip;
  7254. }
  7255. #endif
  7256. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7257. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  7258. type = EncodingType::Zstd;
  7259. }
  7260. #endif
  7261. if (type == EncodingType::None) { return; }
  7262. // Higher q-value wins; for equal q, server preference breaks ties
  7263. if (quality > best_q ||
  7264. (quality == best_q && priority(type) < priority(best))) {
  7265. best_q = quality;
  7266. best = type;
  7267. }
  7268. });
  7269. return best;
  7270. }
  7271. // `content_type` is taken separately because a file-backed response has not
  7272. // been given one yet when its coding has to be decided.
  7273. inline EncodingType encoding_type(const Request &req, const Response &res,
  7274. const std::string &content_type) {
  7275. // The response already names a content coding of its own: a handler serving
  7276. // a body it encoded itself (pre-compressed static assets, say), or a mount
  7277. // point whose headers name the coding its files are stored in. Applying one
  7278. // on top of that would double-encode the body and append a second
  7279. // `Content-Encoding` field line.
  7280. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  7281. return encoding_type(req, content_type);
  7282. }
  7283. inline EncodingType encoding_type(const Request &req, const Response &res) {
  7284. return encoding_type(req, res, res.get_header_value("Content-Type"));
  7285. }
  7286. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  7287. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7288. if (type == EncodingType::Gzip) {
  7289. return detail::make_unique<gzip_compressor>();
  7290. }
  7291. #endif
  7292. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7293. if (type == EncodingType::Brotli) {
  7294. return detail::make_unique<brotli_compressor>();
  7295. }
  7296. #endif
  7297. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7298. if (type == EncodingType::Zstd) {
  7299. return detail::make_unique<zstd_compressor>();
  7300. }
  7301. #endif
  7302. (void)type;
  7303. return nullptr;
  7304. }
  7305. inline const char *encoding_name(EncodingType type) {
  7306. switch (type) {
  7307. case EncodingType::Gzip: return "gzip";
  7308. case EncodingType::Brotli: return "br";
  7309. case EncodingType::Zstd: return "zstd";
  7310. default: return "";
  7311. }
  7312. }
  7313. inline bool nocompressor::compress(const char *data, size_t data_length,
  7314. bool /*last*/, Callback callback) {
  7315. if (!data_length) { return true; }
  7316. return callback(data, data_length);
  7317. }
  7318. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7319. inline gzip_compressor::gzip_compressor() {
  7320. std::memset(&strm_, 0, sizeof(strm_));
  7321. strm_.zalloc = Z_NULL;
  7322. strm_.zfree = Z_NULL;
  7323. strm_.opaque = Z_NULL;
  7324. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  7325. Z_DEFAULT_STRATEGY) == Z_OK;
  7326. }
  7327. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  7328. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  7329. bool last, Callback callback) {
  7330. assert(is_valid_);
  7331. do {
  7332. constexpr size_t max_avail_in =
  7333. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  7334. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  7335. (std::min)(data_length, max_avail_in));
  7336. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  7337. data_length -= strm_.avail_in;
  7338. data += strm_.avail_in;
  7339. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  7340. auto ret = Z_OK;
  7341. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7342. do {
  7343. strm_.avail_out = static_cast<uInt>(buff.size());
  7344. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  7345. ret = deflate(&strm_, flush);
  7346. if (ret == Z_STREAM_ERROR) { return false; }
  7347. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  7348. return false;
  7349. }
  7350. } while (strm_.avail_out == 0);
  7351. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  7352. (flush == Z_NO_FLUSH && ret == Z_OK));
  7353. assert(strm_.avail_in == 0);
  7354. } while (data_length > 0);
  7355. return true;
  7356. }
  7357. inline gzip_decompressor::gzip_decompressor() {
  7358. std::memset(&strm_, 0, sizeof(strm_));
  7359. strm_.zalloc = Z_NULL;
  7360. strm_.zfree = Z_NULL;
  7361. strm_.opaque = Z_NULL;
  7362. // 15 is the value of wbits, which should be at the maximum possible value
  7363. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  7364. // that the stream type should be automatically detected either gzip or
  7365. // deflate.
  7366. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  7367. }
  7368. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  7369. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  7370. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  7371. Callback callback) {
  7372. assert(is_valid_);
  7373. auto ret = Z_OK;
  7374. do {
  7375. constexpr size_t max_avail_in =
  7376. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  7377. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  7378. (std::min)(data_length, max_avail_in));
  7379. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  7380. data_length -= strm_.avail_in;
  7381. data += strm_.avail_in;
  7382. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7383. while (strm_.avail_in > 0 && ret == Z_OK) {
  7384. strm_.avail_out = static_cast<uInt>(buff.size());
  7385. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  7386. ret = inflate(&strm_, Z_NO_FLUSH);
  7387. assert(ret != Z_STREAM_ERROR);
  7388. switch (ret) {
  7389. case Z_NEED_DICT:
  7390. case Z_DATA_ERROR:
  7391. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  7392. }
  7393. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  7394. return false;
  7395. }
  7396. }
  7397. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  7398. } while (data_length > 0);
  7399. return true;
  7400. }
  7401. #endif
  7402. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7403. inline brotli_compressor::brotli_compressor() {
  7404. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  7405. }
  7406. inline brotli_compressor::~brotli_compressor() {
  7407. BrotliEncoderDestroyInstance(state_);
  7408. }
  7409. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  7410. bool last, Callback callback) {
  7411. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7412. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  7413. auto available_in = data_length;
  7414. auto next_in = reinterpret_cast<const uint8_t *>(data);
  7415. for (;;) {
  7416. if (last) {
  7417. if (BrotliEncoderIsFinished(state_)) { break; }
  7418. } else {
  7419. if (!available_in) { break; }
  7420. }
  7421. auto available_out = buff.size();
  7422. auto next_out = buff.data();
  7423. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  7424. &available_out, &next_out, nullptr)) {
  7425. return false;
  7426. }
  7427. auto output_bytes = buff.size() - available_out;
  7428. if (output_bytes) {
  7429. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  7430. }
  7431. }
  7432. return true;
  7433. }
  7434. inline brotli_decompressor::brotli_decompressor() {
  7435. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  7436. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  7437. : BROTLI_DECODER_RESULT_ERROR;
  7438. }
  7439. inline brotli_decompressor::~brotli_decompressor() {
  7440. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  7441. }
  7442. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  7443. inline bool brotli_decompressor::decompress(const char *data,
  7444. size_t data_length,
  7445. Callback callback) {
  7446. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  7447. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  7448. return 0;
  7449. }
  7450. auto next_in = reinterpret_cast<const uint8_t *>(data);
  7451. size_t avail_in = data_length;
  7452. size_t total_out;
  7453. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  7454. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7455. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  7456. char *next_out = buff.data();
  7457. size_t avail_out = buff.size();
  7458. decoder_r = BrotliDecoderDecompressStream(
  7459. decoder_s, &avail_in, &next_in, &avail_out,
  7460. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  7461. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  7462. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  7463. }
  7464. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  7465. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  7466. }
  7467. #endif
  7468. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7469. inline zstd_compressor::zstd_compressor() {
  7470. ctx_ = ZSTD_createCCtx();
  7471. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  7472. }
  7473. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  7474. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  7475. bool last, Callback callback) {
  7476. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7477. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  7478. ZSTD_inBuffer input = {data, data_length, 0};
  7479. bool finished;
  7480. do {
  7481. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  7482. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  7483. if (ZSTD_isError(remaining)) { return false; }
  7484. if (!callback(buff.data(), output.pos)) { return false; }
  7485. finished = last ? (remaining == 0) : (input.pos == input.size);
  7486. } while (!finished);
  7487. return true;
  7488. }
  7489. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  7490. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  7491. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  7492. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  7493. Callback callback) {
  7494. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7495. ZSTD_inBuffer input = {data, data_length, 0};
  7496. while (input.pos < input.size) {
  7497. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  7498. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  7499. if (ZSTD_isError(remaining)) { return false; }
  7500. if (!callback(buff.data(), output.pos)) { return false; }
  7501. }
  7502. return true;
  7503. }
  7504. #endif
  7505. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  7506. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  7507. // unknown coding, and its payload would be handed back still compressed.
  7508. inline bool is_zlib_encoding(const std::string &encoding) {
  7509. return case_ignore::equal(encoding, "gzip") ||
  7510. case_ignore::equal(encoding, "deflate");
  7511. }
  7512. inline bool is_brotli_encoding(const std::string &encoding) {
  7513. return case_ignore::equal(encoding, "br");
  7514. }
  7515. inline bool is_zstd_encoding(const std::string &encoding) {
  7516. return case_ignore::equal(encoding, "zstd");
  7517. }
  7518. // Returns true if the content coding is one cpp-httplib is able to decompress
  7519. // when the corresponding support is compiled in.
  7520. inline bool is_known_content_encoding(const std::string &encoding) {
  7521. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  7522. is_zstd_encoding(encoding);
  7523. }
  7524. inline std::unique_ptr<decompressor>
  7525. create_decompressor(const std::string &encoding) {
  7526. std::unique_ptr<decompressor> decompressor;
  7527. if (is_zlib_encoding(encoding)) {
  7528. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7529. decompressor = detail::make_unique<gzip_decompressor>();
  7530. #endif
  7531. } else if (is_brotli_encoding(encoding)) {
  7532. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7533. decompressor = detail::make_unique<brotli_decompressor>();
  7534. #endif
  7535. } else if (is_zstd_encoding(encoding)) {
  7536. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7537. decompressor = detail::make_unique<zstd_decompressor>();
  7538. #endif
  7539. }
  7540. return decompressor;
  7541. }
  7542. // Returns the best available compressor and its Content-Encoding name.
  7543. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  7544. inline std::pair<std::unique_ptr<compressor>, const char *>
  7545. create_compressor() {
  7546. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7547. return {detail::make_unique<brotli_compressor>(), "br"};
  7548. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  7549. return {detail::make_unique<gzip_compressor>(), "gzip"};
  7550. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  7551. return {detail::make_unique<zstd_compressor>(), "zstd"};
  7552. #else
  7553. return {nullptr, nullptr};
  7554. #endif
  7555. }
  7556. inline bool is_prohibited_header_name(const std::string &name) {
  7557. // Field names are case-insensitive (RFC 9110 §5.1)
  7558. return case_ignore::equal(name, "REMOTE_ADDR") ||
  7559. case_ignore::equal(name, "REMOTE_PORT") ||
  7560. case_ignore::equal(name, "LOCAL_ADDR") ||
  7561. case_ignore::equal(name, "LOCAL_PORT");
  7562. }
  7563. inline bool has_header(const Headers &headers, const std::string &key) {
  7564. if (is_prohibited_header_name(key)) { return false; }
  7565. return headers.find(key) != headers.end();
  7566. }
  7567. inline const char *get_header_value(const Headers &headers,
  7568. const std::string &key, const char *def,
  7569. size_t id) {
  7570. if (is_prohibited_header_name(key)) {
  7571. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  7572. std::string msg = "Prohibited header name '" + key + "' is specified.";
  7573. throw std::invalid_argument(msg);
  7574. #else
  7575. return "";
  7576. #endif
  7577. }
  7578. auto rng = headers.equal_range(key);
  7579. auto it = bounded_next(rng.first, id, rng.second);
  7580. if (it != rng.second) { return it->second.c_str(); }
  7581. return def;
  7582. }
  7583. inline size_t get_header_value_count(const Headers &headers,
  7584. const std::string &key) {
  7585. return headers.count(key);
  7586. }
  7587. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  7588. // list may be sent as several field lines, and the combined field value is
  7589. // those values joined by commas in the order they were received. Callers that
  7590. // parse such a list must work on the combined value; reading only the first
  7591. // occurrence silently drops whatever the later field lines carry.
  7592. inline std::string get_combined_header_value(const Headers &headers,
  7593. const std::string &key) {
  7594. std::string combined;
  7595. auto rng = headers.equal_range(key);
  7596. for (auto it = rng.first; it != rng.second; ++it) {
  7597. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  7598. // elements, so an empty field line must not contribute a bare comma to the
  7599. // combined value.
  7600. if (it->second.empty()) { continue; }
  7601. if (!combined.empty()) { combined += ", "; }
  7602. combined += it->second;
  7603. }
  7604. return combined;
  7605. }
  7606. inline bool has_header_token(const Headers &headers, const std::string &key,
  7607. const std::string &token) {
  7608. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  7609. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  7610. // several lines. Match complete tokens rather than searching the raw value,
  7611. // so that a value such as "notupgrade" is not read as the token "upgrade".
  7612. auto rng = headers.equal_range(key);
  7613. for (auto it = rng.first; it != rng.second; ++it) {
  7614. const auto &value = it->second;
  7615. if (split_find(value.data(), value.data() + value.size(), ',',
  7616. [&](const char *b, const char *e) {
  7617. return case_ignore::equal(std::string(b, e), token);
  7618. })) {
  7619. return true;
  7620. }
  7621. }
  7622. return false;
  7623. }
  7624. template <typename Map>
  7625. inline typename Map::mapped_type
  7626. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  7627. auto rng = m.equal_range(key);
  7628. auto it = bounded_next(rng.first, id, rng.second);
  7629. if (it != rng.second) { return it->second; }
  7630. return typename Map::mapped_type();
  7631. }
  7632. inline void set_header(Headers &headers, const std::string &key,
  7633. const std::string &val) {
  7634. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  7635. }
  7636. // Drops the fields set_header() would refuse, from headers an application can
  7637. // fill directly: CR/LF in one would split the message.
  7638. inline void erase_invalid_fields(Headers &headers) {
  7639. for (auto it = headers.begin(); it != headers.end();) {
  7640. if (fields::is_field_valid(it->first, it->second)) {
  7641. ++it;
  7642. } else {
  7643. it = headers.erase(it);
  7644. }
  7645. }
  7646. }
  7647. inline bool read_headers(Stream &strm, Headers &headers) {
  7648. const auto bufsiz = 2048;
  7649. char buf[bufsiz];
  7650. stream_line_reader line_reader(strm, buf, bufsiz);
  7651. size_t header_count = 0;
  7652. for (;;) {
  7653. if (!line_reader.getline()) { return false; }
  7654. // Check if the line ends with CRLF.
  7655. auto line_terminator_len = 2;
  7656. if (line_reader.end_with_crlf()) {
  7657. // Blank line indicates end of headers.
  7658. if (line_reader.size() == 2) { break; }
  7659. } else {
  7660. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7661. // Blank line indicates end of headers.
  7662. if (line_reader.size() == 1) { break; }
  7663. line_terminator_len = 1;
  7664. #else
  7665. continue; // Skip invalid line.
  7666. #endif
  7667. }
  7668. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7669. // Check header count limit
  7670. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  7671. // Exclude line terminator
  7672. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  7673. if (!parse_header(line_reader.ptr(), end,
  7674. [&](const std::string &key, const std::string &val) {
  7675. headers.emplace(key, val);
  7676. })) {
  7677. return false;
  7678. }
  7679. header_count++;
  7680. }
  7681. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7682. // headers that have different values to prevent request smuggling.
  7683. auto cl_range = headers.equal_range("Content-Length");
  7684. if (cl_range.first != cl_range.second) {
  7685. const auto &first_val = cl_range.first->second;
  7686. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7687. if (it->second != first_val) { return false; }
  7688. }
  7689. }
  7690. return true;
  7691. }
  7692. // Parsed by hand: std::regex_match recurses once per character of the reason
  7693. // phrase, which a server can make as long as a whole line.
  7694. inline bool parse_status_line(const char *line, std::string &version,
  7695. int &status, std::string &reason) {
  7696. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7697. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7698. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7699. !is_ascii_digit(line[11])) {
  7700. return false;
  7701. }
  7702. auto p = line + 12;
  7703. auto reason_begin = p;
  7704. if (*p == ' ') {
  7705. reason_begin = ++p;
  7706. p += std::strcspn(p, "\r\n");
  7707. }
  7708. auto reason_end = p;
  7709. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7710. if (*p == '\r') { p++; }
  7711. #else
  7712. if (*p++ != '\r') { return false; }
  7713. #endif
  7714. if (*p++ != '\n' || *p != '\0') { return false; }
  7715. version.assign(line, 8);
  7716. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7717. reason.assign(reason_begin, reason_end);
  7718. return true;
  7719. }
  7720. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7721. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7722. struct WebSocketUpgradeResponse {
  7723. Error error = Error::Success;
  7724. int status = -1;
  7725. Headers headers;
  7726. std::string selected_subprotocol;
  7727. };
  7728. // Reads a response's status line and headers, leaving any body unread. An
  7729. // unparsable status line is no stream error; it just leaves `status` as is.
  7730. inline bool read_response_head(Stream &strm, int &status, Headers &headers) {
  7731. const auto bufsiz = 2048;
  7732. char buf[bufsiz];
  7733. stream_line_reader line_reader(strm, buf, bufsiz);
  7734. if (!line_reader.getline()) { return false; }
  7735. std::string version;
  7736. std::string reason;
  7737. if (!parse_status_line(line_reader.ptr(), version, status, reason)) {
  7738. return true;
  7739. }
  7740. return read_headers(strm, headers);
  7741. }
  7742. inline bool
  7743. read_websocket_upgrade_response(Stream &strm,
  7744. const std::string &expected_accept,
  7745. const std::string &offered_subprotocols,
  7746. WebSocketUpgradeResponse &upgrade) {
  7747. // The headers of a rejection are kept so the caller can see why the server
  7748. // refused the upgrade.
  7749. if (!read_response_head(strm, upgrade.status, upgrade.headers)) {
  7750. upgrade.error = Error::Read;
  7751. return false;
  7752. }
  7753. const auto &headers = upgrade.headers;
  7754. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7755. upgrade.error = Error::WebSocketHandshake;
  7756. return false;
  7757. }
  7758. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7759. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7760. upgrade.error = Error::WebSocketHandshake;
  7761. return false;
  7762. }
  7763. // Verify Connection: Upgrade
  7764. if (!has_header_token(headers, "Connection", "upgrade")) {
  7765. upgrade.error = Error::WebSocketHandshake;
  7766. return false;
  7767. }
  7768. // Verify Sec-WebSocket-Accept header value
  7769. auto it = headers.find("Sec-WebSocket-Accept");
  7770. if (it == headers.end() || it->second != expected_accept) {
  7771. upgrade.error = Error::WebSocketHandshake;
  7772. return false;
  7773. }
  7774. // Extract negotiated subprotocol
  7775. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7776. if (proto_it != headers.end()) {
  7777. upgrade.selected_subprotocol = proto_it->second;
  7778. }
  7779. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7780. if (!upgrade.selected_subprotocol.empty()) {
  7781. auto was_offered = false;
  7782. split(offered_subprotocols.data(),
  7783. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7784. [&](const char *b, const char *e) {
  7785. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7786. was_offered = true;
  7787. }
  7788. });
  7789. if (!was_offered) {
  7790. upgrade.error = Error::WebSocketHandshake;
  7791. return false;
  7792. }
  7793. }
  7794. return true;
  7795. }
  7796. enum class ReadContentResult {
  7797. Success, // Successfully read the content
  7798. PayloadTooLarge, // The content exceeds the specified payload limit
  7799. Error // An error occurred while reading the content
  7800. };
  7801. inline ReadContentResult read_content_with_length(
  7802. Stream &strm, size_t len, DownloadProgress progress,
  7803. ContentReceiverWithProgress out,
  7804. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7805. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7806. detail::BodyReader br;
  7807. br.stream = &strm;
  7808. br.has_content_length = true;
  7809. br.content_length = len;
  7810. br.payload_max_length = payload_max_length;
  7811. br.chunked = false;
  7812. br.bytes_read = 0;
  7813. br.last_error = Error::Success;
  7814. size_t r = 0;
  7815. while (r < len) {
  7816. auto read_len = static_cast<size_t>(len - r);
  7817. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7818. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7819. if (n <= 0) {
  7820. // Check if it was a payload size error
  7821. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7822. return ReadContentResult::PayloadTooLarge;
  7823. }
  7824. return ReadContentResult::Error;
  7825. }
  7826. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7827. return ReadContentResult::Error;
  7828. }
  7829. r += static_cast<size_t>(n);
  7830. if (progress) {
  7831. if (!progress(r, len)) { return ReadContentResult::Error; }
  7832. }
  7833. }
  7834. return ReadContentResult::Success;
  7835. }
  7836. inline ReadContentResult
  7837. read_content_without_length(Stream &strm, size_t payload_max_length,
  7838. ContentReceiverWithProgress out) {
  7839. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7840. size_t r = 0;
  7841. for (;;) {
  7842. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7843. if (n == 0) { return ReadContentResult::Success; }
  7844. if (n < 0) { return ReadContentResult::Error; }
  7845. // Check if adding this data would exceed the payload limit
  7846. if (payload_max_length > 0 &&
  7847. (r > payload_max_length ||
  7848. payload_max_length - r < static_cast<size_t>(n))) {
  7849. return ReadContentResult::PayloadTooLarge;
  7850. }
  7851. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7852. return ReadContentResult::Error;
  7853. }
  7854. r += static_cast<size_t>(n);
  7855. }
  7856. return ReadContentResult::Success;
  7857. }
  7858. template <typename T>
  7859. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7860. size_t payload_max_length,
  7861. ContentReceiverWithProgress out) {
  7862. detail::ChunkedDecoder dec(strm);
  7863. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7864. size_t total_len = 0;
  7865. for (;;) {
  7866. size_t chunk_offset = 0;
  7867. size_t chunk_total = 0;
  7868. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7869. if (n < 0) { return ReadContentResult::Error; }
  7870. if (n == 0) {
  7871. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7872. return ReadContentResult::Error;
  7873. }
  7874. return ReadContentResult::Success;
  7875. }
  7876. if (payload_max_length > 0 &&
  7877. (total_len > payload_max_length ||
  7878. payload_max_length - total_len < static_cast<size_t>(n))) {
  7879. return ReadContentResult::PayloadTooLarge;
  7880. }
  7881. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7882. return ReadContentResult::Error;
  7883. }
  7884. total_len += static_cast<size_t>(n);
  7885. }
  7886. }
  7887. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7888. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7889. // is the final transfer coding. A single field value may list several
  7890. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7891. // several Transfer-Encoding lines, which combine into one comma-separated
  7892. // list in the order the lines were received. Headers preserves that order,
  7893. // so the final coding is the last token of the last line. Match it
  7894. // case-insensitively rather than comparing the whole value against
  7895. // "chunked".
  7896. //
  7897. // Security: reading a chunked message as unframed leaves its body in the
  7898. // socket, where a keep-alive connection parses it as a smuggled request.
  7899. // Server::process_request() answers 400 and closes when the final coding is
  7900. // not chunked, so a request whose framing cannot be determined never
  7901. // reaches the "no body" path.
  7902. auto rng = headers.equal_range("Transfer-Encoding");
  7903. if (rng.first == rng.second) { return false; }
  7904. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7905. // combined list ending in nothing rather than inheriting the line before it.
  7906. std::string last_coding;
  7907. for (auto it = rng.first; it != rng.second; ++it) {
  7908. const auto &value = it->second;
  7909. last_coding.clear();
  7910. split(value.data(), value.data() + value.size(), ',',
  7911. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7912. }
  7913. return case_ignore::equal(last_coding, "chunked");
  7914. }
  7915. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7916. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7917. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7918. return msg.has_header("Transfer-Encoding") &&
  7919. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7920. }
  7921. inline bool has_conflicting_content_length(const Headers &headers) {
  7922. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7923. // Content-Length is framed ambiguously. The body readers here delimit it by
  7924. // the transfer coding and drop Content-Length, while an intermediary may do
  7925. // the reverse, so the two disagree on where the body ends and a reused
  7926. // connection is desynchronised (request/response smuggling). Content-Length:
  7927. // 0 is tolerated for compatibility with existing peers.
  7928. return has_header(headers, "Transfer-Encoding") &&
  7929. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7930. }
  7931. template <typename T, typename U>
  7932. bool prepare_content_receiver(T &x, int &status,
  7933. ContentReceiverWithProgress receiver,
  7934. bool decompress, size_t payload_max_length,
  7935. bool &exceed_payload_max_length, U callback) {
  7936. if (decompress) {
  7937. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7938. std::unique_ptr<decompressor> decompressor;
  7939. if (!encoding.empty()) {
  7940. // A coding we know about but were not built with is an error. An
  7941. // unrecognized coding (including "identity") is left alone and the
  7942. // payload is passed through as-is, since some servers misuse the header,
  7943. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7944. decompressor = detail::create_decompressor(encoding);
  7945. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7946. status = StatusCode::UnsupportedMediaType_415;
  7947. return false;
  7948. }
  7949. }
  7950. if (decompressor) {
  7951. if (decompressor->is_valid()) {
  7952. size_t decompressed_size = 0;
  7953. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7954. size_t off, size_t len) {
  7955. return decompressor->decompress(
  7956. buf, n, [&](const char *buf2, size_t n2) {
  7957. // Guard against zip-bomb: check
  7958. // decompressed size against limit.
  7959. if (payload_max_length > 0 &&
  7960. (decompressed_size >= payload_max_length ||
  7961. n2 > payload_max_length - decompressed_size)) {
  7962. exceed_payload_max_length = true;
  7963. return false;
  7964. }
  7965. decompressed_size += n2;
  7966. return receiver(buf2, n2, off, len);
  7967. });
  7968. };
  7969. return callback(std::move(out));
  7970. } else {
  7971. status = StatusCode::InternalServerError_500;
  7972. return false;
  7973. }
  7974. }
  7975. }
  7976. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7977. size_t len) {
  7978. return receiver(buf, n, off, len);
  7979. };
  7980. return callback(std::move(out));
  7981. }
  7982. template <typename T>
  7983. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7984. DownloadProgress progress,
  7985. ContentReceiverWithProgress receiver, bool decompress) {
  7986. bool exceed_payload_max_length = false;
  7987. return prepare_content_receiver(
  7988. x, status, std::move(receiver), decompress, payload_max_length,
  7989. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7990. auto ret = true;
  7991. // Note: exceed_payload_max_length may also be set by the decompressor
  7992. // wrapper in prepare_content_receiver when the decompressed payload
  7993. // size exceeds the limit.
  7994. if (is_chunked_transfer_encoding(x.headers)) {
  7995. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7996. if (result == ReadContentResult::Success) {
  7997. ret = true;
  7998. } else if (result == ReadContentResult::PayloadTooLarge) {
  7999. exceed_payload_max_length = true;
  8000. ret = false;
  8001. } else {
  8002. ret = false;
  8003. }
  8004. } else if (!has_header(x.headers, "Content-Length")) {
  8005. auto result =
  8006. read_content_without_length(strm, payload_max_length, out);
  8007. if (result == ReadContentResult::Success) {
  8008. ret = true;
  8009. } else if (result == ReadContentResult::PayloadTooLarge) {
  8010. exceed_payload_max_length = true;
  8011. ret = false;
  8012. } else {
  8013. ret = false;
  8014. }
  8015. } else {
  8016. auto is_invalid_value = false;
  8017. auto len = get_header_value_u64(x.headers, "Content-Length",
  8018. (std::numeric_limits<size_t>::max)(),
  8019. 0, is_invalid_value);
  8020. if (is_invalid_value) {
  8021. ret = false;
  8022. } else if (len > 0) {
  8023. auto result = read_content_with_length(
  8024. strm, len, std::move(progress), out, payload_max_length);
  8025. ret = (result == ReadContentResult::Success);
  8026. if (result == ReadContentResult::PayloadTooLarge) {
  8027. exceed_payload_max_length = true;
  8028. }
  8029. }
  8030. }
  8031. if (!ret) {
  8032. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  8033. : StatusCode::BadRequest_400;
  8034. }
  8035. return ret;
  8036. });
  8037. }
  8038. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  8039. const std::string &path) {
  8040. // Neither the method nor the request target may carry CR/LF, SP or other
  8041. // control octets; otherwise a value smuggled into either splits the request
  8042. // line and injects headers or a whole request.
  8043. if (!fields::is_token(method)) { return -1; }
  8044. if (!fields::is_request_target(path)) { return -1; }
  8045. std::string s = method;
  8046. s += ' ';
  8047. s += path;
  8048. s += " HTTP/1.1\r\n";
  8049. return strm.write(s.data(), s.size());
  8050. }
  8051. inline ssize_t write_response_line(Stream &strm, int status) {
  8052. std::string s = "HTTP/1.1 ";
  8053. s += std::to_string(status);
  8054. s += ' ';
  8055. s += httplib::status_message(status);
  8056. s += "\r\n";
  8057. return strm.write(s.data(), s.size());
  8058. }
  8059. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  8060. ssize_t write_len = 0;
  8061. for (const auto &x : headers) {
  8062. std::string s;
  8063. s = x.first;
  8064. s += ": ";
  8065. s += x.second;
  8066. s += "\r\n";
  8067. auto len = strm.write(s.data(), s.size());
  8068. if (len < 0) { return len; }
  8069. write_len += len;
  8070. }
  8071. auto len = strm.write("\r\n");
  8072. if (len < 0) { return len; }
  8073. write_len += len;
  8074. return write_len;
  8075. }
  8076. inline bool write_data(Stream &strm, const char *d, size_t l) {
  8077. size_t offset = 0;
  8078. while (offset < l) {
  8079. auto length = strm.write(d + offset, l - offset);
  8080. if (length < 0) { return false; }
  8081. offset += static_cast<size_t>(length);
  8082. }
  8083. return true;
  8084. }
  8085. template <typename T>
  8086. inline bool write_content_with_progress(Stream &strm,
  8087. const ContentProvider &content_provider,
  8088. size_t offset, size_t length,
  8089. T is_shutting_down,
  8090. const UploadProgress &upload_progress,
  8091. Error &error) {
  8092. size_t end_offset = offset + length;
  8093. size_t start_offset = offset;
  8094. auto ok = true;
  8095. auto finished = false;
  8096. DataSink data_sink;
  8097. data_sink.write = [&](const char *d, size_t l) -> bool {
  8098. if (ok) {
  8099. // Bytes past `length` would follow the framed body, where the peer reads
  8100. // them as the next message. Write only what fits and fail the rest.
  8101. if (l > end_offset - offset) {
  8102. l = end_offset - offset;
  8103. ok = false;
  8104. }
  8105. if (write_data(strm, d, l)) {
  8106. offset += l;
  8107. if (upload_progress && length > 0) {
  8108. size_t current_written = offset - start_offset;
  8109. if (!upload_progress(current_written, length)) {
  8110. ok = false;
  8111. return false;
  8112. }
  8113. }
  8114. } else {
  8115. ok = false;
  8116. }
  8117. }
  8118. return ok;
  8119. };
  8120. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  8121. // The body is framed by `length`, so a provider that reports itself done
  8122. // early has truncated it. Record that and let the short-body check below
  8123. // fail the write, rather than calling the provider again forever.
  8124. data_sink.done = [&]() { finished = true; };
  8125. while (offset < end_offset && !finished && !is_shutting_down()) {
  8126. auto last_offset = offset;
  8127. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  8128. error = Error::Write;
  8129. return false;
  8130. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  8131. error = Error::Canceled;
  8132. return false;
  8133. } else if (!ok) {
  8134. error = Error::Write;
  8135. return false;
  8136. }
  8137. // A provider that reports success without writing anything and without
  8138. // reporting itself done gets handed the same offset and length again on
  8139. // the next pass, so it would spin here for as long as the peer stays
  8140. // connected. Treat making no progress as a short body, like done() early.
  8141. if (!finished && offset == last_offset) {
  8142. error = Error::Write;
  8143. return false;
  8144. }
  8145. }
  8146. if (offset < end_offset) { // done() called early, or is_shutting_down()
  8147. error = Error::Write;
  8148. return false;
  8149. }
  8150. error = Error::Success;
  8151. return true;
  8152. }
  8153. template <typename T>
  8154. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  8155. size_t offset, size_t length, T is_shutting_down,
  8156. Error &error) {
  8157. return write_content_with_progress<T>(strm, content_provider, offset, length,
  8158. is_shutting_down, nullptr, error);
  8159. }
  8160. template <typename T>
  8161. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  8162. size_t offset, size_t length,
  8163. const T &is_shutting_down) {
  8164. auto error = Error::Success;
  8165. return write_content(strm, content_provider, offset, length, is_shutting_down,
  8166. error);
  8167. }
  8168. template <typename T>
  8169. inline bool
  8170. write_content_without_length(Stream &strm,
  8171. const ContentProvider &content_provider,
  8172. const T &is_shutting_down) {
  8173. size_t offset = 0;
  8174. auto data_available = true;
  8175. auto ok = true;
  8176. DataSink data_sink;
  8177. data_sink.write = [&](const char *d, size_t l) -> bool {
  8178. if (ok) {
  8179. offset += l;
  8180. if (!write_data(strm, d, l)) { ok = false; }
  8181. }
  8182. return ok;
  8183. };
  8184. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  8185. data_sink.done = [&](void) { data_available = false; };
  8186. while (data_available && !is_shutting_down()) {
  8187. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  8188. return false;
  8189. } else if (!content_provider(offset, 0, data_sink)) {
  8190. return false;
  8191. } else if (!ok) {
  8192. return false;
  8193. }
  8194. }
  8195. return !data_available; // true only if done() was called, false if shutting
  8196. // down
  8197. }
  8198. // Runs a known-length content provider to completion and compresses what it
  8199. // writes into `out`, chunk by chunk, without holding the identity form.
  8200. inline bool compress_content_provider(const ContentProvider &content_provider,
  8201. size_t length, compressor &cmp,
  8202. std::string &out) {
  8203. size_t offset = 0;
  8204. auto ok = true;
  8205. auto finished = false;
  8206. DataSink data_sink;
  8207. auto append = [&](const char *data, size_t data_len) {
  8208. out.append(data, data_len);
  8209. return true;
  8210. };
  8211. data_sink.write = [&](const char *d, size_t l) -> bool {
  8212. if (!ok) { return false; }
  8213. offset += l;
  8214. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  8215. return ok;
  8216. };
  8217. // The body is framed by `length`, so a provider that reports itself done
  8218. // early has truncated it; the short-body check below turns that into a
  8219. // failure rather than calling the provider again forever.
  8220. data_sink.done = [&]() { finished = true; };
  8221. while (offset < length && !finished) {
  8222. auto prev_offset = offset;
  8223. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  8224. return false;
  8225. }
  8226. // No Stream to block on here, so a provider that keeps returning true
  8227. // without writing would spin. Treat a pass that made no progress as a
  8228. // failure.
  8229. if (offset == prev_offset) { return false; }
  8230. }
  8231. if (offset != length) { return false; }
  8232. return cmp.compress(nullptr, 0, true, append);
  8233. }
  8234. // Serves `m` as the response body. `set_content_provider()` clears the coding
  8235. // and the file flag, so recording them has to come after; keeping all of it
  8236. // here means a third file-serving path cannot get that order wrong.
  8237. inline void set_file_content_provider(Response &res,
  8238. const std::shared_ptr<mmap> &m,
  8239. const std::string &content_type,
  8240. EncodingType encoding) {
  8241. // One read and one write move up to this much of the file at a time.
  8242. auto buf = std::make_shared<std::vector<char>>(
  8243. (std::min)(m->size(), size_t(256 * 1024)));
  8244. res.set_content_provider(
  8245. m->size(), content_type,
  8246. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  8247. // Never read past the file, which ends the response early if it has
  8248. // shrunk since it was opened.
  8249. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  8250. if (n == 0) { return false; }
  8251. sink.write(buf->data(), n);
  8252. return true;
  8253. });
  8254. res.is_file_content_provider_ = true;
  8255. res.content_coding_ = encoding;
  8256. }
  8257. template <typename T, typename U>
  8258. inline bool
  8259. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  8260. const T &is_shutting_down, U &compressor, Error &error) {
  8261. size_t offset = 0;
  8262. auto data_available = true;
  8263. auto ok = true;
  8264. DataSink data_sink;
  8265. data_sink.write = [&](const char *d, size_t l) -> bool {
  8266. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  8267. // to hand over is ordinary (an empty buffer popped off a queue), and a
  8268. // zero-length chunk is the terminator, so it must not be emitted here.
  8269. if (ok && l > 0) {
  8270. offset += l;
  8271. std::string payload;
  8272. if (compressor.compress(d, l, false,
  8273. [&](const char *data, size_t data_len) {
  8274. payload.append(data, data_len);
  8275. return true;
  8276. })) {
  8277. if (!payload.empty()) {
  8278. // Emit chunked response header and footer for each chunk
  8279. auto chunk =
  8280. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  8281. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  8282. }
  8283. } else {
  8284. ok = false;
  8285. }
  8286. }
  8287. return ok;
  8288. };
  8289. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  8290. auto done_with_trailer = [&](const Headers *trailer) {
  8291. if (!ok) { return; }
  8292. data_available = false;
  8293. std::string payload;
  8294. if (!compressor.compress(nullptr, 0, true,
  8295. [&](const char *data, size_t data_len) {
  8296. payload.append(data, data_len);
  8297. return true;
  8298. })) {
  8299. ok = false;
  8300. return;
  8301. }
  8302. if (!payload.empty()) {
  8303. // Emit chunked response header and footer for each chunk
  8304. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  8305. if (!write_data(strm, chunk.data(), chunk.size())) {
  8306. ok = false;
  8307. return;
  8308. }
  8309. }
  8310. constexpr const char done_marker[] = "0\r\n";
  8311. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  8312. // Trailer
  8313. if (trailer) {
  8314. for (const auto &kv : *trailer) {
  8315. // Skip fields with invalid names or values to prevent response
  8316. // splitting via CR/LF injection, matching set_header().
  8317. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  8318. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  8319. if (!write_data(strm, field_line.data(), field_line.size())) {
  8320. ok = false;
  8321. }
  8322. }
  8323. }
  8324. constexpr const char crlf[] = "\r\n";
  8325. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  8326. };
  8327. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  8328. data_sink.done_with_trailer = [&](const Headers &trailer) {
  8329. done_with_trailer(&trailer);
  8330. };
  8331. while (data_available && !is_shutting_down()) {
  8332. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  8333. error = Error::Write;
  8334. return false;
  8335. } else if (!content_provider(offset, 0, data_sink)) {
  8336. error = Error::Canceled;
  8337. return false;
  8338. } else if (!ok) {
  8339. error = Error::Write;
  8340. return false;
  8341. }
  8342. }
  8343. if (data_available) { // exited due to is_shutting_down(), not done()
  8344. error = Error::Write;
  8345. return false;
  8346. }
  8347. error = Error::Success;
  8348. return true;
  8349. }
  8350. template <typename T, typename U>
  8351. inline bool write_content_chunked(Stream &strm,
  8352. const ContentProvider &content_provider,
  8353. const T &is_shutting_down, U &compressor) {
  8354. auto error = Error::Success;
  8355. return write_content_chunked(strm, content_provider, is_shutting_down,
  8356. compressor, error);
  8357. }
  8358. template <typename T>
  8359. inline bool redirect(T &cli, Request &req, Response &res,
  8360. const std::string &path, const std::string &location,
  8361. Error &error) {
  8362. Request new_req = req;
  8363. new_req.path = path;
  8364. new_req.params.clear();
  8365. new_req.redirect_count_ -= 1;
  8366. if (res.status == StatusCode::SeeOther_303 &&
  8367. (req.method != "GET" && req.method != "HEAD")) {
  8368. new_req.method = "GET";
  8369. new_req.body.clear();
  8370. new_req.headers.clear();
  8371. new_req.content_length_ = 0;
  8372. new_req.content_provider_ = nullptr;
  8373. new_req.is_chunked_content_provider_ = false;
  8374. }
  8375. Response new_res;
  8376. auto ret = cli.send(new_req, new_res, error);
  8377. if (ret) {
  8378. req = std::move(new_req);
  8379. res = std::move(new_res);
  8380. if (res.location.empty()) { res.location = location; }
  8381. }
  8382. return ret;
  8383. }
  8384. inline std::string params_to_query_str(const Params &params) {
  8385. std::string query;
  8386. for (auto it = params.begin(); it != params.end(); ++it) {
  8387. if (it != params.begin()) { query += '&'; }
  8388. query += encode_query_component(it->first);
  8389. query += '=';
  8390. query += encode_query_component(it->second);
  8391. }
  8392. return query;
  8393. }
  8394. // Splits one "key=value" span of a query string at its first '='. A span with
  8395. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  8396. // "?flag" keeps its name.
  8397. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  8398. std::string &val) {
  8399. divide(b, static_cast<std::size_t>(e - b), '=',
  8400. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  8401. std::size_t rhs_size) {
  8402. key.assign(lhs_data, lhs_size);
  8403. val.assign(rhs_data, rhs_size);
  8404. });
  8405. }
  8406. inline void parse_query_text(const char *data, std::size_t size,
  8407. Params &params) {
  8408. std::set<std::string> cache;
  8409. split(data, data + size, '&', [&](const char *b, const char *e) {
  8410. std::string kv(b, e);
  8411. if (cache.find(kv) != cache.end()) { return; }
  8412. cache.insert(std::move(kv));
  8413. std::string key;
  8414. std::string val;
  8415. divide_query_pair(b, e, key, val);
  8416. if (!key.empty()) {
  8417. params.emplace(decode_query_component(key), decode_query_component(val));
  8418. }
  8419. });
  8420. }
  8421. inline void parse_query_text(const std::string &s, Params &params) {
  8422. parse_query_text(s.data(), s.size(), params);
  8423. }
  8424. // Normalize a query string by decoding and re-encoding each key/value pair
  8425. // while preserving the original parameter order. This avoids double-encoding
  8426. // and ensures consistent encoding. It works on the raw string rather than
  8427. // parsing into Params and re-serializing, because that round trip cannot
  8428. // reproduce the input: params_to_query_str() always emits '=', so a bare
  8429. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  8430. // duplicated pairs.
  8431. inline std::string normalize_query_string(const std::string &query) {
  8432. std::string result;
  8433. split(query.data(), query.data() + query.size(), '&',
  8434. [&](const char *b, const char *e) {
  8435. std::string key;
  8436. std::string val;
  8437. divide_query_pair(b, e, key, val);
  8438. if (!key.empty()) {
  8439. auto dec_key = decode_query_component(key);
  8440. auto dec_val = decode_query_component(val);
  8441. if (!result.empty()) { result += '&'; }
  8442. result += encode_query_component(dec_key);
  8443. if (!val.empty() || std::find(b, e, '=') != e) {
  8444. result += '=';
  8445. result += encode_query_component(dec_val);
  8446. }
  8447. }
  8448. });
  8449. return result;
  8450. }
  8451. // The query of a client's path: what follows '?', up to the fragment.
  8452. inline std::string query_of(const std::string &path) {
  8453. auto fragment_pos = path.find('#');
  8454. auto query_pos = path.find('?');
  8455. return query_pos < fragment_pos
  8456. ? path.substr(query_pos + 1, fragment_pos - query_pos - 1)
  8457. : std::string();
  8458. }
  8459. // Build the request target that goes on the wire from a caller-supplied path.
  8460. // Shared by the buffered send path and the streaming API so that both put the
  8461. // same bytes in the request line for the same input.
  8462. inline std::string encode_request_target(const std::string &uri,
  8463. bool path_encode) {
  8464. // The fragment stays with the client (RFC 9110 §7.1).
  8465. auto target = uri.substr(0, uri.find('#'));
  8466. // `substr(0, npos)` yields the whole string, which is what the no-query
  8467. // case needs.
  8468. auto query_pos = target.find('?');
  8469. auto path_part = target.substr(0, query_pos);
  8470. std::string query_part;
  8471. if (query_pos != std::string::npos) {
  8472. query_part = target.substr(query_pos + 1);
  8473. }
  8474. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  8475. if (!query_part.empty()) {
  8476. // When path encoding is disabled the caller has supplied an already-encoded
  8477. // target and expects the exact bytes to be sent on the wire, so skip
  8478. // normalization for the query too. Normalizing would decode-then-re-encode
  8479. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  8480. // which a strict RFC 3986 server decodes back as `+`, not a space).
  8481. if (path_encode) {
  8482. auto normalized = normalize_query_string(query_part);
  8483. if (!normalized.empty()) {
  8484. result += '?';
  8485. result += normalized;
  8486. }
  8487. } else {
  8488. result += '?';
  8489. result += query_part;
  8490. }
  8491. }
  8492. return result;
  8493. }
  8494. inline bool parse_multipart_boundary(const std::string &content_type,
  8495. std::string &boundary) {
  8496. std::map<std::string, std::string> params;
  8497. extract_media_type(content_type, &params);
  8498. auto it = params.find("boundary");
  8499. if (it == params.end()) { return false; }
  8500. boundary = it->second;
  8501. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  8502. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  8503. // bytes costs a nearly full comparison at nearly every position: the
  8504. // boundary's length multiplies the worst-case cost of scanning a body.
  8505. return !boundary.empty() && boundary.size() <= 70;
  8506. }
  8507. inline void parse_disposition_params(const std::string &s, Params &params) {
  8508. std::set<std::string> cache;
  8509. split_unquoted(
  8510. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  8511. std::string kv(b, e);
  8512. if (cache.find(kv) != cache.end()) { return; }
  8513. cache.insert(kv);
  8514. std::string key;
  8515. std::string val;
  8516. divide_param_pair(b, e, key, val);
  8517. if (!key.empty()) {
  8518. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  8519. }
  8520. });
  8521. }
  8522. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8523. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  8524. #else
  8525. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  8526. #endif
  8527. auto is_valid = [](const std::string &str) {
  8528. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  8529. };
  8530. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  8531. const auto pos = static_cast<size_t>(6);
  8532. const auto len = static_cast<size_t>(s.size() - 6);
  8533. auto all_valid_ranges = true;
  8534. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  8535. if (!all_valid_ranges) { return; }
  8536. const auto it = std::find(b, e, '-');
  8537. if (it == e) {
  8538. all_valid_ranges = false;
  8539. return;
  8540. }
  8541. const auto lhs = std::string(b, it);
  8542. const auto rhs = std::string(it + 1, e);
  8543. if (!is_valid(lhs) || !is_valid(rhs)) {
  8544. all_valid_ranges = false;
  8545. return;
  8546. }
  8547. ssize_t first = -1;
  8548. if (!lhs.empty()) {
  8549. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  8550. // would turn the range into a suffix range.
  8551. auto res =
  8552. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  8553. if (res.ec != std::errc{}) {
  8554. all_valid_ranges = false;
  8555. return;
  8556. }
  8557. }
  8558. ssize_t last = -1;
  8559. if (!rhs.empty()) {
  8560. // An overflowing last-byte-pos is past any content length, so keeping
  8561. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  8562. ssize_t v;
  8563. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  8564. if (res.ec == std::errc{}) { last = v; }
  8565. }
  8566. if ((first == -1 && last == -1) ||
  8567. (first != -1 && last != -1 && first > last)) {
  8568. all_valid_ranges = false;
  8569. return;
  8570. }
  8571. ranges.emplace_back(first, last);
  8572. });
  8573. return all_valid_ranges && !ranges.empty();
  8574. }
  8575. return false;
  8576. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8577. }
  8578. #else
  8579. } catch (...) { return false; }
  8580. #endif
  8581. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  8582. inline std::string remove_quoted_strings(const std::string &s) {
  8583. std::string out;
  8584. auto in_quotes = false;
  8585. for (size_t i = 0; i < s.size(); i++) {
  8586. if (s[i] == '"') {
  8587. in_quotes = !in_quotes;
  8588. } else if (!in_quotes) {
  8589. out += s[i];
  8590. } else if (s[i] == '\\') {
  8591. i++;
  8592. }
  8593. }
  8594. return out;
  8595. }
  8596. inline bool parse_accept_header(const std::string &s,
  8597. std::vector<std::string> &content_types) {
  8598. // Parameter values are not used here, so a quoted-string is dropped rather
  8599. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  8600. if (s.find('"') != std::string::npos) {
  8601. return parse_accept_header(remove_quoted_strings(s), content_types);
  8602. }
  8603. content_types.clear();
  8604. // Empty string is considered valid (no preference)
  8605. if (s.empty()) { return true; }
  8606. struct AcceptEntry {
  8607. std::string media_type;
  8608. double quality;
  8609. int order;
  8610. };
  8611. std::vector<AcceptEntry> entries;
  8612. int order = 0;
  8613. bool has_invalid_entry = false;
  8614. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  8615. // has to parse and ignore empty list elements, so a leading, trailing or
  8616. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  8617. // split() skips them, and the header length limit bounds how many a sender
  8618. // can send, so ignoring all of them cannot be used as a denial-of-service
  8619. // vector.
  8620. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  8621. std::string entry(b, e);
  8622. entry = trim_copy(entry);
  8623. AcceptEntry accept_entry;
  8624. accept_entry.order = order++;
  8625. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  8626. accept_entry.media_type, accept_entry.quality)) {
  8627. has_invalid_entry = true;
  8628. return;
  8629. }
  8630. // Remove additional parameters from media type
  8631. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  8632. // Basic validation of media type format
  8633. if (accept_entry.media_type.empty()) {
  8634. has_invalid_entry = true;
  8635. return;
  8636. }
  8637. // Check for basic media type format (should contain '/' or be '*')
  8638. if (accept_entry.media_type != "*" &&
  8639. accept_entry.media_type.find('/') == std::string::npos) {
  8640. has_invalid_entry = true;
  8641. return;
  8642. }
  8643. entries.push_back(std::move(accept_entry));
  8644. });
  8645. // Return false if any invalid entry was found
  8646. if (has_invalid_entry) { return false; }
  8647. // Sort by quality (descending), then by original order (ascending)
  8648. std::sort(entries.begin(), entries.end(),
  8649. [](const AcceptEntry &a, const AcceptEntry &b) {
  8650. if (a.quality != b.quality) {
  8651. return a.quality > b.quality; // Higher quality first
  8652. }
  8653. return a.order < b.order; // Earlier order first for same quality
  8654. });
  8655. // Extract sorted media types
  8656. content_types.reserve(entries.size());
  8657. for (auto &entry : entries) {
  8658. content_types.push_back(std::move(entry.media_type));
  8659. }
  8660. return true;
  8661. }
  8662. class FormDataParser {
  8663. public:
  8664. FormDataParser() = default;
  8665. void set_boundary(std::string &&boundary) {
  8666. boundary_ = std::move(boundary);
  8667. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8668. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8669. }
  8670. bool is_valid() const { return is_valid_; }
  8671. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8672. const ContentReceiver &content_callback) {
  8673. // Once the close delimiter has been seen the rest of the body is epilogue
  8674. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8675. // spread across reads is not copied in only to be erased right away.
  8676. if (state_ == 5) { return true; }
  8677. buf_append(buf, n);
  8678. while (buf_size() > 0) {
  8679. switch (state_) {
  8680. case 0: { // Initial boundary
  8681. auto pos = buf_find(dash_boundary_crlf_);
  8682. if (pos == buf_size()) {
  8683. // Not found yet: keep only a possible partial boundary at the tail so
  8684. // that a body which never contains the boundary cannot grow the
  8685. // buffer (and get rescanned from the start) without bound.
  8686. auto keep = dash_boundary_crlf_.size() - 1;
  8687. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8688. return true;
  8689. }
  8690. buf_erase(pos + dash_boundary_crlf_.size());
  8691. state_ = 1;
  8692. break;
  8693. }
  8694. case 1: { // New entry
  8695. clear_file_info();
  8696. header_searched_ = 0;
  8697. state_ = 2;
  8698. break;
  8699. }
  8700. case 2: { // Headers
  8701. // Resume where the last call stopped looking, so that a line arriving
  8702. // a few bytes at a time is not searched from its start each time.
  8703. auto pos = buf_find(crlf_, header_searched_);
  8704. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8705. while (pos < buf_size()) {
  8706. // Empty line
  8707. if (pos == 0) {
  8708. if (!header_callback(file_)) {
  8709. is_valid_ = false;
  8710. return false;
  8711. }
  8712. buf_erase(crlf_.size());
  8713. state_ = 3;
  8714. break;
  8715. }
  8716. // Check header count limit
  8717. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8718. is_valid_ = false;
  8719. return false;
  8720. }
  8721. header_count_++;
  8722. const auto header = buf_head(pos);
  8723. if (!parse_header(header.data(), header.data() + header.size(),
  8724. [&](const std::string &, const std::string &) {})) {
  8725. is_valid_ = false;
  8726. return false;
  8727. }
  8728. // Parse and emplace space trimmed headers into a map
  8729. if (!parse_header(
  8730. header.data(), header.data() + header.size(),
  8731. [&](const std::string &key, const std::string &val) {
  8732. file_.headers.emplace(key, val);
  8733. })) {
  8734. is_valid_ = false;
  8735. return false;
  8736. }
  8737. constexpr const char header_content_type[] = "Content-Type:";
  8738. if (start_with_case_ignore(header, header_content_type)) {
  8739. file_.content_type =
  8740. trim_copy(header.substr(str_len(header_content_type)));
  8741. } else {
  8742. std::string disposition_params;
  8743. if (parse_content_disposition(header, disposition_params)) {
  8744. Params params;
  8745. parse_disposition_params(disposition_params, params);
  8746. auto it = params.find("name");
  8747. if (it != params.end()) {
  8748. file_.name = it->second;
  8749. } else {
  8750. is_valid_ = false;
  8751. return false;
  8752. }
  8753. it = params.find("filename");
  8754. if (it != params.end()) { file_.filename = it->second; }
  8755. it = params.find("filename*");
  8756. if (it != params.end()) {
  8757. // RFC 5987: only UTF-8 encoding is allowed
  8758. const auto &val = it->second;
  8759. constexpr const char utf8_prefix[] = "UTF-8''";
  8760. constexpr size_t prefix_len = str_len(utf8_prefix);
  8761. if (val.size() > prefix_len &&
  8762. start_with_case_ignore(val, utf8_prefix)) {
  8763. file_.filename = decode_path_component(
  8764. val.substr(prefix_len)); // override...
  8765. } else {
  8766. is_valid_ = false;
  8767. return false;
  8768. }
  8769. }
  8770. }
  8771. }
  8772. buf_erase(pos + crlf_.size());
  8773. pos = buf_find(crlf_);
  8774. }
  8775. if (state_ != 3) {
  8776. // The CR of the CRLF may be the last byte so far.
  8777. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8778. return true;
  8779. }
  8780. break;
  8781. }
  8782. case 3: { // Body
  8783. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8784. auto pos = buf_find(crlf_dash_boundary_);
  8785. if (pos < buf_size()) {
  8786. if (!content_callback(buf_data(), pos)) {
  8787. is_valid_ = false;
  8788. return false;
  8789. }
  8790. buf_erase(pos + crlf_dash_boundary_.size());
  8791. state_ = 4;
  8792. } else {
  8793. auto len = buf_size() - crlf_dash_boundary_.size();
  8794. if (len > 0) {
  8795. if (!content_callback(buf_data(), len)) {
  8796. is_valid_ = false;
  8797. return false;
  8798. }
  8799. buf_erase(len);
  8800. }
  8801. return true;
  8802. }
  8803. break;
  8804. }
  8805. case 4: { // Boundary
  8806. if (crlf_.size() > buf_size()) { return true; }
  8807. if (buf_start_with(crlf_)) {
  8808. buf_erase(crlf_.size());
  8809. state_ = 1;
  8810. } else if (buf_start_with(dash_)) {
  8811. buf_erase(dash_.size());
  8812. is_valid_ = true;
  8813. state_ = 5;
  8814. } else {
  8815. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8816. // accepted after a boundary; RFC 2046 allows transport-padding in
  8817. // between, but this parser has never supported it. Either way the
  8818. // body is already destined to be rejected, so fail now instead of
  8819. // buffering the rest of it. Both are two bytes, so the check above
  8820. // already guarantees enough buffered data to decide.
  8821. is_valid_ = false;
  8822. return false;
  8823. }
  8824. break;
  8825. }
  8826. case 5: { // Epilogue
  8827. buf_erase(buf_size());
  8828. break;
  8829. }
  8830. }
  8831. }
  8832. return true;
  8833. }
  8834. private:
  8835. void clear_file_info() {
  8836. file_.name.clear();
  8837. file_.filename.clear();
  8838. file_.content_type.clear();
  8839. file_.headers.clear();
  8840. header_count_ = 0;
  8841. }
  8842. bool start_with_case_ignore(const std::string &a, const char *b,
  8843. size_t offset = 0) const {
  8844. const auto b_len = strlen(b);
  8845. if (a.size() < offset + b_len) { return false; }
  8846. for (size_t i = 0; i < b_len; i++) {
  8847. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8848. return false;
  8849. }
  8850. }
  8851. return true;
  8852. }
  8853. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8854. // Returns true if header matches, with the params portion in `params_out`.
  8855. bool parse_content_disposition(const std::string &header,
  8856. std::string &params_out) const {
  8857. constexpr const char prefix[] = "Content-Disposition:";
  8858. constexpr size_t prefix_len = str_len(prefix);
  8859. if (!start_with_case_ignore(header, prefix)) { return false; }
  8860. // Skip whitespace after "Content-Disposition:"
  8861. auto pos = prefix_len;
  8862. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8863. pos++;
  8864. }
  8865. // Match "form-data;" (case-insensitive)
  8866. constexpr const char form_data[] = "form-data;";
  8867. constexpr size_t form_data_len = str_len(form_data);
  8868. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8869. pos += form_data_len;
  8870. // Skip whitespace after "form-data;"
  8871. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8872. pos++;
  8873. }
  8874. params_out = header.substr(pos);
  8875. return true;
  8876. }
  8877. const std::string dash_ = "--";
  8878. const std::string crlf_ = "\r\n";
  8879. std::string boundary_;
  8880. std::string dash_boundary_crlf_;
  8881. std::string crlf_dash_boundary_;
  8882. size_t state_ = 0;
  8883. bool is_valid_ = false;
  8884. FormData file_;
  8885. size_t header_count_ = 0;
  8886. size_t header_searched_ = 0;
  8887. // Buffer
  8888. bool start_with(const std::string &a, size_t spos, size_t epos,
  8889. const std::string &b) const {
  8890. if (epos - spos < b.size()) { return false; }
  8891. for (size_t i = 0; i < b.size(); i++) {
  8892. if (a[i + spos] != b[i]) { return false; }
  8893. }
  8894. return true;
  8895. }
  8896. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8897. const char *buf_data() const { return &buf_[buf_spos_]; }
  8898. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8899. bool buf_start_with(const std::string &s) const {
  8900. return start_with(buf_, buf_spos_, buf_epos_, s);
  8901. }
  8902. size_t buf_find(const std::string &s, size_t from = 0) const {
  8903. auto c = s.front();
  8904. size_t off = buf_spos_ + from;
  8905. while (off < buf_epos_) {
  8906. auto pos = off;
  8907. while (true) {
  8908. if (pos == buf_epos_) { return buf_size(); }
  8909. if (buf_[pos] == c) { break; }
  8910. pos++;
  8911. }
  8912. auto remaining_size = buf_epos_ - pos;
  8913. if (s.size() > remaining_size) { return buf_size(); }
  8914. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8915. off = pos + 1;
  8916. }
  8917. return buf_size();
  8918. }
  8919. void buf_append(const char *data, size_t n) {
  8920. auto remaining_size = buf_size();
  8921. if (remaining_size > 0 && buf_spos_ > 0) {
  8922. for (size_t i = 0; i < remaining_size; i++) {
  8923. buf_[i] = buf_[buf_spos_ + i];
  8924. }
  8925. }
  8926. buf_spos_ = 0;
  8927. buf_epos_ = remaining_size;
  8928. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8929. for (size_t i = 0; i < n; i++) {
  8930. buf_[buf_epos_ + i] = data[i];
  8931. }
  8932. buf_epos_ += n;
  8933. }
  8934. void buf_erase(size_t size) { buf_spos_ += size; }
  8935. std::string buf_;
  8936. size_t buf_spos_ = 0;
  8937. size_t buf_epos_ = 0;
  8938. };
  8939. inline std::string random_string(size_t length) {
  8940. constexpr const char data[] =
  8941. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8942. std::string result(length, '\0');
  8943. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8944. for (auto &c : result) {
  8945. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8946. }
  8947. return result;
  8948. }
  8949. inline std::string make_multipart_data_boundary() {
  8950. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8951. }
  8952. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8953. auto valid = true;
  8954. for (size_t i = 0; i < boundary.size(); i++) {
  8955. auto c = boundary[i];
  8956. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8957. valid = false;
  8958. break;
  8959. }
  8960. }
  8961. return valid;
  8962. }
  8963. // Escape a multipart field name/filename following the WHATWG HTML standard
  8964. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  8965. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  8966. // With quoted = false, only CR and LF are escaped; this is for header values
  8967. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  8968. inline std::string escape_multipart_field(const std::string &s,
  8969. bool quoted = true) {
  8970. std::string result;
  8971. result.reserve(s.size());
  8972. for (auto c : s) {
  8973. switch (c) {
  8974. case '"':
  8975. if (quoted) {
  8976. result += "%22";
  8977. } else {
  8978. result += c;
  8979. }
  8980. break;
  8981. case '\\':
  8982. // A lone backslash would escape the character after it (RFC 9110
  8983. // 5.6.4).
  8984. if (quoted) { result += '\\'; }
  8985. result += c;
  8986. break;
  8987. case '\r': result += "%0D"; break;
  8988. case '\n': result += "%0A"; break;
  8989. default: result += c; break;
  8990. }
  8991. }
  8992. return result;
  8993. }
  8994. template <typename T>
  8995. inline std::string
  8996. serialize_multipart_formdata_item_begin(const T &item,
  8997. const std::string &boundary) {
  8998. std::string body = "--" + boundary + "\r\n";
  8999. body += "Content-Disposition: form-data; name=\"" +
  9000. escape_multipart_field(item.name) + "\"";
  9001. if (!item.filename.empty()) {
  9002. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  9003. }
  9004. body += "\r\n";
  9005. if (!item.content_type.empty()) {
  9006. body +=
  9007. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  9008. "\r\n";
  9009. }
  9010. body += "\r\n";
  9011. return body;
  9012. }
  9013. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  9014. inline std::string
  9015. serialize_multipart_formdata_finish(const std::string &boundary) {
  9016. return "--" + boundary + "--\r\n";
  9017. }
  9018. inline std::string
  9019. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  9020. return "multipart/form-data; boundary=" + boundary;
  9021. }
  9022. inline std::string
  9023. serialize_multipart_formdata(const UploadFormDataItems &items,
  9024. const std::string &boundary, bool finish = true) {
  9025. std::string body;
  9026. for (const auto &item : items) {
  9027. body += serialize_multipart_formdata_item_begin(item, boundary);
  9028. body += item.content + serialize_multipart_formdata_item_end();
  9029. }
  9030. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  9031. return body;
  9032. }
  9033. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  9034. const std::string &boundary) {
  9035. size_t total = 0;
  9036. for (const auto &item : items) {
  9037. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  9038. total += item.content.size();
  9039. total += serialize_multipart_formdata_item_end().size();
  9040. }
  9041. total += serialize_multipart_formdata_finish(boundary).size();
  9042. return total;
  9043. }
  9044. struct MultipartSegment {
  9045. const char *data;
  9046. size_t size;
  9047. };
  9048. // NOTE: items must outlive the returned ContentProvider
  9049. // (safe for synchronous use inside Post/Put/Patch)
  9050. inline ContentProvider
  9051. make_multipart_content_provider(const UploadFormDataItems &items,
  9052. const std::string &boundary) {
  9053. // Own the per-item header strings and the finish string
  9054. std::vector<std::string> owned;
  9055. owned.reserve(items.size() + 1);
  9056. for (const auto &item : items)
  9057. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  9058. owned.push_back(serialize_multipart_formdata_finish(boundary));
  9059. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  9060. std::vector<MultipartSegment> segs;
  9061. segs.reserve(items.size() * 3 + 1);
  9062. static const char crlf[] = "\r\n";
  9063. for (size_t i = 0; i < items.size(); i++) {
  9064. segs.push_back({owned[i].data(), owned[i].size()});
  9065. segs.push_back({items[i].content.data(), items[i].content.size()});
  9066. segs.push_back({crlf, 2});
  9067. }
  9068. segs.push_back({owned.back().data(), owned.back().size()});
  9069. struct MultipartState {
  9070. std::vector<std::string> owned;
  9071. std::vector<MultipartSegment> segs;
  9072. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  9073. };
  9074. auto state = std::make_shared<MultipartState>();
  9075. state->owned = std::move(owned);
  9076. // `segs` holds raw pointers into owned strings; std::string move preserves
  9077. // the data pointer, so these pointers remain valid after the move above.
  9078. state->segs = std::move(segs);
  9079. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  9080. // Buffer multiple small segments into fewer, larger writes to avoid
  9081. // excessive TCP packets when there are many form data items (#2410)
  9082. auto &buf = state->buf;
  9083. auto buf_size = buf.size();
  9084. size_t buf_len = 0;
  9085. size_t remaining = length;
  9086. // Find the first segment containing 'offset'
  9087. size_t pos = 0;
  9088. size_t seg_idx = 0;
  9089. for (; seg_idx < state->segs.size(); seg_idx++) {
  9090. const auto &seg = state->segs[seg_idx];
  9091. if (seg.size > 0 && offset - pos < seg.size) { break; }
  9092. pos += seg.size;
  9093. }
  9094. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  9095. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  9096. const auto &seg = state->segs[seg_idx];
  9097. size_t available = seg.size - seg_offset;
  9098. size_t to_copy = (std::min)(available, remaining);
  9099. const char *src = seg.data + seg_offset;
  9100. seg_offset = 0; // only the first segment has a non-zero offset
  9101. while (to_copy > 0) {
  9102. size_t space = buf_size - buf_len;
  9103. size_t chunk = (std::min)(to_copy, space);
  9104. std::memcpy(buf.data() + buf_len, src, chunk);
  9105. buf_len += chunk;
  9106. src += chunk;
  9107. to_copy -= chunk;
  9108. remaining -= chunk;
  9109. if (buf_len == buf_size) {
  9110. if (!sink.write(buf.data(), buf_len)) { return false; }
  9111. buf_len = 0;
  9112. }
  9113. }
  9114. }
  9115. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  9116. return true;
  9117. };
  9118. }
  9119. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  9120. if (ranges.size() <= 1) return;
  9121. // Sort ranges by start position
  9122. std::sort(ranges.begin(), ranges.end(),
  9123. [](const Range &a, const Range &b) { return a.first < b.first; });
  9124. Ranges coalesced;
  9125. coalesced.reserve(ranges.size());
  9126. for (auto &r : ranges) {
  9127. auto first_pos = r.first;
  9128. auto last_pos = r.second;
  9129. // Handle special cases like in range_error
  9130. if (first_pos == -1 && last_pos == -1) {
  9131. first_pos = 0;
  9132. last_pos = static_cast<ssize_t>(content_length);
  9133. }
  9134. if (first_pos == -1) {
  9135. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  9136. last_pos = static_cast<ssize_t>(content_length) - 1;
  9137. }
  9138. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  9139. last_pos = static_cast<ssize_t>(content_length) - 1;
  9140. }
  9141. // Skip invalid ranges
  9142. if (!(0 <= first_pos && first_pos <= last_pos &&
  9143. last_pos < static_cast<ssize_t>(content_length))) {
  9144. continue;
  9145. }
  9146. // Coalesce with previous range if overlapping or adjacent (but not
  9147. // identical)
  9148. if (!coalesced.empty()) {
  9149. auto &prev = coalesced.back();
  9150. // Check if current range overlaps or is adjacent to previous range
  9151. // but don't coalesce identical ranges (allow duplicates)
  9152. if (first_pos <= prev.second + 1 &&
  9153. !(first_pos == prev.first && last_pos == prev.second)) {
  9154. // Extend the previous range
  9155. prev.second = (std::max)(prev.second, last_pos);
  9156. continue;
  9157. }
  9158. }
  9159. // Add new range
  9160. coalesced.emplace_back(first_pos, last_pos);
  9161. }
  9162. ranges = std::move(coalesced);
  9163. }
  9164. inline bool range_error(Request &req, Response &res) {
  9165. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  9166. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  9167. req.ranges.clear();
  9168. if (res.status == StatusCode::PartialContent_206) {
  9169. res.status = StatusCode::OK_200;
  9170. }
  9171. return false;
  9172. }
  9173. ssize_t content_len = static_cast<ssize_t>(
  9174. res.content_length_ ? res.content_length_ : res.body.size());
  9175. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  9176. size_t overwrapping_count = 0;
  9177. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  9178. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  9179. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  9180. // Too many ranges
  9181. if (CPPHTTPLIB_RANGE_MAX_COUNT > 0 &&
  9182. req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) {
  9183. return true;
  9184. }
  9185. for (auto &r : req.ranges) {
  9186. auto &first_pos = r.first;
  9187. auto &last_pos = r.second;
  9188. if (first_pos == -1 && last_pos == -1) {
  9189. first_pos = 0;
  9190. last_pos = content_len;
  9191. }
  9192. // RFC 9110 14.1.2: a suffix-length longer than the representation
  9193. // selects the entire representation.
  9194. if (first_pos == -1) {
  9195. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  9196. last_pos = content_len - 1;
  9197. }
  9198. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  9199. // A client can limit the number of bytes requested without knowing the
  9200. // size of the selected representation. If the last-pos value is absent,
  9201. // or if the value is greater than or equal to the current length of the
  9202. // representation data, the byte range is interpreted as the remainder of
  9203. // the representation (i.e., the server replaces the value of last-pos
  9204. // with a value that is one less than the current length of the selected
  9205. // representation).
  9206. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  9207. if (last_pos == -1 || last_pos >= content_len) {
  9208. last_pos = content_len - 1;
  9209. }
  9210. // Range must be within content length
  9211. if (!(0 <= first_pos && first_pos <= last_pos &&
  9212. last_pos <= content_len - 1)) {
  9213. return true;
  9214. }
  9215. // Request must not have more than two overlapping ranges
  9216. for (const auto &processed_range : processed_ranges) {
  9217. if (!(last_pos < processed_range.first ||
  9218. first_pos > processed_range.second)) {
  9219. overwrapping_count++;
  9220. if (overwrapping_count > 2) { return true; }
  9221. break; // Only count once per range
  9222. }
  9223. }
  9224. processed_ranges.emplace_back(first_pos, last_pos);
  9225. }
  9226. // After validation, coalesce overlapping ranges as per RFC 9110
  9227. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  9228. }
  9229. return false;
  9230. }
  9231. inline std::pair<size_t, size_t>
  9232. get_range_offset_and_length(Range r, size_t content_length) {
  9233. assert(r.first != -1 && r.second != -1);
  9234. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  9235. assert(r.first <= r.second &&
  9236. r.second < static_cast<ssize_t>(content_length));
  9237. (void)(content_length);
  9238. return std::make_pair(static_cast<size_t>(r.first),
  9239. static_cast<size_t>(r.second - r.first) + 1);
  9240. }
  9241. inline std::string make_content_range_header_field(
  9242. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  9243. auto st = offset_and_length.first;
  9244. auto ed = st + offset_and_length.second - 1;
  9245. std::string field = "bytes ";
  9246. field += std::to_string(st);
  9247. field += '-';
  9248. field += std::to_string(ed);
  9249. field += '/';
  9250. field += std::to_string(content_length);
  9251. return field;
  9252. }
  9253. template <typename SToken, typename CToken, typename Content>
  9254. bool process_multipart_ranges_data(const Request &req,
  9255. const std::string &boundary,
  9256. const std::string &content_type,
  9257. size_t content_length, SToken stoken,
  9258. CToken ctoken, Content content) {
  9259. for (size_t i = 0; i < req.ranges.size(); i++) {
  9260. ctoken("--");
  9261. stoken(boundary);
  9262. ctoken("\r\n");
  9263. if (!content_type.empty()) {
  9264. ctoken("Content-Type: ");
  9265. stoken(content_type);
  9266. ctoken("\r\n");
  9267. }
  9268. auto offset_and_length =
  9269. get_range_offset_and_length(req.ranges[i], content_length);
  9270. ctoken("Content-Range: ");
  9271. stoken(make_content_range_header_field(offset_and_length, content_length));
  9272. ctoken("\r\n");
  9273. ctoken("\r\n");
  9274. if (!content(offset_and_length.first, offset_and_length.second)) {
  9275. return false;
  9276. }
  9277. ctoken("\r\n");
  9278. }
  9279. ctoken("--");
  9280. stoken(boundary);
  9281. ctoken("--");
  9282. return true;
  9283. }
  9284. inline void make_multipart_ranges_data(const Request &req, Response &res,
  9285. const std::string &boundary,
  9286. const std::string &content_type,
  9287. size_t content_length,
  9288. std::string &data) {
  9289. process_multipart_ranges_data(
  9290. req, boundary, content_type, content_length,
  9291. [&](const std::string &token) { data += token; },
  9292. [&](const std::string &token) { data += token; },
  9293. [&](size_t offset, size_t length) {
  9294. assert(offset + length <= content_length);
  9295. data += res.body.substr(offset, length);
  9296. return true;
  9297. });
  9298. }
  9299. inline size_t get_multipart_ranges_data_length(const Request &req,
  9300. const std::string &boundary,
  9301. const std::string &content_type,
  9302. size_t content_length) {
  9303. size_t data_length = 0;
  9304. process_multipart_ranges_data(
  9305. req, boundary, content_type, content_length,
  9306. [&](const std::string &token) { data_length += token.size(); },
  9307. [&](const std::string &token) { data_length += token.size(); },
  9308. [&](size_t /*offset*/, size_t length) {
  9309. data_length += length;
  9310. return true;
  9311. });
  9312. return data_length;
  9313. }
  9314. template <typename T>
  9315. inline bool
  9316. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  9317. const std::string &boundary,
  9318. const std::string &content_type,
  9319. size_t content_length, const T &is_shutting_down) {
  9320. return process_multipart_ranges_data(
  9321. req, boundary, content_type, content_length,
  9322. [&](const std::string &token) { strm.write(token); },
  9323. [&](const std::string &token) { strm.write(token); },
  9324. [&](size_t offset, size_t length) {
  9325. return write_content(strm, res.content_provider_, offset, length,
  9326. is_shutting_down);
  9327. });
  9328. }
  9329. inline bool has_framed_body(const Request &req) {
  9330. return is_chunked_transfer_encoding(req.headers) ||
  9331. req.get_header_value_u64("Content-Length") > 0;
  9332. }
  9333. inline bool expect_content(const Request &req) {
  9334. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  9335. req.method == "DELETE") {
  9336. return true;
  9337. }
  9338. return has_framed_body(req);
  9339. }
  9340. #ifdef _WIN32
  9341. class WSInit {
  9342. public:
  9343. WSInit() {
  9344. WSADATA wsaData;
  9345. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  9346. }
  9347. ~WSInit() {
  9348. if (is_valid_) WSACleanup();
  9349. }
  9350. bool is_valid_ = false;
  9351. };
  9352. static WSInit wsinit_;
  9353. #endif
  9354. inline std::string unescape_quoted_pairs(const std::string &s) {
  9355. std::string out;
  9356. out.reserve(s.size());
  9357. for (size_t i = 0; i < s.size(); i++) {
  9358. if (s[i] == '\\' && i + 1 < s.size()) {
  9359. out += s[++i];
  9360. } else {
  9361. out += s[i];
  9362. }
  9363. }
  9364. return out;
  9365. }
  9366. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  9367. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  9368. // quoted-pair, so the recipient recovers the original value.
  9369. inline std::string escape_quoted_pairs(const std::string &s) {
  9370. std::string out;
  9371. out.reserve(s.size());
  9372. for (auto c : s) {
  9373. if (c == '\\' || c == '"') { out += '\\'; }
  9374. out += c;
  9375. }
  9376. return out;
  9377. }
  9378. // RFC 9110 Section 11.6.1 defines a challenge list as
  9379. // WWW-Authenticate = #challenge
  9380. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  9381. // auth-param = token BWS "=" BWS ( token / quoted-string )
  9382. // so a server may offer several schemes, each with its own comma-separated
  9383. // auth-param list, in either order and either as separate field lines or
  9384. // packed into one. Splitting on every comma would break apart a challenge's
  9385. // own param list; splitting only on the first space would miss a Digest
  9386. // challenge that isn't first. Split on commas that aren't inside a
  9387. // quoted-string instead (split_unquoted), then track which scheme each
  9388. // resulting segment belongs to: a segment whose text before "=" contains
  9389. // whitespace (or that has no "=" at all) starts a new challenge named by its
  9390. // leading token.
  9391. inline bool parse_www_authenticate(const Response &res,
  9392. std::map<std::string, std::string> &auth,
  9393. bool is_proxy) {
  9394. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  9395. auto combined = get_combined_header_value(res.headers, auth_key);
  9396. if (combined.empty()) { return false; }
  9397. auto found_digest = false;
  9398. auto in_digest_challenge = false;
  9399. split_unquoted(
  9400. combined.data(), combined.data() + combined.size(), ',',
  9401. [&](const char *b, const char *e) {
  9402. std::string segment(b, e);
  9403. auto eq_pos = segment.find('=');
  9404. // BWS is allowed on both sides of "=", so the text naming the key (or,
  9405. // for the first segment of a challenge, "<scheme> <key>") must be
  9406. // trimmed before its boundaries are inspected.
  9407. auto key_part = trim_copy(
  9408. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  9409. auto space_pos = key_part.find_last_of(" \t");
  9410. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  9411. // "<scheme>[ <key>]" starts a new challenge.
  9412. auto scheme_end =
  9413. space_pos == std::string::npos ? key_part.size() : space_pos;
  9414. // RFC 7616 Section 3.7: a server may offer more than one Digest
  9415. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  9416. // from one challenge is never paired with another's algorithm.
  9417. in_digest_challenge =
  9418. !found_digest &&
  9419. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  9420. if (in_digest_challenge) { found_digest = true; }
  9421. if (space_pos == std::string::npos) {
  9422. // Bare scheme (or a token68), no auth-param on this segment.
  9423. return;
  9424. }
  9425. key_part = key_part.substr(space_pos + 1);
  9426. }
  9427. if (!in_digest_challenge) { return; }
  9428. auto val = trim_copy(segment.substr(eq_pos + 1));
  9429. auto unquoted = trim_double_quotes_copy(val);
  9430. if (unquoted.size() != val.size()) {
  9431. unquoted = unescape_quoted_pairs(unquoted);
  9432. }
  9433. auth[std::move(key_part)] = std::move(unquoted);
  9434. });
  9435. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  9436. // make_digest_authentication_header() dereferences both unconditionally, so
  9437. // a challenge missing either can't produce a usable Authorization header.
  9438. // Treat it the same as no Digest challenge at all.
  9439. return found_digest && auth.find("realm") != auth.end() &&
  9440. auth.find("nonce") != auth.end();
  9441. }
  9442. class ContentProviderAdapter {
  9443. public:
  9444. explicit ContentProviderAdapter(
  9445. ContentProviderWithoutLength &&content_provider)
  9446. : content_provider_(std::move(content_provider)) {}
  9447. bool operator()(size_t offset, size_t, DataSink &sink) {
  9448. return content_provider_(offset, sink);
  9449. }
  9450. private:
  9451. ContentProviderWithoutLength content_provider_;
  9452. };
  9453. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  9454. namespace fields {
  9455. inline bool is_token_char(char c) {
  9456. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  9457. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  9458. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  9459. }
  9460. inline bool is_token(const std::string &s) {
  9461. if (s.empty()) { return false; }
  9462. for (auto c : s) {
  9463. if (!is_token_char(c)) { return false; }
  9464. }
  9465. return true;
  9466. }
  9467. inline bool is_field_name(const std::string &s) { return is_token(s); }
  9468. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  9469. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  9470. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  9471. inline bool is_field_content(const std::string &s) {
  9472. if (s.empty()) { return true; }
  9473. if (s.size() == 1) {
  9474. return is_field_vchar(s[0]);
  9475. } else if (s.size() == 2) {
  9476. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  9477. } else {
  9478. size_t i = 0;
  9479. if (!is_field_vchar(s[i])) { return false; }
  9480. i++;
  9481. while (i < s.size() - 1) {
  9482. auto c = s[i++];
  9483. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  9484. } else {
  9485. return false;
  9486. }
  9487. }
  9488. return is_field_vchar(s[i]);
  9489. }
  9490. }
  9491. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  9492. inline bool is_field_valid(const std::string &name, const std::string &value) {
  9493. return is_field_name(name) && is_field_value(value);
  9494. }
  9495. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  9496. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  9497. inline bool is_request_target(const std::string &s) {
  9498. return std::all_of(s.begin(), s.end(), is_field_vchar);
  9499. }
  9500. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  9501. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  9502. inline bool is_host(const std::string &s) {
  9503. return std::all_of(s.begin(), s.end(), [](char c) {
  9504. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  9505. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9506. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9507. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  9508. });
  9509. }
  9510. } // namespace fields
  9511. // Built in memory first, like ClientImpl::write_request, so a rejected header
  9512. // never leaves a partial request on the wire.
  9513. inline bool write_request_head(Stream &strm, Request &req, Error &error) {
  9514. BufferStream bstrm;
  9515. if (write_request_line(bstrm, req.method, req.path) < 0) {
  9516. error = Error::Write;
  9517. return false;
  9518. }
  9519. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  9520. return false;
  9521. }
  9522. const auto &data = bstrm.get_buffer();
  9523. if (!write_data(strm, data.data(), data.size())) {
  9524. error = Error::Write;
  9525. return false;
  9526. }
  9527. return true;
  9528. }
  9529. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  9530. WebSocketUpgradeResponse &upgrade) {
  9531. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  9532. std::string key_bytes(16, '\0');
  9533. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  9534. key_bytes.size());
  9535. auto client_key = base64_encode(key_bytes);
  9536. req.headers.erase("Upgrade");
  9537. req.headers.erase("Connection");
  9538. req.headers.erase("Sec-WebSocket-Key");
  9539. req.headers.erase("Sec-WebSocket-Version");
  9540. req.headers.emplace("Upgrade", "websocket");
  9541. req.headers.emplace("Connection", "Upgrade");
  9542. req.headers.emplace("Sec-WebSocket-Key", client_key);
  9543. req.headers.emplace("Sec-WebSocket-Version", "13");
  9544. if (!write_request_head(strm, req, upgrade.error)) { return false; }
  9545. // Verify 101 response and Sec-WebSocket-Accept header
  9546. auto expected_accept = websocket_accept_key(client_key);
  9547. auto offered_subprotocols =
  9548. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  9549. return read_websocket_upgrade_response(strm, expected_accept,
  9550. offered_subprotocols, upgrade);
  9551. }
  9552. inline bool is_ip_address(const std::string &host) {
  9553. struct in_addr addr4;
  9554. struct in6_addr addr6;
  9555. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  9556. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  9557. }
  9558. // One spelling for an IPv6 address, and the IPv4 one for an IPv4-mapped IPv6
  9559. // address, which is how a dual-stack socket reports an IPv4 peer. Anything
  9560. // else, including an address with a zone ID, is returned as it is.
  9561. inline std::string canonical_ip(const std::string &addr) {
  9562. struct in6_addr addr6;
  9563. if (addr.find('%') != std::string::npos ||
  9564. inet_pton(AF_INET6, addr.c_str(), &addr6) != 1) {
  9565. return addr;
  9566. }
  9567. char buf[INET6_ADDRSTRLEN];
  9568. if (IN6_IS_ADDR_V4MAPPED(&addr6)) {
  9569. return inet_ntop(AF_INET, &addr6.s6_addr[12], buf, sizeof(buf)) ? buf
  9570. : addr;
  9571. }
  9572. return inet_ntop(AF_INET6, &addr6, buf, sizeof(buf)) ? buf : addr;
  9573. }
  9574. // `trusted_proxies` holds canonical_ip() spellings.
  9575. inline bool is_trusted_proxy(const std::string &addr,
  9576. const std::vector<std::string> &trusted_proxies) {
  9577. if (trusted_proxies.empty()) { return false; }
  9578. return std::find(trusted_proxies.begin(), trusted_proxies.end(),
  9579. canonical_ip(addr)) != trusted_proxies.end();
  9580. }
  9581. // Resolve where a client should connect for `host`, honoring a user-supplied
  9582. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  9583. // supplying the Host header and SNI; only the connection target changes.
  9584. //
  9585. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  9586. // path. Anything else goes to `connect_host`, which create_socket resolves as
  9587. // a name, or uses as the socket path when the address family is AF_UNIX. An
  9588. // absent or empty mapping leaves `host` as the connection target; without the
  9589. // empty check the value would reach getaddrinfo as a null node and silently
  9590. // resolve to loopback.
  9591. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  9592. const std::string &host, std::string &connect_host,
  9593. std::string &ip) {
  9594. connect_host = host;
  9595. ip.clear();
  9596. auto it = addr_map.find(host);
  9597. if (it == addr_map.end() || it->second.empty()) { return; }
  9598. if (is_ip_address(it->second)) {
  9599. ip = it->second;
  9600. } else {
  9601. connect_host = it->second;
  9602. }
  9603. }
  9604. } // namespace detail
  9605. /*
  9606. * Group 2: detail namespace - SSL common utilities
  9607. */
  9608. #ifdef CPPHTTPLIB_SSL_ENABLED
  9609. namespace detail {
  9610. class SSLSocketStream final : public Stream {
  9611. public:
  9612. SSLSocketStream(
  9613. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  9614. time_t read_timeout_usec, time_t write_timeout_sec,
  9615. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  9616. std::chrono::time_point<std::chrono::steady_clock> start_time =
  9617. (std::chrono::steady_clock::time_point::min)());
  9618. ~SSLSocketStream() override;
  9619. bool is_readable() const override;
  9620. bool wait_readable() const override;
  9621. bool wait_writable() const override;
  9622. bool is_peer_alive() const override;
  9623. ssize_t read(char *ptr, size_t size) override;
  9624. ssize_t write(const char *ptr, size_t size) override;
  9625. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9626. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9627. socket_t socket() const override;
  9628. time_t duration() const override;
  9629. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9630. void set_max_timeout(time_t msec) override;
  9631. void set_read_interrupt(std::function<bool()> interrupted) override;
  9632. // See SocketStream::set_readable_hint().
  9633. void set_readable_hint() { readable_hint_ = true; }
  9634. // The error from the last read() or write() that failed in the TLS layer,
  9635. // with code Success if none did
  9636. const tls::TlsError &tls_error() const { return tls_error_; }
  9637. private:
  9638. bool ensure_readable();
  9639. socket_t sock_;
  9640. tls::session_t session_;
  9641. time_t read_timeout_sec_;
  9642. time_t read_timeout_usec_;
  9643. time_t write_timeout_sec_;
  9644. time_t write_timeout_usec_;
  9645. time_t max_timeout_msec_;
  9646. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9647. std::function<bool()> read_interrupted_;
  9648. bool readable_hint_ = false;
  9649. tls::TlsError tls_error_;
  9650. };
  9651. // A TLS stream for WebSocket connections, where the receive path and the
  9652. // send path (application send() plus the heartbeat ping thread) run on
  9653. // different threads. A single TLS session must never be entered
  9654. // concurrently, so every call into the session is serialized by one mutex.
  9655. //
  9656. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  9657. // whole lifetime and each read()/write() performs a single non-blocking TLS
  9658. // call under the lock, then waits for readiness with select() outside the
  9659. // lock. The lock is therefore held only for CPU-bound work, so a reader
  9660. // blocked waiting for data never stalls a concurrent sender.
  9661. //
  9662. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  9663. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  9664. class WebSocketSSLStream final : public Stream {
  9665. public:
  9666. WebSocketSSLStream(socket_t sock, tls::session_t session,
  9667. time_t read_timeout_sec, time_t read_timeout_usec,
  9668. time_t write_timeout_sec, time_t write_timeout_usec);
  9669. ~WebSocketSSLStream() override;
  9670. bool is_readable() const override;
  9671. bool wait_readable() const override;
  9672. bool wait_writable() const override;
  9673. ssize_t read(char *ptr, size_t size) override;
  9674. ssize_t write(const char *ptr, size_t size) override;
  9675. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9676. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9677. socket_t socket() const override;
  9678. time_t duration() const override;
  9679. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9680. void set_max_timeout(time_t msec) override;
  9681. void set_read_interrupt(std::function<bool()> interrupted) override;
  9682. private:
  9683. mutable std::mutex session_mutex_;
  9684. socket_t sock_;
  9685. tls::session_t session_;
  9686. // May change while another thread is in wait_readable(); write timeouts don't
  9687. std::atomic<time_t> read_timeout_sec_;
  9688. std::atomic<time_t> read_timeout_usec_;
  9689. time_t write_timeout_sec_;
  9690. time_t write_timeout_usec_;
  9691. std::atomic<time_t> max_timeout_msec_{0};
  9692. std::atomic<std::chrono::steady_clock::rep> start_time_;
  9693. std::function<bool()> read_interrupted_;
  9694. };
  9695. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9696. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9697. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9698. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9699. unsigned int hash_length = 0;
  9700. unsigned char hash[EVP_MAX_MD_SIZE];
  9701. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9702. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9703. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9704. std::stringstream ss;
  9705. for (auto i = 0u; i < hash_length; ++i) {
  9706. ss << std::hex << std::setw(2) << std::setfill('0')
  9707. << static_cast<unsigned int>(hash[i]);
  9708. }
  9709. return ss.str();
  9710. }
  9711. inline std::string MD5(const std::string &s) {
  9712. return message_digest(s, EVP_md5());
  9713. }
  9714. inline std::string SHA_256(const std::string &s) {
  9715. return message_digest(s, EVP_sha256());
  9716. }
  9717. inline std::string SHA_512(const std::string &s) {
  9718. return message_digest(s, EVP_sha512());
  9719. }
  9720. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9721. namespace {
  9722. template <size_t N>
  9723. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9724. std::stringstream ss;
  9725. for (size_t i = 0; i < N; ++i) {
  9726. ss << std::hex << std::setw(2) << std::setfill('0')
  9727. << static_cast<unsigned int>(hash[i]);
  9728. }
  9729. return ss.str();
  9730. }
  9731. } // namespace
  9732. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9733. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9734. // initialized once. PSA state is process-global; do not free it.
  9735. inline bool ensure_mbedtls_psa_crypto() {
  9736. static std::once_flag once;
  9737. static bool ok = false;
  9738. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9739. return ok;
  9740. }
  9741. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9742. unsigned char *out, size_t out_size) {
  9743. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9744. size_t olen = 0;
  9745. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9746. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9747. olen == out_size;
  9748. }
  9749. #endif
  9750. inline std::string MD5(const std::string &s) {
  9751. unsigned char hash[16];
  9752. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9753. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9754. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9755. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9756. hash);
  9757. #else
  9758. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9759. hash);
  9760. #endif
  9761. return hash_to_hex(hash);
  9762. }
  9763. inline std::string SHA_256(const std::string &s) {
  9764. unsigned char hash[32];
  9765. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9766. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9767. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9768. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9769. hash, 0);
  9770. #else
  9771. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9772. s.size(), hash, 0);
  9773. #endif
  9774. return hash_to_hex(hash);
  9775. }
  9776. inline std::string SHA_512(const std::string &s) {
  9777. unsigned char hash[64];
  9778. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9779. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9780. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9781. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9782. hash, 0);
  9783. #else
  9784. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9785. s.size(), hash, 0);
  9786. #endif
  9787. return hash_to_hex(hash);
  9788. }
  9789. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9790. namespace {
  9791. template <size_t N>
  9792. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9793. std::stringstream ss;
  9794. for (size_t i = 0; i < N; ++i) {
  9795. ss << std::hex << std::setw(2) << std::setfill('0')
  9796. << static_cast<unsigned int>(hash[i]);
  9797. }
  9798. return ss.str();
  9799. }
  9800. } // namespace
  9801. inline std::string MD5(const std::string &s) {
  9802. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9803. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9804. static_cast<word32>(s.size()), hash);
  9805. return hash_to_hex(hash);
  9806. }
  9807. inline std::string SHA_256(const std::string &s) {
  9808. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9809. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9810. static_cast<word32>(s.size()), hash);
  9811. return hash_to_hex(hash);
  9812. }
  9813. inline std::string SHA_512(const std::string &s) {
  9814. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9815. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9816. static_cast<word32>(s.size()), hash);
  9817. return hash_to_hex(hash);
  9818. }
  9819. #endif
  9820. template <typename T>
  9821. inline bool process_server_socket_ssl(
  9822. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9823. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9824. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9825. time_t write_timeout_usec, T callback) {
  9826. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9827. // of a pipelined request, which keep_alive() cannot see on the socket.
  9828. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9829. write_timeout_sec, write_timeout_usec);
  9830. size_t served = 0;
  9831. return process_server_socket_core(
  9832. served, keep_alive_max_count,
  9833. [&]() { return keep_alive(svr_sock, sock, keep_alive_timeout_sec); },
  9834. [&]() { return strm.is_readable(); },
  9835. [&](bool socket_readable, bool close_connection,
  9836. bool &connection_closed) {
  9837. if (socket_readable) { strm.set_readable_hint(); }
  9838. return callback(strm, close_connection, connection_closed);
  9839. });
  9840. }
  9841. template <typename T>
  9842. inline bool process_client_socket_ssl(
  9843. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9844. time_t read_timeout_usec, time_t write_timeout_sec,
  9845. time_t write_timeout_usec, time_t max_timeout_msec,
  9846. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9847. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9848. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9849. start_time);
  9850. return callback(strm);
  9851. }
  9852. // `uri` is req's request-target in origin form, as curl sends it, also when
  9853. // the request line carries the absolute form for a proxy.
  9854. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9855. const Request &req, const std::string &uri,
  9856. const std::map<std::string, std::string> &auth, size_t cnonce_count,
  9857. const std::string &cnonce, const std::string &username,
  9858. const std::string &password, bool is_proxy = false) {
  9859. std::string nc;
  9860. {
  9861. std::stringstream ss;
  9862. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9863. nc = ss.str();
  9864. }
  9865. std::string qop;
  9866. if (auth.find("qop") != auth.end()) {
  9867. qop = auth.at("qop");
  9868. if (qop.find("auth-int") != std::string::npos) {
  9869. qop = "auth-int";
  9870. } else if (qop.find("auth") != std::string::npos) {
  9871. qop = "auth";
  9872. } else {
  9873. qop.clear();
  9874. }
  9875. }
  9876. std::string algo = "MD5";
  9877. if (auth.find("algorithm") != auth.end()) {
  9878. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9879. // not a token would otherwise be emitted verbatim and could carry commas
  9880. // or quotes that inject further auth-params into the header below.
  9881. const auto &a = auth.at("algorithm");
  9882. if (fields::is_token(a)) { algo = a; }
  9883. }
  9884. std::string response;
  9885. {
  9886. auto H = algo == "SHA-256" ? detail::SHA_256
  9887. : algo == "SHA-512" ? detail::SHA_512
  9888. : detail::MD5;
  9889. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9890. auto A2 = req.method + ":" + uri;
  9891. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9892. if (qop.empty()) {
  9893. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9894. } else {
  9895. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9896. ":" + qop + ":" + H(A2));
  9897. }
  9898. }
  9899. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9900. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9901. // close the string early. realm, nonce and opaque come straight from the
  9902. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9903. // without this a crafted challenge injects extra auth-params into the header.
  9904. auto field =
  9905. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9906. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9907. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9908. "\", uri=\"" + detail::escape_quoted_pairs(uri) +
  9909. "\", algorithm=" + algo +
  9910. (qop.empty() ? ", response=\""
  9911. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9912. "\", response=\"") +
  9913. response + "\"" +
  9914. (opaque.empty()
  9915. ? ""
  9916. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9917. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9918. return std::make_pair(key, field);
  9919. }
  9920. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9921. // backend accepts the same names.
  9922. inline bool match_hostname(const std::string &pattern,
  9923. const std::string &hostname) {
  9924. // A trailing dot on the host is ignored
  9925. auto host = hostname;
  9926. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9927. // Exact match (case-insensitive)
  9928. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9929. // Split both pattern and hostname into components by '.', keeping any empty
  9930. // one, which no name may have
  9931. auto labels = [](const std::string &s) {
  9932. std::vector<std::string> v;
  9933. size_t b = 0;
  9934. while (true) {
  9935. auto e = s.find('.', b);
  9936. v.push_back(s.substr(b, e - b));
  9937. if (e == std::string::npos) { return v; }
  9938. b = e + 1;
  9939. }
  9940. };
  9941. auto pattern_components = labels(pattern);
  9942. auto host_components = labels(host);
  9943. auto has_empty_label = [](const std::vector<std::string> &v) {
  9944. return std::any_of(v.begin(), v.end(),
  9945. [](const std::string &l) { return l.empty(); });
  9946. };
  9947. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9948. return false;
  9949. }
  9950. // Component count must match
  9951. if (host_components.size() != pattern_components.size()) { return false; }
  9952. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9953. // and an IDNA label may not have one
  9954. const auto &leftmost = pattern_components.front();
  9955. if (leftmost.find('*') != std::string::npos &&
  9956. (pattern_components.size() < 3 ||
  9957. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9958. return false;
  9959. }
  9960. // Compare each component with wildcard support
  9961. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9962. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9963. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9964. auto itr = pattern_components.begin();
  9965. for (const auto &h : host_components) {
  9966. auto &p = *itr;
  9967. auto is_leftmost = itr == pattern_components.begin();
  9968. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9969. bool partial_match = false;
  9970. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9971. const auto prefix_length = p.size() - 1;
  9972. if (prefix_length == 0) {
  9973. partial_match = true;
  9974. } else if (h.size() >= prefix_length) {
  9975. partial_match =
  9976. std::equal(p.begin(),
  9977. p.begin() + static_cast<std::string::difference_type>(
  9978. prefix_length),
  9979. h.begin(), [](const char ca, const char cb) {
  9980. return detail::case_ignore::to_lower(ca) ==
  9981. detail::case_ignore::to_lower(cb);
  9982. });
  9983. }
  9984. }
  9985. if (!partial_match) { return false; }
  9986. }
  9987. ++itr;
  9988. }
  9989. return true;
  9990. }
  9991. #ifdef _WIN32
  9992. // Verify certificate using Windows CertGetCertificateChain API.
  9993. // This provides real-time certificate validation with Windows Update
  9994. // integration, independent of the TLS backend.
  9995. inline bool verify_cert_with_windows_schannel(
  9996. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9997. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9998. if (der_cert.empty()) { return false; }
  9999. out_error = 0;
  10000. // Create Windows certificate context from DER data
  10001. auto cert_context = CertCreateCertificateContext(
  10002. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  10003. static_cast<DWORD>(der_cert.size()));
  10004. if (!cert_context) {
  10005. out_error = GetLastError();
  10006. return false;
  10007. }
  10008. auto cert_guard =
  10009. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  10010. // Give CryptoAPI the certificates the server sent. Without them it follows
  10011. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  10012. std::vector<tls::cert_t> peer_certs;
  10013. tls::get_peer_certs(session, peer_certs);
  10014. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  10015. auto store_guard = scope_exit([&] {
  10016. for (auto cert : peer_certs) {
  10017. tls::free_cert(cert);
  10018. }
  10019. if (store) { CertCloseStore(store, 0); }
  10020. });
  10021. for (auto cert : peer_certs) {
  10022. std::vector<unsigned char> der;
  10023. if (store && tls::get_cert_der(cert, der)) {
  10024. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  10025. static_cast<DWORD>(der.size()),
  10026. CERT_STORE_ADD_USE_EXISTING, nullptr);
  10027. }
  10028. }
  10029. // Setup chain parameters
  10030. CERT_CHAIN_PARA chain_para = {};
  10031. chain_para.cbSize = sizeof(chain_para);
  10032. // Require the server authentication usage along the chain, which also
  10033. // rejects roots that Windows trusts only for other purposes.
  10034. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  10035. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  10036. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  10037. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  10038. // Build certificate chain with revocation checking
  10039. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  10040. auto chain_result = CertGetCertificateChain(
  10041. nullptr, cert_context, nullptr, store, &chain_para,
  10042. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  10043. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  10044. nullptr, &chain_context);
  10045. if (!chain_result || !chain_context) {
  10046. out_error = GetLastError();
  10047. return false;
  10048. }
  10049. auto chain_guard =
  10050. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  10051. // Verify SSL policy
  10052. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  10053. extra_policy_para.cbSize = sizeof(extra_policy_para);
  10054. #ifdef AUTHTYPE_SERVER
  10055. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  10056. #endif
  10057. std::wstring whost;
  10058. if (verify_hostname) {
  10059. whost = u8string_to_wstring(hostname.c_str());
  10060. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  10061. }
  10062. CERT_CHAIN_POLICY_PARA policy_para = {};
  10063. policy_para.cbSize = sizeof(policy_para);
  10064. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  10065. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  10066. #else
  10067. policy_para.dwFlags = 0;
  10068. #endif
  10069. policy_para.pvExtraPolicyPara = &extra_policy_para;
  10070. CERT_CHAIN_POLICY_STATUS policy_status = {};
  10071. policy_status.cbSize = sizeof(policy_status);
  10072. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  10073. &policy_para, &policy_status)) {
  10074. out_error = GetLastError();
  10075. return false;
  10076. }
  10077. if (policy_status.dwError != 0) {
  10078. out_error = policy_status.dwError;
  10079. return false;
  10080. }
  10081. return true;
  10082. }
  10083. #endif // _WIN32
  10084. // Loads CA file/dir configuration and applies the system CA policy to a
  10085. // client TLS context. PEM data and native stores are applied to the context
  10086. // directly at set time; has_custom_store reflects them for the Auto policy
  10087. // decision.
  10088. inline bool load_client_ca_config(tls::ctx_t ctx,
  10089. const std::string &ca_cert_file_path,
  10090. const std::string &ca_cert_dir_path,
  10091. bool has_custom_store, SystemCAMode mode,
  10092. uint64_t &backend_error) {
  10093. auto ret = true;
  10094. if (!ca_cert_file_path.empty()) {
  10095. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  10096. backend_error = tls::get_error();
  10097. ret = false;
  10098. }
  10099. } else if (!ca_cert_dir_path.empty()) {
  10100. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  10101. backend_error = tls::get_error();
  10102. ret = false;
  10103. }
  10104. }
  10105. auto has_custom_ca = !ca_cert_file_path.empty() ||
  10106. !ca_cert_dir_path.empty() || has_custom_store;
  10107. if (mode == SystemCAMode::Enabled ||
  10108. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  10109. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  10110. }
  10111. return ret;
  10112. }
  10113. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  10114. // Schannel is skipped when a custom CA is specified, as the Windows
  10115. // certificate store would not know about it, and when system CA trust is
  10116. // explicitly disabled.
  10117. inline bool use_windows_cert_verification(bool enabled,
  10118. const std::string &ca_cert_file_path,
  10119. const std::string &ca_cert_dir_path,
  10120. bool has_custom_store,
  10121. SystemCAMode mode) {
  10122. return enabled && mode != SystemCAMode::Disabled &&
  10123. ca_cert_file_path.empty() && ca_cert_dir_path.empty() &&
  10124. !has_custom_store;
  10125. }
  10126. #endif
  10127. // Serializes the CA certificates installed in ctx as PEM, so they can be
  10128. // loaded into another context.
  10129. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  10130. std::string pem;
  10131. std::vector<tls::cert_t> certs;
  10132. tls::get_ca_certs(ctx, certs);
  10133. for (auto cert : certs) {
  10134. std::vector<unsigned char> der;
  10135. if (tls::get_cert_der(cert, der)) {
  10136. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  10137. pem += "-----BEGIN CERTIFICATE-----\n";
  10138. for (size_t i = 0; i < b64.size(); i += 64) {
  10139. pem += b64.substr(i, 64);
  10140. pem += '\n';
  10141. }
  10142. pem += "-----END CERTIFICATE-----\n";
  10143. }
  10144. tls::free_cert(cert);
  10145. }
  10146. return pem;
  10147. }
  10148. // Returns a PemMemory field as a NUL-terminated string: its first len bytes,
  10149. // copied to buf, or pem itself when len is 0.
  10150. inline const char *pem_c_str(const char *pem, size_t len, std::string &buf) {
  10151. if (!pem || len == 0) { return pem; }
  10152. buf.assign(pem, len);
  10153. return buf.c_str();
  10154. }
  10155. // The parts of session setup that only SSLClient needs, plus the handful
  10156. // WebSocketClient also exposes; everything else takes the defaults, which is
  10157. // what keeps the two clients on one implementation.
  10158. struct ClientTlsSessionOptions {
  10159. // Both SSLClient and WebSocketClient expose this independently of
  10160. // certificate verification.
  10161. bool server_hostname_verification = true;
  10162. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  10163. // When set, ends the handshake as a timeout does once it returns true
  10164. std::function<bool()> interrupted;
  10165. // When non-null, guards session creation against concurrent use of the
  10166. // context. A WebSocketClient is not safe to use from several threads to
  10167. // begin with, so it passes nothing.
  10168. std::mutex *ctx_mutex = nullptr;
  10169. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  10170. // See use_windows_cert_verification().
  10171. bool windows_cert_verification = false;
  10172. // A server certificate verifier works on the backend's chain verification,
  10173. // so the backend keeps deciding and Schannel only adds its own check.
  10174. bool server_certificate_verifier_set = false;
  10175. #endif
  10176. };
  10177. // Filled in on failure for callers that report error details.
  10178. struct ClientTlsSessionError {
  10179. Error error = Error::Success;
  10180. int ssl_error = 0;
  10181. uint64_t backend_error = 0;
  10182. };
  10183. // Establishes a client TLS session on an already connected socket. On failure
  10184. // the session is left for the caller to free: SSLClient frees it right away,
  10185. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  10186. inline bool setup_client_tls_session(
  10187. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  10188. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  10189. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  10190. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  10191. using namespace tls;
  10192. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  10193. if (out_error) {
  10194. out_error->error = error;
  10195. out_error->ssl_error = ssl_error;
  10196. out_error->backend_error = backend_error;
  10197. }
  10198. return false;
  10199. };
  10200. // A TLS failure, whose verification codes name the Error too
  10201. auto fail_tls = [&](ErrorCode code, uint64_t backend_error) {
  10202. auto error = Error::SSLConnection;
  10203. if (code == ErrorCode::CertVerifyFailed) {
  10204. error = Error::SSLServerVerification;
  10205. } else if (code == ErrorCode::HostnameMismatch) {
  10206. error = Error::SSLServerHostnameVerification;
  10207. }
  10208. return fail(error, static_cast<int>(code), backend_error);
  10209. };
  10210. if (!ctx) {
  10211. session = nullptr;
  10212. return fail(Error::SSLConnection, 0, 0);
  10213. }
  10214. // With Windows verification on and no server certificate verifier set,
  10215. // Schannel is the only chain verifier. The backend's trust store is a
  10216. // snapshot of the Windows stores that lacks the roots Windows fetches on
  10217. // demand, so the backend's verdict is not used.
  10218. auto windows_verifies_chain = false;
  10219. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  10220. windows_verifies_chain = options.windows_cert_verification &&
  10221. !options.server_certificate_verifier_set;
  10222. #endif
  10223. // The chain, and a host name, are verified during the handshake, so that a
  10224. // server failing them never gets to see a client certificate. Unless
  10225. // Schannel verifies the chain instead, this holds for IP hosts too, whose
  10226. // identity is checked after the handshake by verify_hostname().
  10227. auto verify_in_handshake =
  10228. server_certificate_verification && !windows_verifies_chain;
  10229. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10230. // A session verifier may accept a certificate the built-in check rejects,
  10231. // and runs only after the handshake
  10232. verify_in_handshake = verify_in_handshake && !options.session_verifier;
  10233. #endif
  10234. {
  10235. std::unique_lock<std::mutex> guard;
  10236. if (options.ctx_mutex) {
  10237. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  10238. }
  10239. // The mode is set on the context, so under the same lock
  10240. set_verify_client(ctx, verify_in_handshake);
  10241. session = create_session(ctx, sock);
  10242. }
  10243. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  10244. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  10245. // their identity is checked post-handshake below instead.
  10246. if (!is_ip_address(host)) {
  10247. if (!set_sni(session, host.c_str(),
  10248. verify_in_handshake && options.server_hostname_verification)) {
  10249. return fail(Error::SSLConnection, 0, get_error());
  10250. }
  10251. }
  10252. TlsError tls_err;
  10253. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec, &tls_err,
  10254. options.interrupted)) {
  10255. return fail_tls(tls_err.code, tls_err.backend_code);
  10256. }
  10257. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  10258. if (options.session_verifier) {
  10259. verification_status = options.session_verifier(session);
  10260. }
  10261. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  10262. return fail(Error::SSLServerVerification, 0, get_error());
  10263. }
  10264. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  10265. server_certificate_verification) {
  10266. if (!windows_verifies_chain) {
  10267. auto verify_result = get_verify_result(session);
  10268. if (verify_result != 0) {
  10269. return fail_tls(ErrorCode::CertVerifyFailed,
  10270. static_cast<uint64_t>(verify_result));
  10271. }
  10272. }
  10273. auto server_cert = get_peer_cert(session);
  10274. if (!server_cert) {
  10275. return fail_tls(ErrorCode::CertVerifyFailed, get_error());
  10276. }
  10277. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  10278. // Identity check against the peer certificate, post-handshake for all
  10279. // backends. For IP hosts this is the only identity verification, since no
  10280. // hostname is bound during the handshake.
  10281. if (options.server_hostname_verification) {
  10282. if (!verify_hostname(server_cert, host.c_str())) {
  10283. return fail_tls(ErrorCode::HostnameMismatch, hostname_mismatch_code());
  10284. }
  10285. }
  10286. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  10287. // Windows Schannel verification, which lets Windows fetch missing roots
  10288. // and intermediates on demand. It must not be skipped: unless a server
  10289. // certificate verifier is set, it is the only chain check.
  10290. if (options.windows_cert_verification) {
  10291. std::vector<unsigned char> der;
  10292. uint64_t wincrypt_error = 0;
  10293. if (!get_cert_der(server_cert, der) ||
  10294. !verify_cert_with_windows_schannel(
  10295. der, host, options.server_hostname_verification, wincrypt_error,
  10296. session)) {
  10297. return fail_tls(ErrorCode::CertVerifyFailed, wincrypt_error);
  10298. }
  10299. }
  10300. #endif
  10301. }
  10302. return true;
  10303. }
  10304. } // namespace detail
  10305. #endif // CPPHTTPLIB_SSL_ENABLED
  10306. /*
  10307. * Group 3: httplib namespace - Non-SSL public API implementations
  10308. */
  10309. inline void default_socket_options(socket_t sock) {
  10310. set_socket_opt(sock, SOL_SOCKET,
  10311. #ifdef SO_REUSEPORT
  10312. SO_REUSEPORT,
  10313. #else
  10314. SO_REUSEADDR,
  10315. #endif
  10316. 1);
  10317. }
  10318. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  10319. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  10320. sizeof(optval));
  10321. }
  10322. inline std::string get_bearer_token_auth(const Request &req) {
  10323. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  10324. // than the prefix carries no token.
  10325. constexpr const char bearer_prefix[] = "Bearer ";
  10326. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  10327. auto value = req.get_header_value("Authorization");
  10328. if (value.size() >= bearer_prefix_len &&
  10329. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  10330. bearer_prefix)) {
  10331. return value.substr(bearer_prefix_len);
  10332. }
  10333. return "";
  10334. }
  10335. inline const char *status_message(int status) {
  10336. switch (status) {
  10337. case StatusCode::Continue_100: return "Continue";
  10338. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  10339. case StatusCode::Processing_102: return "Processing";
  10340. case StatusCode::EarlyHints_103: return "Early Hints";
  10341. case StatusCode::OK_200: return "OK";
  10342. case StatusCode::Created_201: return "Created";
  10343. case StatusCode::Accepted_202: return "Accepted";
  10344. case StatusCode::NonAuthoritativeInformation_203:
  10345. return "Non-Authoritative Information";
  10346. case StatusCode::NoContent_204: return "No Content";
  10347. case StatusCode::ResetContent_205: return "Reset Content";
  10348. case StatusCode::PartialContent_206: return "Partial Content";
  10349. case StatusCode::MultiStatus_207: return "Multi-Status";
  10350. case StatusCode::AlreadyReported_208: return "Already Reported";
  10351. case StatusCode::IMUsed_226: return "IM Used";
  10352. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  10353. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  10354. case StatusCode::Found_302: return "Found";
  10355. case StatusCode::SeeOther_303: return "See Other";
  10356. case StatusCode::NotModified_304: return "Not Modified";
  10357. case StatusCode::UseProxy_305: return "Use Proxy";
  10358. case StatusCode::unused_306: return "unused";
  10359. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  10360. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  10361. case StatusCode::BadRequest_400: return "Bad Request";
  10362. case StatusCode::Unauthorized_401: return "Unauthorized";
  10363. case StatusCode::PaymentRequired_402: return "Payment Required";
  10364. case StatusCode::Forbidden_403: return "Forbidden";
  10365. case StatusCode::NotFound_404: return "Not Found";
  10366. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  10367. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  10368. case StatusCode::ProxyAuthenticationRequired_407:
  10369. return "Proxy Authentication Required";
  10370. case StatusCode::RequestTimeout_408: return "Request Timeout";
  10371. case StatusCode::Conflict_409: return "Conflict";
  10372. case StatusCode::Gone_410: return "Gone";
  10373. case StatusCode::LengthRequired_411: return "Length Required";
  10374. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  10375. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  10376. case StatusCode::UriTooLong_414: return "URI Too Long";
  10377. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  10378. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  10379. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  10380. case StatusCode::ImATeapot_418: return "I'm a teapot";
  10381. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  10382. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  10383. case StatusCode::Locked_423: return "Locked";
  10384. case StatusCode::FailedDependency_424: return "Failed Dependency";
  10385. case StatusCode::TooEarly_425: return "Too Early";
  10386. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  10387. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  10388. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  10389. case StatusCode::RequestHeaderFieldsTooLarge_431:
  10390. return "Request Header Fields Too Large";
  10391. case StatusCode::UnavailableForLegalReasons_451:
  10392. return "Unavailable For Legal Reasons";
  10393. case StatusCode::NotImplemented_501: return "Not Implemented";
  10394. case StatusCode::BadGateway_502: return "Bad Gateway";
  10395. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  10396. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  10397. case StatusCode::HttpVersionNotSupported_505:
  10398. return "HTTP Version Not Supported";
  10399. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  10400. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  10401. case StatusCode::LoopDetected_508: return "Loop Detected";
  10402. case StatusCode::NotExtended_510: return "Not Extended";
  10403. case StatusCode::NetworkAuthenticationRequired_511:
  10404. return "Network Authentication Required";
  10405. default:
  10406. case StatusCode::InternalServerError_500: return "Internal Server Error";
  10407. }
  10408. }
  10409. inline std::string to_string(const Error error) {
  10410. switch (error) {
  10411. case Error::Success: return "Success (no error)";
  10412. case Error::Unknown: return "Unknown";
  10413. case Error::Connection: return "Could not establish connection";
  10414. case Error::BindIPAddress: return "Failed to bind IP address";
  10415. case Error::Read: return "Failed to read connection";
  10416. case Error::Write: return "Failed to write connection";
  10417. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  10418. case Error::Canceled: return "Connection handling canceled";
  10419. case Error::SSLConnection: return "SSL connection failed";
  10420. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  10421. case Error::SSLServerVerification: return "SSL server verification failed";
  10422. case Error::SSLServerHostnameVerification:
  10423. return "SSL server hostname verification failed";
  10424. case Error::UnsupportedMultipartBoundaryChars:
  10425. return "Unsupported HTTP multipart boundary characters";
  10426. case Error::Compression: return "Compression failed";
  10427. case Error::ConnectionTimeout: return "Connection timed out";
  10428. case Error::ProxyConnection: return "Proxy connection failed";
  10429. case Error::ConnectionClosed: return "Connection closed by server";
  10430. case Error::Timeout: return "Read timeout";
  10431. case Error::ResourceExhaustion: return "Resource exhaustion";
  10432. case Error::TooManyFormDataFiles: return "Too many form data files";
  10433. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  10434. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  10435. case Error::ExceedMaxSocketDescriptorCount:
  10436. return "Exceeded maximum socket descriptor count";
  10437. case Error::InvalidRequestLine: return "Invalid request line";
  10438. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  10439. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  10440. case Error::InvalidHeaders: return "Invalid headers";
  10441. case Error::MultipartParsing: return "Multipart parsing failed";
  10442. case Error::OpenFile: return "Failed to open file";
  10443. case Error::Listen: return "Failed to listen on socket";
  10444. case Error::GetSockName: return "Failed to get socket name";
  10445. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  10446. case Error::HTTPParsing: return "HTTP parsing failed";
  10447. case Error::InvalidRangeHeader: return "Invalid Range header";
  10448. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  10449. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  10450. case Error::UserCallbackException: return "User callback threw an exception";
  10451. default: break;
  10452. }
  10453. return "Invalid";
  10454. }
  10455. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  10456. os << to_string(obj);
  10457. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  10458. return os;
  10459. }
  10460. inline std::string hosted_at(const std::string &hostname) {
  10461. std::vector<std::string> addrs;
  10462. hosted_at(hostname, addrs);
  10463. if (addrs.empty()) { return std::string(); }
  10464. return addrs[0];
  10465. }
  10466. inline void hosted_at(const std::string &hostname,
  10467. std::vector<std::string> &addrs) {
  10468. struct addrinfo hints;
  10469. struct addrinfo *result;
  10470. memset(&hints, 0, sizeof(struct addrinfo));
  10471. hints.ai_family = AF_UNSPEC;
  10472. hints.ai_socktype = SOCK_STREAM;
  10473. hints.ai_protocol = 0;
  10474. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  10475. &result, 0)) {
  10476. #if defined __linux__ && !defined __ANDROID__
  10477. res_init();
  10478. #endif
  10479. return;
  10480. }
  10481. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  10482. for (auto rp = result; rp; rp = rp->ai_next) {
  10483. const auto &addr =
  10484. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  10485. std::string ip;
  10486. auto dummy = -1;
  10487. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  10488. dummy)) {
  10489. addrs.emplace_back(std::move(ip));
  10490. }
  10491. }
  10492. }
  10493. inline std::string encode_uri_component(const std::string &value) {
  10494. std::ostringstream escaped;
  10495. escaped.fill('0');
  10496. escaped << std::hex;
  10497. for (auto c : value) {
  10498. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  10499. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  10500. escaped << c;
  10501. } else {
  10502. escaped << std::uppercase;
  10503. escaped << '%' << std::setw(2)
  10504. << static_cast<int>(static_cast<unsigned char>(c));
  10505. escaped << std::nouppercase;
  10506. }
  10507. }
  10508. return escaped.str();
  10509. }
  10510. inline std::string encode_uri(const std::string &value) {
  10511. std::ostringstream escaped;
  10512. escaped.fill('0');
  10513. escaped << std::hex;
  10514. for (auto c : value) {
  10515. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  10516. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  10517. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  10518. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  10519. escaped << c;
  10520. } else {
  10521. escaped << std::uppercase;
  10522. escaped << '%' << std::setw(2)
  10523. << static_cast<int>(static_cast<unsigned char>(c));
  10524. escaped << std::nouppercase;
  10525. }
  10526. }
  10527. return escaped.str();
  10528. }
  10529. inline std::string decode_uri_component(const std::string &value) {
  10530. std::string result;
  10531. for (size_t i = 0; i < value.size(); i++) {
  10532. if (value[i] == '%' && i + 2 < value.size()) {
  10533. auto val = 0;
  10534. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  10535. result += static_cast<char>(val);
  10536. i += 2;
  10537. } else {
  10538. result += value[i];
  10539. }
  10540. } else {
  10541. result += value[i];
  10542. }
  10543. }
  10544. return result;
  10545. }
  10546. inline std::string decode_uri(const std::string &value) {
  10547. std::string result;
  10548. for (size_t i = 0; i < value.size(); i++) {
  10549. if (value[i] == '%' && i + 2 < value.size()) {
  10550. auto val = 0;
  10551. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  10552. auto c = static_cast<char>(val);
  10553. // Keep escapes of the reserved characters that encode_uri leaves
  10554. // literal, so decode_uri is the inverse of encode_uri and an escaped
  10555. // delimiter is not promoted into a real one (as with JS decodeURI).
  10556. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  10557. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  10558. c == '#') {
  10559. result += value[i];
  10560. result += value[i + 1];
  10561. result += value[i + 2];
  10562. } else {
  10563. result += c;
  10564. }
  10565. i += 2;
  10566. } else {
  10567. result += value[i];
  10568. }
  10569. } else {
  10570. result += value[i];
  10571. }
  10572. }
  10573. return result;
  10574. }
  10575. inline std::string encode_path_component(const std::string &component) {
  10576. std::string result;
  10577. result.reserve(component.size() * 3);
  10578. for (size_t i = 0; i < component.size(); i++) {
  10579. auto c = static_cast<unsigned char>(component[i]);
  10580. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  10581. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10582. c == '_' || c == '~') {
  10583. result += static_cast<char>(c);
  10584. }
  10585. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  10586. // "," / ";" / "="
  10587. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  10588. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  10589. c == '=') {
  10590. result += static_cast<char>(c);
  10591. }
  10592. // Colon is allowed in path segments except first segment
  10593. else if (c == ':') {
  10594. result += static_cast<char>(c);
  10595. }
  10596. // @ is allowed in path
  10597. else if (c == '@') {
  10598. result += static_cast<char>(c);
  10599. } else {
  10600. result += '%';
  10601. char hex[3];
  10602. snprintf(hex, sizeof(hex), "%02X", c);
  10603. result.append(hex, 2);
  10604. }
  10605. }
  10606. return result;
  10607. }
  10608. inline std::string decode_path_component(const std::string &component) {
  10609. std::string result;
  10610. result.reserve(component.size());
  10611. for (size_t i = 0; i < component.size(); i++) {
  10612. if (component[i] == '%' && i + 1 < component.size()) {
  10613. if (component[i + 1] == 'u') {
  10614. // Unicode %uXXXX encoding
  10615. auto val = 0;
  10616. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  10617. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  10618. char buff[4];
  10619. size_t len = 0;
  10620. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  10621. (len = detail::to_utf8(val, buff)) > 0) {
  10622. result.append(buff, len);
  10623. i += 5; // 'u0000'
  10624. } else {
  10625. // Not 4 hex digits, or a surrogate, which is no character: the
  10626. // escape is kept as it is rather than joining its neighbours
  10627. result += component[i];
  10628. }
  10629. } else {
  10630. // Standard %XX encoding
  10631. auto val = 0;
  10632. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10633. // 2 digits hex codes
  10634. result += static_cast<char>(val);
  10635. i += 2; // 'XX'
  10636. } else {
  10637. result += component[i];
  10638. }
  10639. }
  10640. } else {
  10641. result += component[i];
  10642. }
  10643. }
  10644. return result;
  10645. }
  10646. inline std::string encode_query_component(const std::string &component,
  10647. bool space_as_plus) {
  10648. std::string result;
  10649. result.reserve(component.size() * 3);
  10650. for (size_t i = 0; i < component.size(); i++) {
  10651. auto c = static_cast<unsigned char>(component[i]);
  10652. // Unreserved characters per RFC 3986
  10653. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10654. c == '_' || c == '~') {
  10655. result += static_cast<char>(c);
  10656. }
  10657. // Space handling
  10658. else if (c == ' ') {
  10659. if (space_as_plus) {
  10660. result += '+';
  10661. } else {
  10662. result += "%20";
  10663. }
  10664. }
  10665. // Plus sign handling
  10666. else if (c == '+') {
  10667. if (space_as_plus) {
  10668. result += "%2B";
  10669. } else {
  10670. result += static_cast<char>(c);
  10671. }
  10672. }
  10673. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  10674. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  10675. c == '*' || c == ',' || c == ';') {
  10676. result += static_cast<char>(c);
  10677. }
  10678. // Colon and @ are allowed in query
  10679. else if (c == ':' || c == '@') {
  10680. result += static_cast<char>(c);
  10681. }
  10682. // Forward slash is allowed in query values
  10683. else if (c == '/') {
  10684. result += static_cast<char>(c);
  10685. }
  10686. // Question mark is allowed in query values (after first ?)
  10687. else if (c == '?') {
  10688. result += static_cast<char>(c);
  10689. } else {
  10690. result += '%';
  10691. char hex[3];
  10692. snprintf(hex, sizeof(hex), "%02X", c);
  10693. result.append(hex, 2);
  10694. }
  10695. }
  10696. return result;
  10697. }
  10698. inline std::string decode_query_component(const std::string &component,
  10699. bool plus_as_space) {
  10700. std::string result;
  10701. result.reserve(component.size());
  10702. for (size_t i = 0; i < component.size(); i++) {
  10703. if (component[i] == '%' && i + 2 < component.size()) {
  10704. auto val = 0;
  10705. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10706. result += static_cast<char>(val);
  10707. i += 2;
  10708. } else {
  10709. result += component[i];
  10710. }
  10711. } else if (component[i] == '+' && plus_as_space) {
  10712. result += ' '; // + becomes space in form-urlencoded
  10713. } else {
  10714. result += component[i];
  10715. }
  10716. }
  10717. return result;
  10718. }
  10719. inline std::string sanitize_filename(const std::string &filename) {
  10720. // Extract basename: find the last path separator (/ or \) and, on Windows,
  10721. // ':', which ends a drive prefix ("C:..") or names an NTFS stream ("a:b")
  10722. #ifdef _WIN32
  10723. auto pos = filename.find_last_of("/\\:");
  10724. #else
  10725. auto pos = filename.find_last_of("/\\");
  10726. #endif
  10727. auto result =
  10728. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10729. // Strip null bytes
  10730. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10731. // Trim whitespace
  10732. {
  10733. auto start = result.find_first_not_of(" \t");
  10734. auto end = result.find_last_not_of(" \t");
  10735. result = (start == std::string::npos)
  10736. ? ""
  10737. : result.substr(start, end - start + 1);
  10738. }
  10739. // Reject . and ..
  10740. if (result == "." || result == "..") { return ""; }
  10741. return result;
  10742. }
  10743. inline std::string append_query_params(const std::string &path,
  10744. const Params &params) {
  10745. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10746. auto fragment_pos = path.find('#');
  10747. auto path_with_query = path.substr(0, fragment_pos);
  10748. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10749. path_with_query += detail::params_to_query_str(params);
  10750. if (fragment_pos != std::string::npos) {
  10751. path_with_query.append(path, fragment_pos, std::string::npos);
  10752. }
  10753. return path_with_query;
  10754. }
  10755. // Header utilities
  10756. inline std::pair<std::string, std::string>
  10757. make_range_header(const Ranges &ranges) {
  10758. std::string field = "bytes=";
  10759. auto i = 0;
  10760. for (const auto &r : ranges) {
  10761. if (i != 0) { field += ", "; }
  10762. if (r.first != -1) { field += std::to_string(r.first); }
  10763. field += '-';
  10764. if (r.second != -1) { field += std::to_string(r.second); }
  10765. i++;
  10766. }
  10767. return std::make_pair("Range", std::move(field));
  10768. }
  10769. inline std::pair<std::string, std::string>
  10770. make_basic_authentication_header(const std::string &username,
  10771. const std::string &password, bool is_proxy) {
  10772. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10773. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10774. return std::make_pair(key, std::move(field));
  10775. }
  10776. inline std::pair<std::string, std::string>
  10777. make_bearer_token_authentication_header(const std::string &token,
  10778. bool is_proxy = false) {
  10779. auto field = "Bearer " + token;
  10780. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10781. return std::make_pair(key, std::move(field));
  10782. }
  10783. namespace detail {
  10784. // Basic auth when a username or password is set, otherwise a bearer token,
  10785. // unless the request already carries the header.
  10786. inline void add_authorization_header(Request &req, const std::string &username,
  10787. const std::string &password,
  10788. const std::string &token, bool is_proxy) {
  10789. if (req.has_header(is_proxy ? "Proxy-Authorization" : "Authorization")) {
  10790. return;
  10791. }
  10792. if (!username.empty() || !password.empty()) {
  10793. req.headers.insert(
  10794. make_basic_authentication_header(username, password, is_proxy));
  10795. } else if (!token.empty()) {
  10796. req.headers.insert(
  10797. make_bearer_token_authentication_header(token, is_proxy));
  10798. }
  10799. }
  10800. } // namespace detail
  10801. // Request implementation
  10802. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10803. size_t id) const {
  10804. return detail::get_header_value_u64(headers, key, def, id);
  10805. }
  10806. inline bool Request::has_header(const std::string &key) const {
  10807. return detail::has_header(headers, key);
  10808. }
  10809. inline std::string Request::get_header_value(const std::string &key,
  10810. const char *def, size_t id) const {
  10811. return detail::get_header_value(headers, key, def, id);
  10812. }
  10813. inline size_t Request::get_header_value_count(const std::string &key) const {
  10814. return detail::get_header_value_count(headers, key);
  10815. }
  10816. inline void Request::set_header(const std::string &key,
  10817. const std::string &val) {
  10818. detail::set_header(headers, key, val);
  10819. }
  10820. inline bool Request::has_trailer(const std::string &key) const {
  10821. return trailers.find(key) != trailers.end();
  10822. }
  10823. inline std::string Request::get_trailer_value(const std::string &key,
  10824. size_t id) const {
  10825. return detail::get_multimap_value(trailers, key, id);
  10826. }
  10827. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10828. return trailers.count(key);
  10829. }
  10830. inline bool Request::has_param(const std::string &key) const {
  10831. return params.find(key) != params.end();
  10832. }
  10833. inline std::string Request::get_param_value(const std::string &key,
  10834. size_t id) const {
  10835. return detail::get_multimap_value(params, key, id);
  10836. }
  10837. inline std::vector<std::string>
  10838. Request::get_param_values(const std::string &key) const {
  10839. auto rng = params.equal_range(key);
  10840. std::vector<std::string> values;
  10841. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10842. for (auto it = rng.first; it != rng.second; ++it) {
  10843. values.push_back(it->second);
  10844. }
  10845. return values;
  10846. }
  10847. inline size_t Request::get_param_value_count(const std::string &key) const {
  10848. return params.count(key);
  10849. }
  10850. inline bool Request::is_multipart_form_data() const {
  10851. const auto &content_type = get_header_value("Content-Type");
  10852. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10853. "multipart/form-data");
  10854. }
  10855. // Multipart FormData implementation
  10856. inline std::string MultipartFormData::get_field(const std::string &key,
  10857. size_t id) const {
  10858. auto rng = fields.equal_range(key);
  10859. auto it = detail::bounded_next(rng.first, id, rng.second);
  10860. if (it != rng.second) { return it->second.content; }
  10861. return std::string();
  10862. }
  10863. inline std::vector<std::string>
  10864. MultipartFormData::get_fields(const std::string &key) const {
  10865. std::vector<std::string> values;
  10866. auto rng = fields.equal_range(key);
  10867. for (auto it = rng.first; it != rng.second; it++) {
  10868. values.push_back(it->second.content);
  10869. }
  10870. return values;
  10871. }
  10872. inline bool MultipartFormData::has_field(const std::string &key) const {
  10873. return fields.find(key) != fields.end();
  10874. }
  10875. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10876. return fields.count(key);
  10877. }
  10878. inline FormData MultipartFormData::get_file(const std::string &key,
  10879. size_t id) const {
  10880. return detail::get_multimap_value(files, key, id);
  10881. }
  10882. inline std::vector<FormData>
  10883. MultipartFormData::get_files(const std::string &key) const {
  10884. std::vector<FormData> values;
  10885. auto rng = files.equal_range(key);
  10886. for (auto it = rng.first; it != rng.second; it++) {
  10887. values.push_back(it->second);
  10888. }
  10889. return values;
  10890. }
  10891. inline bool MultipartFormData::has_file(const std::string &key) const {
  10892. return files.find(key) != files.end();
  10893. }
  10894. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10895. return files.count(key);
  10896. }
  10897. // Multipart FormData writer implementation
  10898. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10899. return detail::is_multipart_boundary_chars_valid(boundary);
  10900. }
  10901. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10902. : boundary_(detail::make_multipart_data_boundary()) {}
  10903. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10904. : boundary_(std::move(boundary)) {}
  10905. inline const std::string &MultipartFormDataWriter::boundary() const {
  10906. return boundary_;
  10907. }
  10908. inline std::string MultipartFormDataWriter::content_type() const {
  10909. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10910. }
  10911. inline std::string
  10912. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10913. return detail::serialize_multipart_formdata(items, boundary_);
  10914. }
  10915. inline size_t MultipartFormDataWriter::content_length(
  10916. const UploadFormDataItems &items) const {
  10917. return detail::get_multipart_content_length(items, boundary_);
  10918. }
  10919. inline std::string
  10920. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10921. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10922. }
  10923. inline std::string MultipartFormDataWriter::item_end() {
  10924. return detail::serialize_multipart_formdata_item_end();
  10925. }
  10926. inline std::string MultipartFormDataWriter::finish() const {
  10927. return detail::serialize_multipart_formdata_finish(boundary_);
  10928. }
  10929. // Response implementation
  10930. namespace detail {
  10931. // A response has one content source: `body`, a content provider, or a file.
  10932. // Each content setter calls this so that the one called last wins.
  10933. inline void clear_content_provider(Response &res) {
  10934. auto releaser = std::move(res.content_provider_resource_releaser_);
  10935. auto success = res.content_provider_success_;
  10936. res.content_length_ = 0;
  10937. res.content_provider_ = nullptr;
  10938. res.content_provider_resource_releaser_ = nullptr;
  10939. res.is_chunked_content_provider_ = false;
  10940. res.is_file_content_provider_ = false;
  10941. res.content_provider_success_ = false;
  10942. res.content_coding_ = EncodingType::None;
  10943. res.file_content_path_.clear();
  10944. res.file_content_content_type_.clear();
  10945. if (releaser) { releaser(success); }
  10946. }
  10947. inline void clear_content(Response &res) {
  10948. res.body.clear();
  10949. clear_content_provider(res);
  10950. }
  10951. // The Content-Type of the old content goes with it.
  10952. inline void set_content_type(Response &res, const std::string &content_type) {
  10953. res.headers.erase("Content-Type");
  10954. res.set_header("Content-Type", content_type);
  10955. }
  10956. // `body` is public, so it can be assigned directly after a provider or a file
  10957. // was set. It came last, so it wins.
  10958. inline void prefer_assigned_body(Response &res) {
  10959. if (!res.body.empty() &&
  10960. (res.content_provider_ || !res.file_content_path_.empty())) {
  10961. clear_content_provider(res);
  10962. }
  10963. }
  10964. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10965. inline bool body_allowed_for_status(int status) {
  10966. return status >= 200 && status != StatusCode::NoContent_204 &&
  10967. status != StatusCode::NotModified_304;
  10968. }
  10969. // Only a 206 response is served as a partial representation. range_error()
  10970. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10971. // status would start from an unchecked offset.
  10972. inline bool is_partial_content(const Request &req, const Response &res) {
  10973. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10974. }
  10975. // Sets the Content-Length or Transfer-Encoding framing the body that
  10976. // Server::write_response_core() writes, or closes the connection after a body
  10977. // that has neither. Only the library sets them: one from a handler would go
  10978. // out next to it, or describe some other body.
  10979. inline void set_framing_headers(const Request &req, Response &res,
  10980. const std::string &boundary,
  10981. const std::string &content_type) {
  10982. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10983. auto head_length = req.method == "HEAD"
  10984. ? res.get_header_value("Content-Length")
  10985. : std::string();
  10986. res.headers.erase("Content-Length");
  10987. res.headers.erase("Transfer-Encoding");
  10988. if (!body_allowed_for_status(res.status)) { return; }
  10989. if (res.content_provider_) {
  10990. if (res.content_length_ == 0) {
  10991. if (res.is_chunked_content_provider_) {
  10992. res.set_header("Transfer-Encoding", "chunked");
  10993. } else if (req.method != "HEAD") {
  10994. // RFC 9112 6.3: a body with neither ends where the connection does.
  10995. res.headers.erase("Keep-Alive");
  10996. if (!has_header_token(res.headers, "Connection", "close")) {
  10997. res.set_header("Connection", "close");
  10998. }
  10999. }
  11000. return;
  11001. }
  11002. // The part Server::write_content_with_provider() writes.
  11003. auto length = res.content_length_;
  11004. if (is_partial_content(req, res)) {
  11005. length = req.ranges.size() == 1
  11006. ? get_range_offset_and_length(req.ranges[0], length).second
  11007. : get_multipart_ranges_data_length(req, boundary,
  11008. content_type, length);
  11009. }
  11010. res.set_header("Content-Length", std::to_string(length));
  11011. } else if (!res.body.empty()) {
  11012. res.set_header("Content-Length", std::to_string(res.body.size()));
  11013. } else {
  11014. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  11015. }
  11016. }
  11017. } // namespace detail
  11018. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  11019. size_t id) const {
  11020. return detail::get_header_value_u64(headers, key, def, id);
  11021. }
  11022. inline bool Response::has_header(const std::string &key) const {
  11023. return headers.find(key) != headers.end();
  11024. }
  11025. inline std::string Response::get_header_value(const std::string &key,
  11026. const char *def,
  11027. size_t id) const {
  11028. return detail::get_header_value(headers, key, def, id);
  11029. }
  11030. inline size_t Response::get_header_value_count(const std::string &key) const {
  11031. return detail::get_header_value_count(headers, key);
  11032. }
  11033. inline void Response::set_header(const std::string &key,
  11034. const std::string &val) {
  11035. detail::set_header(headers, key, val);
  11036. }
  11037. inline bool Response::has_trailer(const std::string &key) const {
  11038. return trailers.find(key) != trailers.end();
  11039. }
  11040. inline std::string Response::get_trailer_value(const std::string &key,
  11041. size_t id) const {
  11042. return detail::get_multimap_value(trailers, key, id);
  11043. }
  11044. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  11045. return trailers.count(key);
  11046. }
  11047. inline void Response::set_redirect(const std::string &url, int stat) {
  11048. if (detail::fields::is_field_value(url)) {
  11049. set_header("Location", url);
  11050. if (300 <= stat && stat < 400) {
  11051. this->status = stat;
  11052. } else {
  11053. this->status = StatusCode::Found_302;
  11054. }
  11055. }
  11056. }
  11057. inline void Response::set_content(const char *s, size_t n,
  11058. const std::string &content_type) {
  11059. body.assign(s, n); // Before the releaser runs; it may own `s`.
  11060. detail::clear_content_provider(*this);
  11061. detail::set_content_type(*this, content_type);
  11062. }
  11063. inline void Response::set_content(const std::string &s,
  11064. const std::string &content_type) {
  11065. set_content(s.data(), s.size(), content_type);
  11066. }
  11067. inline void Response::set_content(std::string &&s,
  11068. const std::string &content_type) {
  11069. body = std::move(s);
  11070. detail::clear_content_provider(*this);
  11071. detail::set_content_type(*this, content_type);
  11072. }
  11073. inline void Response::set_content_provider(
  11074. size_t in_length, const std::string &content_type, ContentProvider provider,
  11075. ContentProviderResourceReleaser resource_releaser) {
  11076. detail::clear_content(*this);
  11077. detail::set_content_type(*this, content_type);
  11078. content_length_ = in_length;
  11079. if (in_length > 0) { content_provider_ = std::move(provider); }
  11080. content_provider_resource_releaser_ = std::move(resource_releaser);
  11081. }
  11082. inline void Response::set_content_provider(
  11083. const std::string &content_type, ContentProviderWithoutLength provider,
  11084. ContentProviderResourceReleaser resource_releaser) {
  11085. detail::clear_content(*this);
  11086. detail::set_content_type(*this, content_type);
  11087. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  11088. content_provider_resource_releaser_ = std::move(resource_releaser);
  11089. }
  11090. inline void Response::set_chunked_content_provider(
  11091. const std::string &content_type, ContentProviderWithoutLength provider,
  11092. ContentProviderResourceReleaser resource_releaser) {
  11093. set_content_provider(content_type, std::move(provider),
  11094. std::move(resource_releaser));
  11095. is_chunked_content_provider_ = true;
  11096. }
  11097. inline void Response::set_file_content(const std::string &path,
  11098. const std::string &content_type) {
  11099. detail::clear_content(*this);
  11100. headers.erase("Content-Type");
  11101. file_content_path_ = path;
  11102. file_content_content_type_ = content_type;
  11103. }
  11104. inline void Response::set_file_content(const std::string &path) {
  11105. set_file_content(path, std::string());
  11106. }
  11107. // Result implementation
  11108. inline size_t Result::get_request_header_value_u64(const std::string &key,
  11109. size_t def,
  11110. size_t id) const {
  11111. return detail::get_header_value_u64(request_headers_, key, def, id);
  11112. }
  11113. inline bool Result::has_request_header(const std::string &key) const {
  11114. return request_headers_.find(key) != request_headers_.end();
  11115. }
  11116. inline std::string Result::get_request_header_value(const std::string &key,
  11117. const char *def,
  11118. size_t id) const {
  11119. return detail::get_header_value(request_headers_, key, def, id);
  11120. }
  11121. inline size_t
  11122. Result::get_request_header_value_count(const std::string &key) const {
  11123. return request_headers_.count(key);
  11124. }
  11125. // Stream implementation
  11126. inline ssize_t Stream::write(const char *ptr) {
  11127. return write(ptr, strlen(ptr));
  11128. }
  11129. inline ssize_t Stream::write(const std::string &s) {
  11130. return write(s.data(), s.size());
  11131. }
  11132. // BodyReader implementation
  11133. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  11134. if (!stream) {
  11135. last_error = Error::Connection;
  11136. return -1;
  11137. }
  11138. if (eof) { return 0; }
  11139. if (!chunked) {
  11140. // Content-Length based reading
  11141. if (has_content_length && bytes_read >= content_length) {
  11142. eof = true;
  11143. return 0;
  11144. }
  11145. auto to_read = len;
  11146. if (has_content_length) {
  11147. auto remaining = content_length - bytes_read;
  11148. to_read = (std::min)(len, remaining);
  11149. }
  11150. auto n = stream->read(buf, to_read);
  11151. // Without Content-Length the body ends when the connection closes
  11152. // (RFC 9112 §6.3); with one, an EOF here came too early
  11153. if (n < 0 || (n == 0 && has_content_length)) {
  11154. last_error = stream->get_error();
  11155. if (last_error == Error::Success) { last_error = Error::Read; }
  11156. }
  11157. if (n <= 0) {
  11158. eof = true;
  11159. return n;
  11160. }
  11161. bytes_read += static_cast<size_t>(n);
  11162. if (has_content_length && bytes_read >= content_length) { eof = true; }
  11163. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  11164. last_error = Error::ExceedMaxPayloadSize;
  11165. eof = true;
  11166. return -1;
  11167. }
  11168. return n;
  11169. }
  11170. // Chunked transfer encoding: delegate to shared decoder instance.
  11171. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  11172. size_t chunk_offset = 0;
  11173. size_t chunk_total = 0;
  11174. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  11175. if (n < 0) {
  11176. last_error = stream->get_error();
  11177. if (last_error == Error::Success) { last_error = Error::Read; }
  11178. eof = true;
  11179. return n;
  11180. }
  11181. if (n == 0) {
  11182. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  11183. eof = true;
  11184. return 0;
  11185. }
  11186. bytes_read += static_cast<size_t>(n);
  11187. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  11188. last_error = Error::ExceedMaxPayloadSize;
  11189. eof = true;
  11190. return -1;
  11191. }
  11192. return n;
  11193. }
  11194. // ThreadPool implementation
  11195. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  11196. time_t idle_timeout_sec)
  11197. : base_thread_count_(n), max_queued_requests_(mqr),
  11198. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  11199. shutdown_(false) {
  11200. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11201. if (max_n != 0 && max_n < n) {
  11202. std::string msg = "max_threads must be >= base_threads";
  11203. throw std::invalid_argument(msg);
  11204. }
  11205. #endif
  11206. max_thread_count_ = max_n == 0 ? n : max_n;
  11207. threads_.reserve(base_thread_count_);
  11208. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11209. try {
  11210. #endif
  11211. for (size_t i = 0; i < base_thread_count_; i++) {
  11212. threads_.emplace_back(std::thread([this]() { worker(false); }));
  11213. }
  11214. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11215. } catch (...) {
  11216. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  11217. // signal the workers we already spawned to exit and join them so the
  11218. // vector destructor does not see joinable threads (which would call
  11219. // std::terminate). Then rethrow so the caller learns of the failure.
  11220. {
  11221. std::unique_lock<std::mutex> lock(mutex_);
  11222. shutdown_ = true;
  11223. }
  11224. cond_.notify_all();
  11225. for (auto &t : threads_) {
  11226. if (t.joinable()) { t.join(); }
  11227. }
  11228. throw;
  11229. }
  11230. #endif
  11231. }
  11232. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  11233. {
  11234. std::unique_lock<std::mutex> lock(mutex_);
  11235. if (shutdown_) { return false; }
  11236. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  11237. return false;
  11238. }
  11239. jobs_.push_back(std::move(fn));
  11240. // Spawn a dynamic thread if jobs outnumber idle threads and under max
  11241. if (jobs_.size() > idle_thread_count_ &&
  11242. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  11243. cleanup_finished_threads();
  11244. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11245. try {
  11246. #endif
  11247. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  11248. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11249. } catch (const std::system_error &) {
  11250. // No thread budget left: keep the job queued for an existing worker
  11251. // instead of letting the exception escape the accept loop.
  11252. }
  11253. #endif
  11254. }
  11255. }
  11256. cond_.notify_one();
  11257. return true;
  11258. }
  11259. inline void ThreadPool::shutdown() {
  11260. {
  11261. std::unique_lock<std::mutex> lock(mutex_);
  11262. shutdown_ = true;
  11263. }
  11264. cond_.notify_all();
  11265. for (auto &t : threads_) {
  11266. if (t.joinable()) { t.join(); }
  11267. }
  11268. // Move dynamic_threads_ to a local list under the lock to avoid racing
  11269. // with worker threads that call move_to_finished() concurrently.
  11270. std::list<std::thread> remaining_dynamic;
  11271. {
  11272. std::unique_lock<std::mutex> lock(mutex_);
  11273. remaining_dynamic = std::move(dynamic_threads_);
  11274. }
  11275. for (auto &t : remaining_dynamic) {
  11276. if (t.joinable()) { t.join(); }
  11277. }
  11278. std::unique_lock<std::mutex> lock(mutex_);
  11279. cleanup_finished_threads();
  11280. }
  11281. inline void ThreadPool::move_to_finished(std::thread::id id) {
  11282. // Must be called with mutex_ held
  11283. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  11284. if (it->get_id() == id) {
  11285. finished_threads_.push_back(std::move(*it));
  11286. dynamic_threads_.erase(it);
  11287. return;
  11288. }
  11289. }
  11290. }
  11291. inline void ThreadPool::cleanup_finished_threads() {
  11292. // Must be called with mutex_ held
  11293. for (auto &t : finished_threads_) {
  11294. if (t.joinable()) { t.join(); }
  11295. }
  11296. finished_threads_.clear();
  11297. }
  11298. inline void ThreadPool::worker(bool is_dynamic) {
  11299. for (;;) {
  11300. std::function<void()> fn;
  11301. {
  11302. std::unique_lock<std::mutex> lock(mutex_);
  11303. idle_thread_count_++;
  11304. if (is_dynamic) {
  11305. auto has_work =
  11306. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  11307. [&] { return !jobs_.empty() || shutdown_; });
  11308. if (!has_work) {
  11309. // Timed out with no work - exit this dynamic thread
  11310. idle_thread_count_--;
  11311. move_to_finished(std::this_thread::get_id());
  11312. break;
  11313. }
  11314. } else {
  11315. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  11316. }
  11317. idle_thread_count_--;
  11318. if (shutdown_ && jobs_.empty()) { break; }
  11319. fn = std::move(jobs_.front());
  11320. jobs_.pop_front();
  11321. }
  11322. assert(true == static_cast<bool>(fn));
  11323. fn();
  11324. }
  11325. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  11326. !defined(LIBRESSL_VERSION_NUMBER)
  11327. OPENSSL_thread_stop();
  11328. #endif
  11329. }
  11330. /*
  11331. * Group 1 (continued): detail namespace - Stream implementations
  11332. */
  11333. namespace detail {
  11334. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  11335. time_t timeout_sec, time_t timeout_usec,
  11336. time_t &actual_timeout_sec,
  11337. time_t &actual_timeout_usec) {
  11338. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  11339. auto actual_timeout_msec =
  11340. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  11341. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  11342. actual_timeout_sec = actual_timeout_msec / 1000;
  11343. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  11344. }
  11345. // Socket stream implementation
  11346. inline SocketStream::SocketStream(
  11347. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  11348. time_t write_timeout_sec, time_t write_timeout_usec,
  11349. time_t max_timeout_msec,
  11350. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11351. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  11352. read_timeout_usec_(read_timeout_usec),
  11353. write_timeout_sec_(write_timeout_sec),
  11354. write_timeout_usec_(write_timeout_usec),
  11355. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  11356. read_buff_(read_buff_size_, 0) {}
  11357. inline SocketStream::~SocketStream() = default;
  11358. inline bool SocketStream::is_readable() const {
  11359. return read_buff_off_ < read_buff_content_size_;
  11360. }
  11361. inline bool SocketStream::wait_readable() const {
  11362. if (max_timeout_msec_ <= 0) {
  11363. return select_read_interruptible(sock_, read_timeout_sec_,
  11364. read_timeout_usec_, read_interrupted_) > 0;
  11365. }
  11366. time_t read_timeout_sec;
  11367. time_t read_timeout_usec;
  11368. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11369. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11370. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11371. read_interrupted_) > 0;
  11372. }
  11373. inline bool SocketStream::wait_writable() const {
  11374. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11375. }
  11376. inline bool SocketStream::ensure_readable() {
  11377. if (readable_hint_) {
  11378. readable_hint_ = false;
  11379. return true;
  11380. }
  11381. return wait_readable();
  11382. }
  11383. inline const char *SocketStream::buffered_data(size_t &size) const {
  11384. size = read_buff_content_size_ - read_buff_off_;
  11385. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  11386. }
  11387. inline void SocketStream::consume_buffered(size_t size) {
  11388. assert(size <= read_buff_content_size_ - read_buff_off_);
  11389. read_buff_off_ += size;
  11390. }
  11391. inline bool SocketStream::is_peer_alive() const {
  11392. return detail::is_socket_alive(sock_);
  11393. }
  11394. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  11395. #ifdef _WIN32
  11396. size =
  11397. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  11398. #else
  11399. size = (std::min)(size,
  11400. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  11401. #endif
  11402. if (read_buff_off_ < read_buff_content_size_) {
  11403. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  11404. if (size <= remaining_size) {
  11405. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  11406. read_buff_off_ += size;
  11407. return static_cast<ssize_t>(size);
  11408. } else {
  11409. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  11410. read_buff_off_ += remaining_size;
  11411. return static_cast<ssize_t>(remaining_size);
  11412. }
  11413. }
  11414. if (!ensure_readable()) {
  11415. error_ = Error::Timeout;
  11416. return -1;
  11417. }
  11418. read_buff_off_ = 0;
  11419. read_buff_content_size_ = 0;
  11420. if (size < read_buff_size_) {
  11421. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  11422. CPPHTTPLIB_RECV_FLAGS);
  11423. if (n <= 0) {
  11424. if (n == 0) {
  11425. error_ = Error::ConnectionClosed;
  11426. } else {
  11427. error_ = Error::Read;
  11428. }
  11429. return n;
  11430. } else if (n <= static_cast<ssize_t>(size)) {
  11431. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  11432. return n;
  11433. } else {
  11434. memcpy(ptr, read_buff_.data(), size);
  11435. read_buff_off_ = size;
  11436. read_buff_content_size_ = static_cast<size_t>(n);
  11437. return static_cast<ssize_t>(size);
  11438. }
  11439. } else {
  11440. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  11441. if (n <= 0) {
  11442. if (n == 0) {
  11443. error_ = Error::ConnectionClosed;
  11444. } else {
  11445. error_ = Error::Read;
  11446. }
  11447. }
  11448. return n;
  11449. }
  11450. }
  11451. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  11452. if (!wait_writable()) { return -1; }
  11453. // Winsock's send() takes an int length, even on 64-bit Windows
  11454. #ifdef _WIN32
  11455. size =
  11456. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  11457. #endif
  11458. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  11459. }
  11460. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  11461. int &port) const {
  11462. return detail::get_remote_ip_and_port(sock_, ip, port);
  11463. }
  11464. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  11465. int &port) const {
  11466. return detail::get_local_ip_and_port(sock_, ip, port);
  11467. }
  11468. inline socket_t SocketStream::socket() const { return sock_; }
  11469. inline time_t SocketStream::duration() const {
  11470. return static_cast<time_t>(
  11471. std::chrono::duration_cast<std::chrono::milliseconds>(
  11472. std::chrono::steady_clock::now() - start_time_)
  11473. .count());
  11474. }
  11475. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  11476. read_timeout_sec_ = sec;
  11477. read_timeout_usec_ = usec;
  11478. }
  11479. inline void SocketStream::set_max_timeout(time_t msec) {
  11480. max_timeout_msec_ = msec;
  11481. start_time_ = std::chrono::steady_clock::now();
  11482. }
  11483. inline void
  11484. SocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11485. read_interrupted_ = std::move(interrupted);
  11486. }
  11487. // Buffer stream implementation
  11488. inline bool BufferStream::is_readable() const { return true; }
  11489. inline bool BufferStream::wait_readable() const { return true; }
  11490. inline bool BufferStream::wait_writable() const { return true; }
  11491. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  11492. #if defined(_MSC_VER) && _MSC_VER < 1910
  11493. auto len_read = buffer._Copy_s(ptr, size, size, position);
  11494. #else
  11495. auto len_read = buffer.copy(ptr, size, position);
  11496. #endif
  11497. position += static_cast<size_t>(len_read);
  11498. return static_cast<ssize_t>(len_read);
  11499. }
  11500. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  11501. buffer.append(ptr, size);
  11502. return static_cast<ssize_t>(size);
  11503. }
  11504. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  11505. int & /*port*/) const {}
  11506. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  11507. int & /*port*/) const {}
  11508. inline socket_t BufferStream::socket() const { return 0; }
  11509. inline time_t BufferStream::duration() const { return 0; }
  11510. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  11511. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  11512. : MatcherBase(pattern) {
  11513. constexpr const char marker[] = "/:";
  11514. // One past the last ending position of a path param substring
  11515. std::size_t last_param_end = 0;
  11516. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11517. // Needed to ensure that parameter names are unique during matcher
  11518. // construction
  11519. // If exceptions are disabled, only last duplicate path
  11520. // parameter will be set
  11521. std::unordered_set<std::string> param_name_set;
  11522. #endif
  11523. while (true) {
  11524. const auto marker_pos = pattern.find(
  11525. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  11526. if (marker_pos == std::string::npos) { break; }
  11527. static_fragments_.push_back(
  11528. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  11529. const auto param_name_start = marker_pos + str_len(marker);
  11530. auto sep_pos = pattern.find(separator, param_name_start);
  11531. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  11532. auto param_name =
  11533. pattern.substr(param_name_start, sep_pos - param_name_start);
  11534. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11535. if (param_name_set.find(param_name) != param_name_set.cend()) {
  11536. std::string msg = "Encountered path parameter '" + param_name +
  11537. "' multiple times in route pattern '" + pattern + "'.";
  11538. throw std::invalid_argument(msg);
  11539. }
  11540. #endif
  11541. param_names_.push_back(std::move(param_name));
  11542. last_param_end = sep_pos + 1;
  11543. }
  11544. if (last_param_end < pattern.length()) {
  11545. static_fragments_.push_back(pattern.substr(last_param_end));
  11546. }
  11547. }
  11548. inline bool PathParamsMatcher::match(Request &request) const {
  11549. request.matches = std::smatch();
  11550. request.path_params.clear();
  11551. // A pattern without parameters is just a literal path to compare against
  11552. if (param_names_.empty()) { return request.path == pattern(); }
  11553. request.path_params.reserve(param_names_.size());
  11554. // One past the position at which the path matched the pattern last time
  11555. std::size_t starting_pos = 0;
  11556. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  11557. const auto &fragment = static_fragments_[i];
  11558. if (starting_pos + fragment.length() > request.path.length()) {
  11559. return false;
  11560. }
  11561. // Avoid unnecessary allocation by using strncmp instead of substr +
  11562. // comparison
  11563. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  11564. fragment.length()) != 0) {
  11565. return false;
  11566. }
  11567. starting_pos += fragment.length();
  11568. // Should only happen when we have a static fragment after a param
  11569. // Example: '/users/:id/subscriptions'
  11570. // The 'subscriptions' fragment here does not have a corresponding param
  11571. if (i >= param_names_.size()) { continue; }
  11572. auto sep_pos = request.path.find(separator, starting_pos);
  11573. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  11574. const auto &param_name = param_names_[i];
  11575. request.path_params.emplace(
  11576. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  11577. // Mark everything up to '/' as matched
  11578. starting_pos = sep_pos + 1;
  11579. }
  11580. // Returns false if the path is longer than the pattern
  11581. return starting_pos >= request.path.length();
  11582. }
  11583. inline bool RegexMatcher::match(Request &request) const {
  11584. request.path_params.clear();
  11585. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  11586. // a non-match rather than risking a stack overflow in std::regex_match.
  11587. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  11588. return false;
  11589. }
  11590. return std::regex_match(request.path, request.matches, regex_);
  11591. }
  11592. // Enclose IPv6 address in brackets if needed
  11593. inline std::string prepare_host_string(const std::string &host) {
  11594. // Enclose IPv6 address in brackets (but not if already enclosed)
  11595. if (host.find(':') == std::string::npos ||
  11596. (!host.empty() && host[0] == '[')) {
  11597. // IPv4, hostname, or already bracketed IPv6
  11598. return host;
  11599. } else {
  11600. // IPv6 address without brackets
  11601. return "[" + host + "]";
  11602. }
  11603. }
  11604. inline std::string make_host_and_port_string(const std::string &host, int port,
  11605. bool is_ssl) {
  11606. auto result = prepare_host_string(host);
  11607. // Append port if not default
  11608. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  11609. ; // do nothing
  11610. } else {
  11611. result += ":" + std::to_string(port);
  11612. }
  11613. return result;
  11614. }
  11615. // Create "host:port" string always including port number (for CONNECT method)
  11616. inline std::string
  11617. make_host_and_port_string_always_port(const std::string &host, int port) {
  11618. return prepare_host_string(host) + ":" + std::to_string(port);
  11619. }
  11620. // Where a client connects for `host`, as one string: the mapped address or
  11621. // name, or `host` itself.
  11622. inline std::string
  11623. addr_map_target(const std::map<std::string, std::string> &addr_map,
  11624. const std::string &host) {
  11625. std::string connect_host;
  11626. std::string ip;
  11627. apply_addr_map(addr_map, host, connect_host, ip);
  11628. return ip.empty() ? connect_host : ip;
  11629. }
  11630. // Request target of a CONNECT for `host`, with `addr_map` applied.
  11631. inline std::string
  11632. make_connect_request_target(const std::map<std::string, std::string> &addr_map,
  11633. const std::string &host, int port) {
  11634. return make_host_and_port_string_always_port(addr_map_target(addr_map, host),
  11635. port);
  11636. }
  11637. // Value for the Host header a client sends when the caller supplied none.
  11638. // Only the value: callers decide where in their header list it goes.
  11639. inline std::string make_default_host_header_value(const std::string &host,
  11640. int port, bool is_ssl,
  11641. int address_family) {
  11642. if (address_family == AF_UNIX) { return "localhost"; }
  11643. return make_host_and_port_string(host, port, is_ssl);
  11644. }
  11645. inline void add_default_user_agent_header(Request &req) {
  11646. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  11647. if (!req.has_header("User-Agent")) {
  11648. req.set_header("User-Agent",
  11649. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  11650. }
  11651. #else
  11652. (void)req;
  11653. #endif
  11654. }
  11655. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  11656. NormalizedTarget normalize_target(const std::string &host);
  11657. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  11658. bool host_matches_no_proxy(const NormalizedTarget &target,
  11659. const std::vector<NoProxyEntry> &entries);
  11660. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  11661. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  11662. if (prefix_bits == 0) { return true; }
  11663. int full_bytes = prefix_bits / 8;
  11664. int rem_bits = prefix_bits % 8;
  11665. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  11666. static_cast<size_t>(full_bytes)) != 0) {
  11667. return false;
  11668. }
  11669. if (rem_bits == 0) { return true; }
  11670. auto i = static_cast<size_t>(full_bytes);
  11671. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  11672. return (ip[i] & mask) == (net[i] & mask);
  11673. }
  11674. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  11675. if (token.empty()) { return false; }
  11676. if (token == "*") {
  11677. out.kind = NoProxyKind::Wildcard;
  11678. return true;
  11679. }
  11680. auto slash = token.find('/');
  11681. std::string addr_part =
  11682. (slash == std::string::npos) ? token : token.substr(0, slash);
  11683. std::string prefix_part =
  11684. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  11685. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  11686. // don't silently treat it as a /32 (or /128).
  11687. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  11688. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  11689. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  11690. // when brackets are present.
  11691. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  11692. addr_part.back() == ']';
  11693. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  11694. if (!bracketed) {
  11695. struct in_addr v4;
  11696. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  11697. int prefix = 32;
  11698. if (!prefix_part.empty() &&
  11699. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  11700. prefix)) {
  11701. return false;
  11702. }
  11703. out.kind = NoProxyKind::IPv4Cidr;
  11704. std::memcpy(out.net.data(), &v4, sizeof(v4));
  11705. out.prefix_bits = prefix;
  11706. return true;
  11707. }
  11708. }
  11709. struct in6_addr v6;
  11710. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  11711. int prefix = 128;
  11712. if (!prefix_part.empty() &&
  11713. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  11714. prefix)) {
  11715. return false;
  11716. }
  11717. out.kind = NoProxyKind::IPv6Cidr;
  11718. std::memcpy(out.net.data(), &v6, sizeof(v6));
  11719. out.prefix_bits = prefix;
  11720. return true;
  11721. }
  11722. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  11723. // the entry is malformed — don't fall through to the hostname branch.
  11724. if (bracketed) { return false; }
  11725. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  11726. if (slash != std::string::npos) { return false; }
  11727. // Port-specific entries (host:port) are not supported.
  11728. if (token.find(':') != std::string::npos) { return false; }
  11729. std::string hostname = case_ignore::to_lower(token);
  11730. while (!hostname.empty() && hostname.front() == '.') {
  11731. hostname.erase(hostname.begin());
  11732. }
  11733. while (!hostname.empty() && hostname.back() == '.') {
  11734. hostname.pop_back();
  11735. }
  11736. if (hostname.empty()) { return false; }
  11737. out.kind = NoProxyKind::HostnameSuffix;
  11738. out.hostname_pattern = std::move(hostname);
  11739. return true;
  11740. }
  11741. inline std::vector<NoProxyEntry>
  11742. parse_no_proxy_entries(const std::vector<std::string> &patterns) {
  11743. std::vector<NoProxyEntry> entries;
  11744. entries.reserve(patterns.size());
  11745. for (const auto &p : patterns) {
  11746. auto trimmed = trim_copy(p);
  11747. if (trimmed.empty()) { continue; }
  11748. NoProxyEntry entry;
  11749. if (parse_no_proxy_entry(trimmed, entry)) {
  11750. entries.push_back(std::move(entry));
  11751. }
  11752. }
  11753. return entries;
  11754. }
  11755. inline NormalizedTarget normalize_target(const std::string &host) {
  11756. NormalizedTarget t;
  11757. std::string h = host;
  11758. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  11759. h = h.substr(1, h.size() - 2);
  11760. }
  11761. // Strip a single trailing dot so "example.com." canonicalizes to
  11762. // "example.com".
  11763. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  11764. t.hostname = case_ignore::to_lower(h);
  11765. if (!t.hostname.empty()) {
  11766. struct in_addr v4;
  11767. struct in6_addr v6;
  11768. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  11769. t.is_ipv4 = true;
  11770. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  11771. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  11772. t.is_ipv6 = true;
  11773. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  11774. }
  11775. }
  11776. return t;
  11777. }
  11778. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  11779. const std::vector<NoProxyEntry> &entries) {
  11780. if (target.hostname.empty()) { return false; }
  11781. for (const auto &e : entries) {
  11782. switch (e.kind) {
  11783. case NoProxyKind::Wildcard: return true;
  11784. case NoProxyKind::IPv4Cidr:
  11785. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11786. return true;
  11787. }
  11788. break;
  11789. case NoProxyKind::IPv6Cidr:
  11790. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11791. return true;
  11792. }
  11793. break;
  11794. case NoProxyKind::HostnameSuffix:
  11795. if (target.is_ipv4 || target.is_ipv6) { break; }
  11796. if (target.hostname == e.hostname_pattern) { return true; }
  11797. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  11798. // an entry of "example.com".
  11799. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  11800. auto offset = target.hostname.size() - e.hostname_pattern.size();
  11801. if (target.hostname[offset - 1] == '.' &&
  11802. target.hostname.compare(offset, e.hostname_pattern.size(),
  11803. e.hostname_pattern) == 0) {
  11804. return true;
  11805. }
  11806. }
  11807. break;
  11808. }
  11809. }
  11810. return false;
  11811. }
  11812. template <typename T>
  11813. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11814. T header_writer, Error &error) {
  11815. for (const auto &h : headers) {
  11816. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11817. error = Error::InvalidHeaders;
  11818. return false;
  11819. }
  11820. }
  11821. if (header_writer(strm, headers) <= 0) {
  11822. error = Error::Write;
  11823. return false;
  11824. }
  11825. return true;
  11826. }
  11827. } // namespace detail
  11828. /*
  11829. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11830. */
  11831. #ifdef CPPHTTPLIB_SSL_ENABLED
  11832. namespace detail {
  11833. // SSL socket stream implementation
  11834. inline SSLSocketStream::SSLSocketStream(
  11835. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11836. time_t read_timeout_usec, time_t write_timeout_sec,
  11837. time_t write_timeout_usec, time_t max_timeout_msec,
  11838. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11839. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11840. read_timeout_usec_(read_timeout_usec),
  11841. write_timeout_sec_(write_timeout_sec),
  11842. write_timeout_usec_(write_timeout_usec),
  11843. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11844. tls_error_.code = tls::ErrorCode::Success;
  11845. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11846. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11847. // Note: create_session() also clears this, but SSLClient currently
  11848. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11849. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11850. // SSL session was created.
  11851. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11852. #endif
  11853. }
  11854. inline SSLSocketStream::~SSLSocketStream() = default;
  11855. inline bool SSLSocketStream::is_readable() const {
  11856. return tls::pending(session_) > 0;
  11857. }
  11858. inline bool SSLSocketStream::wait_readable() const {
  11859. if (max_timeout_msec_ <= 0) {
  11860. return select_read_interruptible(sock_, read_timeout_sec_,
  11861. read_timeout_usec_, read_interrupted_) > 0;
  11862. }
  11863. time_t read_timeout_sec;
  11864. time_t read_timeout_usec;
  11865. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11866. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11867. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11868. read_interrupted_) > 0;
  11869. }
  11870. inline bool SSLSocketStream::wait_writable() const {
  11871. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11872. !tls::is_peer_closed(session_, sock_);
  11873. }
  11874. inline bool SSLSocketStream::ensure_readable() {
  11875. if (readable_hint_) {
  11876. readable_hint_ = false;
  11877. return true;
  11878. }
  11879. return wait_readable();
  11880. }
  11881. inline bool SSLSocketStream::is_peer_alive() const {
  11882. return !tls::is_peer_closed(session_, sock_);
  11883. }
  11884. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11885. if (tls::pending(session_) > 0) {
  11886. tls::TlsError err;
  11887. auto ret = tls::read(session_, ptr, size, err);
  11888. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11889. error_ = Error::ConnectionClosed;
  11890. } else if (ret < 0) {
  11891. tls_error_ = err;
  11892. }
  11893. return ret;
  11894. } else if (ensure_readable()) {
  11895. tls::TlsError err;
  11896. auto ret = tls::read(session_, ptr, size, err);
  11897. if (ret < 0) {
  11898. auto n = 1000;
  11899. #ifdef _WIN32
  11900. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11901. (err.code == tls::ErrorCode::SyscallError &&
  11902. WSAGetLastError() == WSAETIMEDOUT))) {
  11903. #else
  11904. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11905. #endif
  11906. if (tls::pending(session_) > 0) {
  11907. ret = tls::read(session_, ptr, size, err);
  11908. if (ret >= 0) { return ret; }
  11909. break;
  11910. } else if (wait_readable()) {
  11911. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11912. ret = tls::read(session_, ptr, size, err);
  11913. if (ret >= 0) { return ret; }
  11914. } else {
  11915. break;
  11916. }
  11917. }
  11918. assert(ret < 0);
  11919. tls_error_ = err;
  11920. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11921. error_ = Error::ConnectionClosed;
  11922. }
  11923. return ret;
  11924. } else {
  11925. error_ = Error::Timeout;
  11926. return -1;
  11927. }
  11928. }
  11929. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11930. if (wait_writable()) {
  11931. auto handle_size =
  11932. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11933. tls::TlsError err;
  11934. auto ret = tls::write(session_, ptr, handle_size, err);
  11935. if (ret < 0) {
  11936. auto n = 1000;
  11937. #ifdef _WIN32
  11938. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11939. (err.code == tls::ErrorCode::SyscallError &&
  11940. WSAGetLastError() == WSAETIMEDOUT))) {
  11941. #else
  11942. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11943. #endif
  11944. if (wait_writable()) {
  11945. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11946. ret = tls::write(session_, ptr, handle_size, err);
  11947. if (ret >= 0) { return ret; }
  11948. } else {
  11949. break;
  11950. }
  11951. }
  11952. assert(ret < 0);
  11953. tls_error_ = err;
  11954. }
  11955. return ret;
  11956. }
  11957. return -1;
  11958. }
  11959. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11960. int &port) const {
  11961. detail::get_remote_ip_and_port(sock_, ip, port);
  11962. }
  11963. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11964. int &port) const {
  11965. detail::get_local_ip_and_port(sock_, ip, port);
  11966. }
  11967. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11968. inline time_t SSLSocketStream::duration() const {
  11969. return static_cast<time_t>(
  11970. std::chrono::duration_cast<std::chrono::milliseconds>(
  11971. std::chrono::steady_clock::now() - start_time_)
  11972. .count());
  11973. }
  11974. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11975. read_timeout_sec_ = sec;
  11976. read_timeout_usec_ = usec;
  11977. }
  11978. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11979. max_timeout_msec_ = msec;
  11980. start_time_ = std::chrono::steady_clock::now();
  11981. }
  11982. inline void
  11983. SSLSocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11984. read_interrupted_ = std::move(interrupted);
  11985. }
  11986. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11987. tls::session_t session,
  11988. time_t read_timeout_sec,
  11989. time_t read_timeout_usec,
  11990. time_t write_timeout_sec,
  11991. time_t write_timeout_usec)
  11992. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11993. read_timeout_usec_(read_timeout_usec),
  11994. write_timeout_sec_(write_timeout_sec),
  11995. write_timeout_usec_(write_timeout_usec),
  11996. start_time_(std::chrono::steady_clock::now().time_since_epoch().count()) {
  11997. // The receive and send paths run on different threads, so each TLS call is
  11998. // driven in non-blocking mode and readiness is awaited with select()
  11999. // outside the session lock. Set the socket non-blocking once here; it is
  12000. // never flipped back, so no thread races on the flag.
  12001. detail::set_nonblocking(sock_, true);
  12002. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  12003. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  12004. #endif
  12005. }
  12006. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  12007. inline bool WebSocketSSLStream::is_readable() const {
  12008. std::lock_guard<std::mutex> guard(session_mutex_);
  12009. return tls::pending(session_) > 0;
  12010. }
  12011. inline bool WebSocketSSLStream::wait_readable() const {
  12012. auto max_timeout_msec = max_timeout_msec_.load();
  12013. if (max_timeout_msec <= 0) {
  12014. return select_read_interruptible(sock_, read_timeout_sec_,
  12015. read_timeout_usec_, read_interrupted_) > 0;
  12016. }
  12017. time_t read_timeout_sec;
  12018. time_t read_timeout_usec;
  12019. calc_actual_timeout(max_timeout_msec, duration(), read_timeout_sec_,
  12020. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  12021. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  12022. read_interrupted_) > 0;
  12023. }
  12024. inline bool WebSocketSSLStream::wait_writable() const {
  12025. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  12026. // that probe toggles the socket's blocking flag, which would race with the
  12027. // concurrent reader on a permanently non-blocking socket.
  12028. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  12029. }
  12030. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  12031. tls::TlsError err;
  12032. auto n = 1000;
  12033. while (--n >= 0) {
  12034. {
  12035. std::lock_guard<std::mutex> guard(session_mutex_);
  12036. auto ret = tls::read(session_, ptr, size, err);
  12037. if (ret > 0) { return ret; }
  12038. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  12039. error_ = Error::ConnectionClosed;
  12040. return ret;
  12041. }
  12042. }
  12043. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  12044. // direction: the send path shares this session, so output it left pending
  12045. // has to be flushed before more input can be decrypted. Anything else is
  12046. // a hard error.
  12047. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  12048. #ifdef _WIN32
  12049. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  12050. needs_readable =
  12051. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  12052. WSAGetLastError() == WSAETIMEDOUT);
  12053. #endif
  12054. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  12055. error_ = Error::Read;
  12056. return -1;
  12057. }
  12058. if (!(needs_readable ? wait_readable() : wait_writable())) {
  12059. error_ = Error::Timeout;
  12060. return -1;
  12061. }
  12062. }
  12063. // Out of retries. Recording a reason matters: a caller that reads get_error()
  12064. // to tell a timeout from a close would otherwise see whatever the previous
  12065. // failure left behind (error_ is never cleared on success).
  12066. error_ = Error::Read;
  12067. return -1;
  12068. }
  12069. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  12070. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  12071. tls::TlsError err;
  12072. auto n = 1000;
  12073. while (--n >= 0) {
  12074. {
  12075. std::lock_guard<std::mutex> guard(session_mutex_);
  12076. auto ret = tls::write(session_, ptr, handle_size, err);
  12077. if (ret >= 0) { return ret; }
  12078. }
  12079. // ret < 0. As in read(), either direction can be needed: a renegotiation
  12080. // or a post-handshake message must be consumed before the record goes
  12081. // out. Anything else is a hard error.
  12082. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  12083. #ifdef _WIN32
  12084. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  12085. needs_writable =
  12086. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  12087. WSAGetLastError() == WSAETIMEDOUT);
  12088. #endif
  12089. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  12090. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  12091. }
  12092. return -1;
  12093. }
  12094. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  12095. int &port) const {
  12096. detail::get_remote_ip_and_port(sock_, ip, port);
  12097. }
  12098. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  12099. int &port) const {
  12100. detail::get_local_ip_and_port(sock_, ip, port);
  12101. }
  12102. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  12103. inline time_t WebSocketSSLStream::duration() const {
  12104. auto start = std::chrono::steady_clock::time_point(
  12105. std::chrono::steady_clock::duration(start_time_.load()));
  12106. return static_cast<time_t>(
  12107. std::chrono::duration_cast<std::chrono::milliseconds>(
  12108. std::chrono::steady_clock::now() - start)
  12109. .count());
  12110. }
  12111. // Start time first: a reader that sees the new bound also sees its start
  12112. inline void WebSocketSSLStream::set_max_timeout(time_t msec) {
  12113. start_time_ = std::chrono::steady_clock::now().time_since_epoch().count();
  12114. max_timeout_msec_ = msec;
  12115. }
  12116. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  12117. read_timeout_sec_ = sec;
  12118. read_timeout_usec_ = usec;
  12119. }
  12120. inline void
  12121. WebSocketSSLStream::set_read_interrupt(std::function<bool()> interrupted) {
  12122. read_interrupted_ = std::move(interrupted);
  12123. }
  12124. } // namespace detail
  12125. #endif // CPPHTTPLIB_SSL_ENABLED
  12126. /*
  12127. * Group 4: Server implementation
  12128. */
  12129. // HTTP server implementation
  12130. inline Server::Server()
  12131. : new_task_queue([] {
  12132. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  12133. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  12134. }) {
  12135. #ifndef _WIN32
  12136. signal(SIGPIPE, SIG_IGN);
  12137. #endif
  12138. }
  12139. inline Server::~Server() = default;
  12140. inline std::unique_ptr<detail::MatcherBase>
  12141. Server::make_matcher(const std::string &pattern) {
  12142. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  12143. // a path params pattern
  12144. if (pattern.find("/:") != std::string::npos) {
  12145. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  12146. }
  12147. // A pattern with no regex metacharacter only has to be compared literally,
  12148. // which is what PathParamsMatcher already does when it captures no
  12149. // parameter, so std::regex is only worth building for the patterns that
  12150. // actually need it
  12151. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  12152. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  12153. }
  12154. return detail::make_unique<detail::RegexMatcher>(pattern);
  12155. }
  12156. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  12157. return add_handler(get_handlers_, pattern, std::move(handler));
  12158. }
  12159. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  12160. return add_handler(post_handlers_, pattern, std::move(handler));
  12161. }
  12162. inline Server &Server::Post(const std::string &pattern,
  12163. HandlerWithContentReader handler) {
  12164. return add_handler(post_handlers_for_content_reader_, pattern,
  12165. std::move(handler));
  12166. }
  12167. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  12168. return add_handler(put_handlers_, pattern, std::move(handler));
  12169. }
  12170. inline Server &Server::Put(const std::string &pattern,
  12171. HandlerWithContentReader handler) {
  12172. return add_handler(put_handlers_for_content_reader_, pattern,
  12173. std::move(handler));
  12174. }
  12175. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  12176. return add_handler(patch_handlers_, pattern, std::move(handler));
  12177. }
  12178. inline Server &Server::Patch(const std::string &pattern,
  12179. HandlerWithContentReader handler) {
  12180. return add_handler(patch_handlers_for_content_reader_, pattern,
  12181. std::move(handler));
  12182. }
  12183. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  12184. return add_handler(delete_handlers_, pattern, std::move(handler));
  12185. }
  12186. inline Server &Server::Delete(const std::string &pattern,
  12187. HandlerWithContentReader handler) {
  12188. return add_handler(delete_handlers_for_content_reader_, pattern,
  12189. std::move(handler));
  12190. }
  12191. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  12192. return add_handler(options_handlers_, pattern, std::move(handler));
  12193. }
  12194. inline const std::set<std::string> &Server::builtin_methods() {
  12195. thread_local const std::set<std::string> methods{
  12196. "GET", "HEAD", "POST", "PUT", "DELETE",
  12197. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  12198. return methods;
  12199. }
  12200. inline Server::CustomHandlerEntry *
  12201. Server::custom_entry_for_registration(const std::string &method) {
  12202. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  12203. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  12204. // routing() before the custom tables are consulted, so a route registered
  12205. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  12206. // there and would be reachable, but they carry protocol-level meaning
  12207. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  12208. // library does not route.
  12209. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  12210. output_error_log(Error::InvalidHTTPMethod, nullptr);
  12211. has_invalid_registration_ = true;
  12212. return nullptr;
  12213. }
  12214. return &custom_handlers_[method];
  12215. }
  12216. inline Server &Server::CustomRoute(const std::string &method,
  12217. const std::string &pattern,
  12218. Handler handler) {
  12219. auto *entry = custom_entry_for_registration(method);
  12220. if (!entry) { return *this; }
  12221. return add_handler(entry->handlers, pattern, std::move(handler));
  12222. }
  12223. inline Server &Server::CustomRoute(const std::string &method,
  12224. const std::string &pattern,
  12225. HandlerWithContentReader handler) {
  12226. auto *entry = custom_entry_for_registration(method);
  12227. if (!entry) { return *this; }
  12228. return add_handler(entry->handlers_for_content_reader, pattern,
  12229. std::move(handler));
  12230. }
  12231. inline const Server::CustomHandlerEntry *
  12232. Server::find_custom_entry(const std::string &method) const {
  12233. // find() alone would be correct here. The empty() check is what keeps the
  12234. // per-request cost off servers that never call CustomRoute(), which is the
  12235. // overwhelmingly common case; keep it rather than walking into the tree.
  12236. if (custom_handlers_.empty()) { return nullptr; }
  12237. auto it = custom_handlers_.find(method);
  12238. return it == custom_handlers_.end() ? nullptr : &it->second;
  12239. }
  12240. inline Server &Server::WebSocket(const std::string &pattern,
  12241. WebSocketHandler handler) {
  12242. websocket_handlers_.push_back(
  12243. {make_matcher(pattern), std::move(handler), nullptr});
  12244. return *this;
  12245. }
  12246. inline Server &Server::WebSocket(const std::string &pattern,
  12247. WebSocketHandler handler,
  12248. SubProtocolSelector sub_protocol_selector) {
  12249. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  12250. std::move(sub_protocol_selector)});
  12251. return *this;
  12252. }
  12253. inline bool Server::set_base_dir(const std::string &dir,
  12254. const std::string &mount_point) {
  12255. return set_mount_point(mount_point, dir);
  12256. }
  12257. inline bool Server::set_mount_point(const std::string &mount_point,
  12258. const std::string &dir, Headers headers) {
  12259. detail::FileStat stat(dir);
  12260. if (stat.is_dir()) {
  12261. std::string mnt = !mount_point.empty() ? mount_point : "/";
  12262. if (!mnt.empty() && mnt[0] == '/') {
  12263. // Without the resolved directory, a file could not be checked to be
  12264. // inside it.
  12265. std::string resolved_base;
  12266. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  12267. return false;
  12268. }
  12269. #if defined(_WIN32)
  12270. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  12271. resolved_base += '\\';
  12272. }
  12273. #else
  12274. if (resolved_base.back() != '/') { resolved_base += '/'; }
  12275. #endif
  12276. base_dirs_.push_back(
  12277. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  12278. return true;
  12279. }
  12280. }
  12281. return false;
  12282. }
  12283. inline bool Server::remove_mount_point(const std::string &mount_point) {
  12284. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  12285. if (it->mount_point == mount_point) {
  12286. base_dirs_.erase(it);
  12287. return true;
  12288. }
  12289. }
  12290. return false;
  12291. }
  12292. inline Server &
  12293. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  12294. const std::string &mime) {
  12295. // Keyed as find_content_type() looks it up
  12296. auto key = detail::case_ignore::to_lower(ext);
  12297. if (!key.empty() && key[0] == '.') { key.erase(0, 1); }
  12298. file_extension_and_mimetype_map_[key] = mime;
  12299. return *this;
  12300. }
  12301. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  12302. default_file_mimetype_ = mime;
  12303. return *this;
  12304. }
  12305. inline Server &Server::set_file_request_handler(Handler handler) {
  12306. file_request_handler_ = std::move(handler);
  12307. return *this;
  12308. }
  12309. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  12310. std::true_type) {
  12311. error_handler_ = std::move(handler);
  12312. return *this;
  12313. }
  12314. inline Server &Server::set_error_handler_core(Handler handler,
  12315. std::false_type) {
  12316. error_handler_ = [handler](const Request &req, Response &res) {
  12317. handler(req, res);
  12318. return HandlerResponse::Handled;
  12319. };
  12320. return *this;
  12321. }
  12322. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  12323. exception_handler_ = std::move(handler);
  12324. return *this;
  12325. }
  12326. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  12327. pre_routing_handler_ = std::move(handler);
  12328. return *this;
  12329. }
  12330. inline Server &Server::set_post_routing_handler(Handler handler) {
  12331. post_routing_handler_ = std::move(handler);
  12332. return *this;
  12333. }
  12334. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  12335. pre_request_handler_ = std::move(handler);
  12336. return *this;
  12337. }
  12338. inline Server &Server::set_logger(Logger logger) {
  12339. logger_ = std::move(logger);
  12340. return *this;
  12341. }
  12342. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  12343. error_logger_ = std::move(error_logger);
  12344. return *this;
  12345. }
  12346. inline Server &Server::set_pre_compression_logger(Logger logger) {
  12347. pre_compression_logger_ = std::move(logger);
  12348. return *this;
  12349. }
  12350. inline Server &
  12351. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  12352. expect_100_continue_handler_ = std::move(handler);
  12353. return *this;
  12354. }
  12355. inline Server &Server::set_start_handler(StartHandler handler) {
  12356. start_handler_ = std::move(handler);
  12357. return *this;
  12358. }
  12359. inline Server &Server::set_address_family(int family) {
  12360. address_family_ = family;
  12361. return *this;
  12362. }
  12363. inline Server &Server::set_tcp_nodelay(bool on) {
  12364. tcp_nodelay_ = on;
  12365. return *this;
  12366. }
  12367. inline Server &Server::set_ipv6_v6only(bool on) {
  12368. ipv6_v6only_ = on;
  12369. return *this;
  12370. }
  12371. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  12372. socket_options_ = std::move(socket_options);
  12373. return *this;
  12374. }
  12375. inline Server &Server::set_default_headers(Headers headers) {
  12376. default_headers_ = std::move(headers);
  12377. return *this;
  12378. }
  12379. inline Server &Server::set_header_writer(
  12380. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  12381. header_writer_ = writer;
  12382. return *this;
  12383. }
  12384. inline Server &
  12385. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  12386. trusted_proxies_.clear();
  12387. trusted_proxies_.reserve(proxies.size());
  12388. for (const auto &proxy : proxies) {
  12389. trusted_proxies_.push_back(detail::canonical_ip(proxy));
  12390. }
  12391. return *this;
  12392. }
  12393. inline Server &Server::set_keep_alive_max_count(size_t count) {
  12394. keep_alive_max_count_ = count;
  12395. return *this;
  12396. }
  12397. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  12398. keep_alive_timeout_sec_ = sec;
  12399. return *this;
  12400. }
  12401. template <class Rep, class Period>
  12402. inline Server &Server::set_keep_alive_timeout(
  12403. const std::chrono::duration<Rep, Period> &duration) {
  12404. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  12405. set_keep_alive_timeout(sec);
  12406. });
  12407. return *this;
  12408. }
  12409. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  12410. read_timeout_sec_ = sec;
  12411. read_timeout_usec_ = usec;
  12412. return *this;
  12413. }
  12414. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  12415. write_timeout_sec_ = sec;
  12416. write_timeout_usec_ = usec;
  12417. return *this;
  12418. }
  12419. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  12420. idle_interval_sec_ = sec;
  12421. idle_interval_usec_ = usec;
  12422. return *this;
  12423. }
  12424. inline Server &Server::set_payload_max_length(size_t length) {
  12425. payload_max_length_ = length;
  12426. return *this;
  12427. }
  12428. inline Server &Server::set_compress(bool on) {
  12429. compress_ = on;
  12430. return *this;
  12431. }
  12432. inline Server &Server::set_static_file_compression(bool on) {
  12433. static_file_compression_ = on;
  12434. return *this;
  12435. }
  12436. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  12437. static_file_compression_min_length_ = length;
  12438. return *this;
  12439. }
  12440. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  12441. static_file_compression_max_length_ = length;
  12442. return *this;
  12443. }
  12444. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  12445. websocket_max_missed_pongs_ = count;
  12446. return *this;
  12447. }
  12448. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  12449. websocket_ping_interval_sec_ = sec;
  12450. return *this;
  12451. }
  12452. template <class Rep, class Period>
  12453. inline Server &Server::set_websocket_ping_interval(
  12454. const std::chrono::duration<Rep, Period> &duration) {
  12455. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  12456. set_websocket_ping_interval(sec);
  12457. });
  12458. return *this;
  12459. }
  12460. inline bool Server::bind_to_port(const std::string &host, int port,
  12461. int socket_flags) {
  12462. auto ret = bind_internal(host, port, socket_flags);
  12463. if (ret == -1) { is_decommissioned = true; }
  12464. return ret >= 0;
  12465. }
  12466. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  12467. auto ret = bind_internal(host, 0, socket_flags);
  12468. if (ret == -1) { is_decommissioned = true; }
  12469. return ret;
  12470. }
  12471. inline bool Server::listen_after_bind() { return listen_internal(); }
  12472. inline bool Server::listen(const std::string &host, int port,
  12473. int socket_flags) {
  12474. return bind_to_port(host, port, socket_flags) && listen_internal();
  12475. }
  12476. inline bool Server::is_running() const { return is_running_; }
  12477. inline void Server::wait_until_ready() const {
  12478. while (!is_running_ && !is_decommissioned) {
  12479. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12480. }
  12481. }
  12482. inline void Server::stop() noexcept {
  12483. // Release the listening socket whether or not the accept loop is running:
  12484. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  12485. // exchange is what makes this safe to call concurrently with the accept loop.
  12486. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  12487. if (sock != INVALID_SOCKET) {
  12488. detail::shutdown_socket(sock);
  12489. detail::close_socket(sock);
  12490. }
  12491. is_decommissioned = false;
  12492. }
  12493. inline void Server::decommission() { is_decommissioned = true; }
  12494. inline bool Server::parse_request_line(const char *s, Request &req) const {
  12495. auto len = strlen(s);
  12496. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  12497. len -= 2;
  12498. {
  12499. // RFC 9112 §3: exactly one SP between the method, the target and the
  12500. // version. Taking other whitespace as a separator too lets recipients
  12501. // that parse more strictly see a different request.
  12502. auto end = s + len;
  12503. if (std::count(s, end, ' ') != 2) { return false; }
  12504. auto sp1 = std::find(s, end, ' ');
  12505. auto sp2 = std::find(sp1 + 1, end, ' ');
  12506. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  12507. req.method.assign(s, sp1);
  12508. req.target.assign(sp1 + 1, sp2);
  12509. req.version.assign(sp2 + 1, end);
  12510. }
  12511. // A method outside the built-in set is accepted only when a handler has been
  12512. // registered for it with CustomRoute().
  12513. const auto &methods = builtin_methods();
  12514. if (methods.find(req.method) == methods.end() &&
  12515. !find_custom_entry(req.method)) {
  12516. output_error_log(Error::InvalidHTTPMethod, &req);
  12517. return false;
  12518. }
  12519. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  12520. output_error_log(Error::InvalidHTTPVersion, &req);
  12521. return false;
  12522. }
  12523. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  12524. // would leave this server routing a different path than a cache or a
  12525. // filter in front of it sees.
  12526. if (!detail::fields::is_request_target(req.target) ||
  12527. req.target.find('#') != std::string::npos) {
  12528. return false;
  12529. }
  12530. {
  12531. detail::divide(req.target, '?',
  12532. [&](const char *lhs_data, std::size_t lhs_size,
  12533. const char *rhs_data, std::size_t rhs_size) {
  12534. req.path =
  12535. decode_path_component(std::string(lhs_data, lhs_size));
  12536. detail::parse_query_text(rhs_data, rhs_size, req.params);
  12537. });
  12538. }
  12539. return true;
  12540. }
  12541. inline bool Server::write_response(Stream &strm, bool close_connection,
  12542. Request &req, Response &res) {
  12543. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  12544. // incorrectly to the error content.
  12545. req.ranges.clear();
  12546. return write_response_core(strm, close_connection, req, res, false);
  12547. }
  12548. inline bool Server::write_response_with_content(Stream &strm,
  12549. bool close_connection,
  12550. const Request &req,
  12551. Response &res) {
  12552. return write_response_core(strm, close_connection, req, res, true);
  12553. }
  12554. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  12555. const Request &req, Response &res,
  12556. bool need_apply_ranges) {
  12557. assert(res.status != -1);
  12558. if (400 <= res.status && error_handler_ &&
  12559. error_handler_(req, res) == HandlerResponse::Handled) {
  12560. need_apply_ranges = true;
  12561. }
  12562. // Before anything below reads res.headers, which the handlers may have
  12563. // filled directly
  12564. detail::erase_invalid_fields(res.headers);
  12565. if (!detail::body_allowed_for_status(res.status)) {
  12566. detail::clear_content(res);
  12567. }
  12568. detail::prefer_assigned_body(res);
  12569. std::string content_type;
  12570. std::string boundary;
  12571. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  12572. // Prepare additional headers
  12573. if (close_connection ||
  12574. detail::has_header_token(req.headers, "Connection", "close") ||
  12575. 400 <= res.status || // Don't leave connections open after errors
  12576. // The client withholds the body until `100 Continue`, which was never
  12577. // sent, so whether and when the body follows is unknown.
  12578. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  12579. // The body was left partway, e.g. by a content receiver that returned
  12580. // false, so the rest of it cannot be told from the next request.
  12581. (req.body_read_started_ && !req.body_consumed_)) {
  12582. res.set_header("Connection", "close");
  12583. } else {
  12584. std::string s = "timeout=";
  12585. s += std::to_string(keep_alive_timeout_sec_);
  12586. if (keep_alive_max_count_ > 0) {
  12587. s += ", max=";
  12588. s += std::to_string(keep_alive_max_count_);
  12589. }
  12590. res.set_header("Keep-Alive", s);
  12591. }
  12592. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  12593. !res.has_header("Content-Type")) {
  12594. res.set_header("Content-Type", "text/plain");
  12595. }
  12596. detail::set_framing_headers(req, res, boundary, content_type);
  12597. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  12598. res.set_header("Accept-Ranges", "bytes");
  12599. }
  12600. if (post_routing_handler_) {
  12601. post_routing_handler_(req, res);
  12602. detail::erase_invalid_fields(res.headers);
  12603. // Again, for a body or framing headers the handler changed.
  12604. detail::set_framing_headers(req, res, boundary, content_type);
  12605. }
  12606. // Response line and headers
  12607. detail::BufferStream bstrm;
  12608. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  12609. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  12610. // Combine a small body with the headers so the whole response leaves in a
  12611. // single write. A large body is written on its own instead: a copy of it
  12612. // costs more than the extra write saves.
  12613. auto send_body =
  12614. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  12615. auto body_is_separate = false;
  12616. auto provider_done = false;
  12617. if (send_body && !res.body.empty() && !res.content_provider_) {
  12618. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  12619. bstrm.write(res.body.data(), res.body.size());
  12620. } else {
  12621. body_is_separate = true;
  12622. }
  12623. } else if (send_body && res.content_provider_ &&
  12624. res.is_file_content_provider_ &&
  12625. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  12626. // A small file is read into the same buffer. Other providers may produce
  12627. // their data over time, so they are never held back.
  12628. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  12629. return false;
  12630. }
  12631. provider_done = true;
  12632. }
  12633. // Log before writing to avoid race condition with client-side code that
  12634. // accesses logger-captured data immediately after receiving the response.
  12635. output_log(req, res);
  12636. // Flush buffer
  12637. auto &data = bstrm.get_buffer();
  12638. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  12639. if (body_is_separate) {
  12640. return detail::write_data(strm, res.body.data(), res.body.size());
  12641. }
  12642. // Streaming body
  12643. if (send_body && res.content_provider_) {
  12644. if (!provider_done &&
  12645. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  12646. return false;
  12647. }
  12648. res.content_provider_success_ = true;
  12649. }
  12650. return true;
  12651. }
  12652. inline bool
  12653. Server::write_content_with_provider(Stream &strm, const Request &req,
  12654. Response &res, const std::string &boundary,
  12655. const std::string &content_type) {
  12656. auto is_shutting_down = [this]() { return is_stopping(); };
  12657. if (res.content_length_ > 0) {
  12658. if (!detail::is_partial_content(req, res)) {
  12659. return detail::write_content(strm, res.content_provider_, 0,
  12660. res.content_length_, is_shutting_down);
  12661. } else if (req.ranges.size() == 1) {
  12662. auto offset_and_length = detail::get_range_offset_and_length(
  12663. req.ranges[0], res.content_length_);
  12664. return detail::write_content(strm, res.content_provider_,
  12665. offset_and_length.first,
  12666. offset_and_length.second, is_shutting_down);
  12667. } else {
  12668. return detail::write_multipart_ranges_data(
  12669. strm, req, res, boundary, content_type, res.content_length_,
  12670. is_shutting_down);
  12671. }
  12672. } else {
  12673. if (res.is_chunked_content_provider_) {
  12674. // Use the coding `apply_ranges()` chose when it wrote the headers;
  12675. // re-negotiating here would disagree with them, e.g. once a handler's
  12676. // own Content-Encoding header suppresses the negotiation.
  12677. auto compressor = detail::make_compressor(res.content_coding_);
  12678. if (!compressor) {
  12679. compressor = detail::make_unique<detail::nocompressor>();
  12680. }
  12681. return detail::write_content_chunked(strm, res.content_provider_,
  12682. is_shutting_down, *compressor);
  12683. } else {
  12684. return detail::write_content_without_length(strm, res.content_provider_,
  12685. is_shutting_down);
  12686. }
  12687. }
  12688. }
  12689. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  12690. FormFields::iterator cur_field;
  12691. FormFiles::iterator cur_file;
  12692. auto is_text_field = false;
  12693. size_t count = 0;
  12694. if (read_content_core(
  12695. strm, req, res,
  12696. // Regular
  12697. [&](const char *buf, size_t n) {
  12698. // Prevent arithmetic overflow when checking sizes.
  12699. // Avoid computing (req.body.size() + n) directly because
  12700. // adding two unsigned `size_t` values can wrap around and
  12701. // produce a small result instead of indicating overflow.
  12702. // Instead, check using subtraction: ensure `n` does not
  12703. // exceed the remaining capacity `max_size() - size()`.
  12704. if (req.body.size() >= req.body.max_size() ||
  12705. n > req.body.max_size() - req.body.size()) {
  12706. return false;
  12707. }
  12708. // Limit decompressed body size to payload_max_length_ to protect
  12709. // against "zip bomb" attacks where a small compressed payload
  12710. // decompresses to a massive size.
  12711. if (payload_max_length_ > 0 &&
  12712. (req.body.size() >= payload_max_length_ ||
  12713. n > payload_max_length_ - req.body.size())) {
  12714. return false;
  12715. }
  12716. req.body.append(buf, n);
  12717. return true;
  12718. },
  12719. // Multipart FormData
  12720. [&](const FormData &file) {
  12721. if (CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT > 0 &&
  12722. count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  12723. output_error_log(Error::TooManyFormDataFiles, &req);
  12724. return false;
  12725. }
  12726. if (file.filename.empty()) {
  12727. cur_field = req.form.fields.emplace(
  12728. file.name, FormField{file.name, file.content, file.headers});
  12729. is_text_field = true;
  12730. } else {
  12731. cur_file = req.form.files.emplace(file.name, file);
  12732. is_text_field = false;
  12733. }
  12734. return true;
  12735. },
  12736. [&](const char *buf, size_t n) {
  12737. if (is_text_field) {
  12738. auto &content = cur_field->second.content;
  12739. if (content.size() + n > content.max_size()) { return false; }
  12740. content.append(buf, n);
  12741. } else {
  12742. auto &content = cur_file->second.content;
  12743. if (content.size() + n > content.max_size()) { return false; }
  12744. content.append(buf, n);
  12745. }
  12746. return true;
  12747. })) {
  12748. const auto &content_type = req.get_header_value("Content-Type");
  12749. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  12750. "application/x-www-form-urlencoded")) {
  12751. if (CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH > 0 &&
  12752. req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  12753. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  12754. output_error_log(Error::ExceedMaxPayloadSize, &req);
  12755. return false;
  12756. }
  12757. detail::parse_query_text(req.body, req.params);
  12758. }
  12759. return true;
  12760. }
  12761. return false;
  12762. }
  12763. inline bool Server::read_content_with_content_receiver(
  12764. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12765. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  12766. return read_content_core(strm, req, res, std::move(receiver),
  12767. std::move(multipart_header),
  12768. std::move(multipart_receiver));
  12769. }
  12770. inline bool Server::read_content_core(
  12771. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12772. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  12773. detail::FormDataParser multipart_form_data_parser;
  12774. ContentReceiverWithProgress out;
  12775. if (req.is_multipart_form_data()) {
  12776. const auto &content_type = req.get_header_value("Content-Type");
  12777. std::string boundary;
  12778. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  12779. res.status = StatusCode::BadRequest_400;
  12780. output_error_log(Error::MultipartParsing, &req);
  12781. return false;
  12782. }
  12783. multipart_form_data_parser.set_boundary(std::move(boundary));
  12784. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  12785. return multipart_form_data_parser.parse(buf, n, multipart_header,
  12786. multipart_receiver);
  12787. };
  12788. } else {
  12789. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  12790. size_t /*len*/) { return receiver(buf, n); };
  12791. }
  12792. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  12793. if (!req.has_header("Content-Length") &&
  12794. !detail::is_chunked_transfer_encoding(req.headers)) {
  12795. return true;
  12796. }
  12797. // A second read would start where the first one stopped, or in the next
  12798. // request.
  12799. if (req.body_read_started_) { return false; }
  12800. // The client is waiting for this before it sends the body.
  12801. if (req.expect_100_continue_pending_) {
  12802. req.expect_100_continue_pending_ = false;
  12803. detail::write_response_line(strm, StatusCode::Continue_100);
  12804. strm.write("\r\n");
  12805. }
  12806. // Set before reading, since a receiver may also stop by throwing.
  12807. req.body_read_started_ = true;
  12808. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  12809. out, true)) {
  12810. return false;
  12811. }
  12812. req.body_consumed_ = true;
  12813. if (req.is_multipart_form_data()) {
  12814. if (!multipart_form_data_parser.is_valid()) {
  12815. res.status = StatusCode::BadRequest_400;
  12816. output_error_log(Error::MultipartParsing, &req);
  12817. return false;
  12818. }
  12819. }
  12820. return true;
  12821. }
  12822. inline bool Server::handle_file_request(Request &req, Response &res) {
  12823. if (!detail::is_valid_path(req.path)) { return false; }
  12824. for (const auto &entry : base_dirs_) {
  12825. // Prefix match, on a path segment boundary. A mount point of "/mount"
  12826. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  12827. // One that already ends in '/' (the root mount among them) carries its own
  12828. // boundary; set_mount_point() guarantees the mount point is not empty.
  12829. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  12830. (entry.mount_point.back() == '/' ||
  12831. req.path.size() == entry.mount_point.size() ||
  12832. req.path[entry.mount_point.size()] == '/')) {
  12833. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  12834. auto path = entry.base_dir + sub_path;
  12835. if (path.back() == '/') { path += "index.html"; }
  12836. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12837. // but symlinks/junctions can still escape the base directory. A path
  12838. // that cannot be resolved, which includes one that does not exist, is
  12839. // not served from here.
  12840. std::string resolved_path;
  12841. if (!detail::canonicalize_path(path.c_str(), resolved_path)) { continue; }
  12842. if (!detail::is_path_within_base(resolved_path,
  12843. entry.resolved_base_dir)) {
  12844. res.status = StatusCode::Forbidden_403;
  12845. return true;
  12846. }
  12847. detail::FileStat stat(path);
  12848. if (stat.is_dir()) {
  12849. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12850. // in the name from reading as a scheme.
  12851. auto name = req.path.substr(req.path.rfind('/') + 1);
  12852. res.set_redirect("./" + encode_path_component(name) + "/",
  12853. StatusCode::MovedPermanently_301);
  12854. return true;
  12855. }
  12856. if (stat.is_file()) {
  12857. for (const auto &kv : entry.headers) {
  12858. res.set_header(kv.first, kv.second);
  12859. }
  12860. auto content_type = detail::find_content_type(
  12861. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12862. auto encoding = detail::EncodingType::None;
  12863. if (static_file_compression_) {
  12864. encoding = static_file_encoding(req, res, content_type, stat.size());
  12865. }
  12866. // The ETag names the representation actually sent, so a client that
  12867. // cached the compressed form revalidates against the compressed ETag
  12868. // and still gets a 304, while one that took identity keeps the plain
  12869. // ETag.
  12870. auto etag = detail::compute_etag(
  12871. stat, encoding == detail::EncodingType::None
  12872. ? std::string()
  12873. : std::string("-") + detail::encoding_name(encoding));
  12874. if (!etag.empty()) { res.set_header("ETag", etag); }
  12875. auto mtime = stat.mtime();
  12876. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12877. if (!last_modified.empty()) {
  12878. res.set_header("Last-Modified", last_modified);
  12879. }
  12880. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12881. check_if_range(req, etag, mtime);
  12882. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12883. if (!mm->is_open()) {
  12884. output_error_log(Error::OpenFile, &req);
  12885. return false;
  12886. }
  12887. detail::set_file_content_provider(res, mm, content_type, encoding);
  12888. if (req.method != "HEAD" && file_request_handler_) {
  12889. file_request_handler_(req, res);
  12890. }
  12891. return true;
  12892. } else {
  12893. output_error_log(Error::OpenFile, &req);
  12894. }
  12895. }
  12896. }
  12897. return false;
  12898. }
  12899. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12900. const std::string &etag,
  12901. time_t mtime) const {
  12902. // Handle conditional GET:
  12903. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12904. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12905. if (req.has_header("If-None-Match")) {
  12906. if (!etag.empty()) {
  12907. auto val =
  12908. detail::get_combined_header_value(req.headers, "If-None-Match");
  12909. // NOTE: We use exact string matching here. This works correctly
  12910. // because our server always generates weak ETags (W/"..."), and
  12911. // clients typically send back the same ETag they received.
  12912. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12913. // If-None-Match, where W/"x" and "x" would match, but this
  12914. // simplified implementation requires exact matches.
  12915. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12916. [&](const char *b, const char *e) {
  12917. auto seg_len = static_cast<size_t>(e - b);
  12918. return (seg_len == 1 && *b == '*') ||
  12919. (seg_len == etag.size() &&
  12920. std::equal(b, e, etag.begin()));
  12921. });
  12922. if (ret) {
  12923. res.status = StatusCode::NotModified_304;
  12924. return true;
  12925. }
  12926. }
  12927. } else if (req.has_header("If-Modified-Since")) {
  12928. auto val = req.get_header_value("If-Modified-Since");
  12929. auto t = detail::parse_http_date(val);
  12930. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12931. res.status = StatusCode::NotModified_304;
  12932. return true;
  12933. }
  12934. }
  12935. return false;
  12936. }
  12937. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12938. time_t mtime) const {
  12939. // Handle If-Range for partial content requests (RFC 9110
  12940. // Section 13.1.5). If-Range is only evaluated when Range header is
  12941. // present. If the validator matches, serve partial content; otherwise
  12942. // serve full content.
  12943. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12944. auto val = req.get_header_value("If-Range");
  12945. auto is_valid_range = [&]() {
  12946. if (detail::is_strong_etag(val)) {
  12947. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12948. // comparison.
  12949. return (!etag.empty() && val == etag);
  12950. } else if (detail::is_weak_etag(val)) {
  12951. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12952. return false;
  12953. } else {
  12954. // HTTP-date comparison
  12955. auto t = detail::parse_http_date(val);
  12956. return (t != static_cast<time_t>(-1) && mtime <= t);
  12957. }
  12958. };
  12959. if (!is_valid_range()) {
  12960. // Validator doesn't match: ignore Range and serve full content
  12961. req.ranges.clear();
  12962. return false;
  12963. }
  12964. }
  12965. return true;
  12966. }
  12967. inline socket_t
  12968. Server::create_server_socket(const std::string &host, int port,
  12969. int socket_flags,
  12970. SocketOptions socket_options) const {
  12971. return detail::create_socket(
  12972. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12973. ipv6_v6only_, std::move(socket_options),
  12974. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12975. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12976. output_error_log(Error::BindIPAddress, nullptr);
  12977. return false;
  12978. }
  12979. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12980. output_error_log(Error::Listen, nullptr);
  12981. return false;
  12982. }
  12983. return true;
  12984. });
  12985. }
  12986. inline int Server::bind_internal(const std::string &host, int port,
  12987. int socket_flags) {
  12988. if (is_decommissioned) { return -1; }
  12989. if (!is_valid()) { return -1; }
  12990. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12991. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12992. if (port == 0) {
  12993. struct sockaddr_storage addr;
  12994. socklen_t addr_len = sizeof(addr);
  12995. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12996. &addr_len) == -1) {
  12997. output_error_log(Error::GetSockName, nullptr);
  12998. return -1;
  12999. }
  13000. if (addr.ss_family == AF_INET) {
  13001. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  13002. } else if (addr.ss_family == AF_INET6) {
  13003. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  13004. } else {
  13005. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  13006. return -1;
  13007. }
  13008. } else {
  13009. return port;
  13010. }
  13011. }
  13012. inline bool Server::listen_internal() {
  13013. // A stop() between bind and listen leaves nothing to accept on. Report
  13014. // failure instead of returning success without ever serving, and mark the
  13015. // server decommissioned the way any failed listen does so that a concurrent
  13016. // wait_until_ready() wakes up instead of spinning forever.
  13017. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  13018. is_decommissioned = true;
  13019. return false;
  13020. }
  13021. auto ret = true;
  13022. is_running_ = true;
  13023. auto se = detail::scope_exit([&]() { is_running_ = false; });
  13024. if (start_handler_) { start_handler_(); }
  13025. {
  13026. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  13027. while (svr_sock_ != INVALID_SOCKET) {
  13028. #ifndef _WIN32
  13029. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  13030. #endif
  13031. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  13032. idle_interval_usec_);
  13033. if (val == 0) { // Timeout
  13034. task_queue->on_idle();
  13035. continue;
  13036. }
  13037. #ifndef _WIN32
  13038. }
  13039. #endif
  13040. #if defined _WIN32
  13041. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  13042. // OVERLAPPED
  13043. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  13044. #elif defined SOCK_CLOEXEC
  13045. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  13046. #else
  13047. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  13048. #endif
  13049. if (sock == INVALID_SOCKET) {
  13050. // NOTE: Winsock reports failures through WSAGetLastError() and never
  13051. // touches the CRT errno, so the two have to be asked platform by
  13052. // platform rather than by testing errno here.
  13053. if (detail::is_accept_resource_error()) {
  13054. // The per-process descriptor limit or the network stack's buffer
  13055. // space has been reached. Try to accept new connections after a
  13056. // short sleep.
  13057. std::this_thread::sleep_for(std::chrono::microseconds{1});
  13058. continue;
  13059. } else if (detail::is_accept_transient_error()) {
  13060. continue;
  13061. }
  13062. // Take the descriptor out of svr_sock_ before closing it: a later
  13063. // stop() would otherwise shutdown()/close() a value the OS may have
  13064. // reused, and keep_alive() watches svr_sock_ to notice the server is
  13065. // gone. The exchange also settles the race with a concurrent stop(),
  13066. // since whichever side takes the descriptor closes it exactly once.
  13067. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  13068. if (listen_sock != INVALID_SOCKET) {
  13069. detail::close_socket(listen_sock);
  13070. ret = false;
  13071. output_error_log(Error::Connection, nullptr);
  13072. } else {
  13073. ; // The server socket was closed by user.
  13074. }
  13075. break;
  13076. }
  13077. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  13078. read_timeout_sec_, read_timeout_usec_);
  13079. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  13080. write_timeout_sec_, write_timeout_usec_);
  13081. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  13082. if (!task_queue->enqueue(
  13083. [this, sock]() { process_and_close_socket(sock); })) {
  13084. output_error_log(Error::ResourceExhaustion, nullptr);
  13085. detail::shutdown_socket(sock);
  13086. detail::close_socket(sock);
  13087. }
  13088. }
  13089. task_queue->shutdown();
  13090. }
  13091. is_decommissioned = !ret;
  13092. return ret;
  13093. }
  13094. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  13095. // Call from a catch block. The response is a 500 unless the exception handler
  13096. // sets another status. Returns whether the exception handler ran.
  13097. inline bool Server::handle_exception(Request &req, Response &res) {
  13098. res.status = StatusCode::InternalServerError_500;
  13099. if (!exception_handler_) { return false; }
  13100. exception_handler_(req, res, std::current_exception());
  13101. return true;
  13102. }
  13103. #endif
  13104. inline bool Server::routing(Request &req, Response &res, Stream &strm,
  13105. bool skip_pre_routing) {
  13106. if (!skip_pre_routing && pre_routing_handler_ &&
  13107. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  13108. return true;
  13109. }
  13110. // File handler
  13111. if ((req.method == "GET" || req.method == "HEAD") &&
  13112. handle_file_request(req, res)) {
  13113. return true;
  13114. }
  13115. const auto *custom = find_custom_entry(req.method);
  13116. // The second clause mirrors what expect_content() does unconditionally for
  13117. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  13118. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  13119. // `allprop`) would skip its handler and fall through to 404.
  13120. if (detail::expect_content(req) ||
  13121. (custom && !custom->handlers_for_content_reader.empty())) {
  13122. // Content reader handler
  13123. {
  13124. // Track whether the ContentReader was aborted due to the decompressed
  13125. // payload exceeding `payload_max_length_`.
  13126. // The user handler runs after the lambda returns, so we must restore the
  13127. // 413 status if the handler overwrites it.
  13128. bool content_reader_payload_too_large = false;
  13129. ContentReader reader(
  13130. [&](ContentReceiver receiver) {
  13131. auto result = read_content_with_content_receiver(
  13132. strm, req, res, std::move(receiver), nullptr, nullptr);
  13133. if (!result) {
  13134. output_error_log(Error::Read, &req);
  13135. if (res.status == StatusCode::PayloadTooLarge_413) {
  13136. content_reader_payload_too_large = true;
  13137. }
  13138. }
  13139. return result;
  13140. },
  13141. [&](FormDataHeader header, ContentReceiver receiver) {
  13142. auto result = read_content_with_content_receiver(
  13143. strm, req, res, nullptr, std::move(header),
  13144. std::move(receiver));
  13145. if (!result) {
  13146. output_error_log(Error::Read, &req);
  13147. if (res.status == StatusCode::PayloadTooLarge_413) {
  13148. content_reader_payload_too_large = true;
  13149. }
  13150. }
  13151. return result;
  13152. });
  13153. bool dispatched = false;
  13154. if (req.method == "POST") {
  13155. dispatched = dispatch_request_for_content_reader(
  13156. req, res, std::move(reader), post_handlers_for_content_reader_);
  13157. } else if (req.method == "PUT") {
  13158. dispatched = dispatch_request_for_content_reader(
  13159. req, res, std::move(reader), put_handlers_for_content_reader_);
  13160. } else if (req.method == "PATCH") {
  13161. dispatched = dispatch_request_for_content_reader(
  13162. req, res, std::move(reader), patch_handlers_for_content_reader_);
  13163. } else if (req.method == "DELETE") {
  13164. dispatched = dispatch_request_for_content_reader(
  13165. req, res, std::move(reader), delete_handlers_for_content_reader_);
  13166. } else if (custom) {
  13167. dispatched = dispatch_request_for_content_reader(
  13168. req, res, std::move(reader), custom->handlers_for_content_reader);
  13169. }
  13170. if (dispatched) {
  13171. if (content_reader_payload_too_large) {
  13172. // Enforce the limit: override any status the handler may have set
  13173. // and return false so the error path sends a plain 413 response.
  13174. res.status = StatusCode::PayloadTooLarge_413;
  13175. detail::clear_content(res);
  13176. return false;
  13177. }
  13178. return true;
  13179. }
  13180. }
  13181. // NOTE: `req.body` is not read here. For a regular handler the body is
  13182. // read inside dispatch_request(), after the route has matched and the
  13183. // pre-request handler has approved the request, so that a rejected
  13184. // request (e.g. failed authentication) never forces us to buffer a
  13185. // potentially large body.
  13186. }
  13187. // Regular handler
  13188. if (req.method == "GET" || req.method == "HEAD") {
  13189. return dispatch_request(req, res, get_handlers_, strm);
  13190. } else if (req.method == "POST") {
  13191. return dispatch_request(req, res, post_handlers_, strm);
  13192. } else if (req.method == "PUT") {
  13193. return dispatch_request(req, res, put_handlers_, strm);
  13194. } else if (req.method == "DELETE") {
  13195. return dispatch_request(req, res, delete_handlers_, strm);
  13196. } else if (req.method == "OPTIONS") {
  13197. return dispatch_request(req, res, options_handlers_, strm);
  13198. } else if (req.method == "PATCH") {
  13199. return dispatch_request(req, res, patch_handlers_, strm);
  13200. } else if (custom) {
  13201. return dispatch_request(req, res, custom->handlers, strm);
  13202. }
  13203. res.status = StatusCode::BadRequest_400;
  13204. return false;
  13205. }
  13206. inline bool Server::dispatch_request(Request &req, Response &res,
  13207. const Handlers &handlers, Stream &strm) {
  13208. for (const auto &x : handlers) {
  13209. const auto &matcher = x.first;
  13210. const auto &handler = x.second;
  13211. if (matcher->match(req)) {
  13212. req.matched_route = matcher->pattern();
  13213. // Run the pre-request handler before reading the body so a rejected
  13214. // request (e.g. failed authentication) never forces us to buffer a
  13215. // potentially large body. `req.matched_route` is available here.
  13216. if (pre_request_handler_ &&
  13217. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  13218. return true;
  13219. }
  13220. // The route matched and the request was approved; read the body now.
  13221. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  13222. output_error_log(Error::Read, &req);
  13223. return false;
  13224. }
  13225. handler(req, res);
  13226. return true;
  13227. }
  13228. }
  13229. return false;
  13230. }
  13231. // Decides the content coding for a response served straight from a file. Both
  13232. // the ETag, which has to name the representation actually sent, and
  13233. // `apply_static_file_compression()` go through this, so the two cannot drift
  13234. // apart.
  13235. inline detail::EncodingType
  13236. Server::static_file_encoding(const Request &req, const Response &res,
  13237. const std::string &content_type,
  13238. size_t length) const {
  13239. if (!static_file_compression_) { return detail::EncodingType::None; }
  13240. // Nothing to compress, and an empty file already answers with
  13241. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  13242. // turn an empty body into a 20-byte gzip stream.
  13243. if (length == 0) { return detail::EncodingType::None; }
  13244. // A file that already fits in a single packet gains nothing from being made
  13245. // smaller, since it still travels in that one segment, and a file of a few
  13246. // bytes comes out larger than it went in.
  13247. if (length < static_file_compression_min_length_) {
  13248. return detail::EncodingType::None;
  13249. }
  13250. // RFC 9110 applies Range to the representation after content coding, so a
  13251. // compressed 206 would mean compressing the whole file and then slicing it.
  13252. // Serve ranges from the identity representation instead.
  13253. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  13254. if (static_file_compression_max_length_ > 0 &&
  13255. length > static_file_compression_max_length_) {
  13256. return detail::EncodingType::None;
  13257. }
  13258. return detail::encoding_type(req, res, content_type);
  13259. }
  13260. // Compresses a file-backed content provider into `res.body`. Returns false when
  13261. // the response is left untouched.
  13262. inline bool Server::apply_static_file_compression(const Request &req,
  13263. Response &res) const {
  13264. auto type = res.content_coding_;
  13265. if (type == detail::EncodingType::None || !res.content_provider_) {
  13266. return false;
  13267. }
  13268. auto compressor = detail::make_compressor(type);
  13269. if (!compressor) { return false; }
  13270. output_pre_compression_log(req, res);
  13271. std::string compressed;
  13272. if (!detail::compress_content_provider(res.content_provider_,
  13273. res.content_length_, *compressor,
  13274. compressed)) {
  13275. return false;
  13276. }
  13277. res.body.swap(compressed);
  13278. // The provider was consumed in full, so its releaser hears about a success.
  13279. res.content_provider_success_ = true;
  13280. detail::clear_content_provider(res);
  13281. res.set_header("Content-Encoding", detail::encoding_name(type));
  13282. res.set_header("Vary", "Accept-Encoding");
  13283. return true;
  13284. }
  13285. inline void Server::apply_ranges(const Request &req, Response &res,
  13286. std::string &content_type,
  13287. std::string &boundary) const {
  13288. // A known-length content provider leaves `res.body` empty, so the compressor
  13289. // at the end of this function never runs for one (issue #2545). A file-backed
  13290. // provider is fully readable right here, so compress it and answer with an
  13291. // ordinary body: `Content-Length` and HEAD keep working, and the response
  13292. // takes the same path as `set_content()` from here on. Range requests never
  13293. // get a content coding, so `Content-Range` still names identity bytes and
  13294. // none of the range handling below applies.
  13295. if (apply_static_file_compression(req, res)) { return; }
  13296. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  13297. auto it = res.headers.find("Content-Type");
  13298. if (it != res.headers.end()) {
  13299. content_type = it->second;
  13300. res.headers.erase(it);
  13301. }
  13302. boundary = detail::make_multipart_data_boundary();
  13303. res.set_header("Content-Type",
  13304. "multipart/byteranges; boundary=" + boundary);
  13305. }
  13306. auto type =
  13307. compress_ ? detail::encoding_type(req, res) : detail::EncodingType::None;
  13308. if (res.body.empty()) {
  13309. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  13310. res.status == StatusCode::PartialContent_206) {
  13311. auto offset_and_length = detail::get_range_offset_and_length(
  13312. req.ranges[0], res.content_length_);
  13313. auto content_range = detail::make_content_range_header_field(
  13314. offset_and_length, res.content_length_);
  13315. res.set_header("Content-Range", content_range);
  13316. } else if (res.is_chunked_content_provider_) {
  13317. res.content_coding_ = type;
  13318. if (type != detail::EncodingType::None) {
  13319. res.set_header("Content-Encoding", detail::encoding_name(type));
  13320. res.set_header("Vary", "Accept-Encoding");
  13321. }
  13322. }
  13323. } else {
  13324. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  13325. ;
  13326. } else if (req.ranges.size() == 1) {
  13327. auto offset_and_length =
  13328. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  13329. auto offset = offset_and_length.first;
  13330. auto length = offset_and_length.second;
  13331. auto content_range = detail::make_content_range_header_field(
  13332. offset_and_length, res.body.size());
  13333. res.set_header("Content-Range", content_range);
  13334. assert(offset + length <= res.body.size());
  13335. res.body = res.body.substr(offset, length);
  13336. } else {
  13337. std::string data;
  13338. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  13339. res.body.size(), data);
  13340. res.body.swap(data);
  13341. }
  13342. if (type != detail::EncodingType::None) {
  13343. output_pre_compression_log(req, res);
  13344. if (auto compressor = detail::make_compressor(type)) {
  13345. std::string compressed;
  13346. if (compressor->compress(res.body.data(), res.body.size(), true,
  13347. [&](const char *data, size_t data_len) {
  13348. compressed.append(data, data_len);
  13349. return true;
  13350. })) {
  13351. res.body.swap(compressed);
  13352. res.set_header("Content-Encoding", detail::encoding_name(type));
  13353. res.set_header("Vary", "Accept-Encoding");
  13354. }
  13355. }
  13356. }
  13357. res.content_length_ = res.body.size();
  13358. }
  13359. }
  13360. inline bool Server::dispatch_request_for_content_reader(
  13361. Request &req, Response &res, ContentReader content_reader,
  13362. const HandlersForContentReader &handlers) const {
  13363. for (const auto &x : handlers) {
  13364. const auto &matcher = x.first;
  13365. const auto &handler = x.second;
  13366. if (matcher->match(req)) {
  13367. req.matched_route = matcher->pattern();
  13368. if (!pre_request_handler_ ||
  13369. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  13370. handler(req, res, content_reader);
  13371. }
  13372. return true;
  13373. }
  13374. }
  13375. return false;
  13376. }
  13377. inline std::string
  13378. get_client_ip(const std::string &x_forwarded_for,
  13379. const std::vector<std::string> &trusted_proxies) {
  13380. // X-Forwarded-For is a comma-separated list per RFC 7239
  13381. std::vector<std::string> ip_list;
  13382. detail::split(x_forwarded_for.data(),
  13383. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  13384. [&](const char *b, const char *e) {
  13385. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  13386. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  13387. });
  13388. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  13389. // no segments. Signal "no client IP derived" with an empty string so the
  13390. // caller can fall back to the connection-level remote address.
  13391. if (ip_list.empty()) { return std::string(); }
  13392. // Each hop appends the address it received the request from, so the rightmost
  13393. // entries are the ones written by our own infrastructure while the leftmost
  13394. // are whatever the original client chose to send. Walk from the right and
  13395. // skip trusted proxies; the first address that is not a trusted proxy is the
  13396. // furthest point still attributable to a real hop, i.e. the client. Scanning
  13397. // from the left instead lets a client forge an arbitrary address by following
  13398. // it with a trusted proxy's address, which the left-to-right scan then
  13399. // returned as the client.
  13400. for (size_t i = ip_list.size(); i-- > 0;) {
  13401. const auto &ip = ip_list[i];
  13402. if (!detail::is_trusted_proxy(ip, trusted_proxies)) { return ip; }
  13403. }
  13404. // Every hop was a trusted proxy; fall back to the first entry.
  13405. return ip_list.front();
  13406. }
  13407. inline bool
  13408. Server::process_request(Stream &strm, const std::string &remote_addr,
  13409. int remote_port, const std::string &local_addr,
  13410. int local_port, bool close_connection,
  13411. bool &connection_closed,
  13412. const std::function<void(Request &)> &setup_request,
  13413. bool *websocket_upgraded) {
  13414. std::array<char, 2048> buf{};
  13415. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13416. // The read timeout bounds the request line and headers as a whole, so a
  13417. // client sending them a byte at a time cannot hold the worker any longer.
  13418. auto read_timeout_msec = read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000;
  13419. strm.set_max_timeout(read_timeout_msec);
  13420. // Connection has been closed on client
  13421. if (!line_reader.getline()) { return false; }
  13422. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  13423. // clients send an extra CRLF after a request body, which would otherwise be
  13424. // parsed as the next request on a persistent connection.
  13425. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  13426. return false;
  13427. }
  13428. Request req;
  13429. req.start_time_ = std::chrono::steady_clock::now();
  13430. req.remote_addr = remote_addr;
  13431. req.remote_port = remote_port;
  13432. req.local_addr = local_addr;
  13433. req.local_port = local_port;
  13434. Response res;
  13435. res.version = "HTTP/1.1";
  13436. res.headers = default_headers_;
  13437. // RFC 9112 §9.6: a server that sends the "close" connection option must
  13438. // close the connection after that response, whichever path wrote it (an
  13439. // error status, a handler, or a rejected request). Reading on would also
  13440. // parse whatever the client sent next on a connection it considers done.
  13441. auto honor_connection_close = detail::scope_exit([&] {
  13442. if (detail::has_header_token(res.headers, "Connection", "close")) {
  13443. connection_closed = true;
  13444. }
  13445. });
  13446. // Request line and headers. A rejected message leaves the rest of it (and
  13447. // any body) unread, so the connection cannot be reused: the leftover bytes
  13448. // would be parsed as the next request.
  13449. if (!parse_request_line(line_reader.ptr(), req)) {
  13450. connection_closed = true;
  13451. res.status = StatusCode::BadRequest_400;
  13452. output_error_log(Error::InvalidRequestLine, &req);
  13453. return write_response(strm, close_connection, req, res);
  13454. }
  13455. // Request headers
  13456. if (!detail::read_headers(strm, req.headers)) {
  13457. connection_closed = true;
  13458. res.status = StatusCode::BadRequest_400;
  13459. output_error_log(Error::InvalidHeaders, &req);
  13460. return write_response(strm, close_connection, req, res);
  13461. }
  13462. strm.set_max_timeout(0);
  13463. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  13464. // which would otherwise let an intermediary and this parser disagree on
  13465. // where the body ends and enable request smuggling. Three cases: a
  13466. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  13467. // or empty), which would otherwise be read as "no body"; a non-zero
  13468. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  13469. // tolerated for compatibility with existing clients); and a
  13470. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  13471. // length undeterminable. None of them may fall through to the "no body"
  13472. // path, or the body bytes are parsed as the next request on a persistent
  13473. // connection.
  13474. auto is_invalid_content_length = false;
  13475. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  13476. is_invalid_content_length);
  13477. if (is_invalid_content_length ||
  13478. detail::has_conflicting_content_length(req.headers) ||
  13479. (req.has_header("Transfer-Encoding") &&
  13480. !detail::is_chunked_transfer_encoding(req.headers))) {
  13481. connection_closed = true;
  13482. res.status = StatusCode::BadRequest_400;
  13483. return write_response(strm, close_connection, req, res);
  13484. }
  13485. // RFC 9112 6.1: a lone "chunked" is the only transfer coding implemented
  13486. if (req.has_header("Transfer-Encoding") &&
  13487. (req.get_header_value_count("Transfer-Encoding") != 1 ||
  13488. !detail::case_ignore::equal(req.get_header_value("Transfer-Encoding"),
  13489. "chunked"))) {
  13490. connection_closed = true;
  13491. res.status = StatusCode::NotImplemented_501;
  13492. return write_response(strm, close_connection, req, res);
  13493. }
  13494. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  13495. // HTTP/1.0 request, is honoured, but the connection closes after the
  13496. // response.
  13497. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  13498. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  13499. // value, or none in HTTP/1.1, so that every recipient of the request sees
  13500. // the same authority.
  13501. auto host_count = req.get_header_value_count("Host");
  13502. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  13503. !detail::fields::is_host(req.get_header_value("Host"))) {
  13504. connection_closed = true;
  13505. res.status = StatusCode::BadRequest_400;
  13506. output_error_log(Error::InvalidHeaders, &req);
  13507. return write_response(strm, close_connection, req, res);
  13508. }
  13509. // Check if the request URI doesn't exceed the limit
  13510. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13511. connection_closed = true;
  13512. res.status = StatusCode::UriTooLong_414;
  13513. output_error_log(Error::ExceedUriMaxLength, &req);
  13514. return write_response(strm, close_connection, req, res);
  13515. }
  13516. if (detail::has_header_token(req.headers, "Connection", "close")) {
  13517. connection_closed = true;
  13518. }
  13519. if (req.version == "HTTP/1.0" &&
  13520. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  13521. connection_closed = true;
  13522. }
  13523. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  13524. // itself a trusted proxy. Otherwise any direct client could spoof
  13525. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  13526. if (detail::is_trusted_proxy(remote_addr, trusted_proxies_) &&
  13527. req.has_header("X-Forwarded-For")) {
  13528. // Some proxies append the address they observed as a separate
  13529. // X-Forwarded-For field line instead of extending the one the client sent
  13530. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  13531. // be scanned. Reading only the first occurrence would hand back the
  13532. // client-supplied, and therefore forgeable, value.
  13533. auto x_forwarded_for =
  13534. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  13535. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  13536. req.remote_addr = derived.empty() ? remote_addr : derived;
  13537. } else {
  13538. req.remote_addr = remote_addr;
  13539. }
  13540. req.remote_port = remote_port;
  13541. req.local_addr = local_addr;
  13542. req.local_port = local_port;
  13543. if (req.has_header("Accept")) {
  13544. auto accept_header =
  13545. detail::get_combined_header_value(req.headers, "Accept");
  13546. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  13547. connection_closed = true;
  13548. res.status = StatusCode::BadRequest_400;
  13549. output_error_log(Error::HTTPParsing, &req);
  13550. return write_response(strm, close_connection, req, res);
  13551. }
  13552. }
  13553. // RFC 9110 14.2: range handling is defined only for GET (and so for HEAD)
  13554. if ((req.method == "GET" || req.method == "HEAD") &&
  13555. req.has_header("Range")) {
  13556. const auto &range_header_value = req.get_header_value("Range");
  13557. // RFC 9110 14.2: a range unit other than bytes must be ignored
  13558. auto unit = range_header_value.substr(0, range_header_value.find('='));
  13559. if (detail::case_ignore::equal(unit, "bytes") &&
  13560. !detail::parse_range_header(range_header_value, req.ranges)) {
  13561. connection_closed = true;
  13562. res.status = StatusCode::RangeNotSatisfiable_416;
  13563. output_error_log(Error::InvalidRangeHeader, &req);
  13564. return write_response(strm, close_connection, req, res);
  13565. }
  13566. }
  13567. if (setup_request) { setup_request(req); }
  13568. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  13569. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  13570. // must be ignored. An expectation we do not recognize is left alone; the
  13571. // 417 the section allows for one is a MAY, not a requirement.
  13572. //
  13573. // `100 Continue` itself is deferred until the body is actually read (see
  13574. // read_content_core), so a request rejected by a later handler never
  13575. // invites the client to send a body nobody will read.
  13576. if (req.version != "HTTP/1.0" &&
  13577. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  13578. int status = StatusCode::Continue_100;
  13579. if (expect_100_continue_handler_) {
  13580. status = expect_100_continue_handler_(req, res);
  13581. }
  13582. if (status == StatusCode::Continue_100) {
  13583. req.expect_100_continue_pending_ = true;
  13584. } else {
  13585. if (res.status == -1) { res.status = status; }
  13586. connection_closed = true;
  13587. return write_response(strm, true, req, res);
  13588. }
  13589. }
  13590. // Setup `is_connection_closed` method
  13591. auto sock = strm.socket();
  13592. req.is_connection_closed = [sock]() {
  13593. return !detail::is_socket_alive(sock);
  13594. };
  13595. // WebSocket upgrade
  13596. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  13597. // that authentication and other middleware can reject the request with an
  13598. // HTTP response (e.g., 401) before the protocol switches.
  13599. // The response says so when this connection closes after it.
  13600. auto close_after_response = close_connection || connection_closed;
  13601. // An upgrade request has been through pre-routing before it reaches routing()
  13602. auto is_upgrade = detail::is_websocket_upgrade(req);
  13603. if (is_upgrade) {
  13604. // A response given here leaves the body unread, and it would be parsed as
  13605. // the next request.
  13606. auto close_if_answered =
  13607. close_after_response || detail::has_framed_body(req);
  13608. const WebSocketHandlerEntry *ws_route = nullptr;
  13609. std::string selected_subprotocol;
  13610. auto answer_before_upgrade = [&]() -> bool {
  13611. if (pre_routing_handler_ &&
  13612. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  13613. return true;
  13614. }
  13615. for (const auto &entry : websocket_handlers_) {
  13616. if (!entry.matcher->match(req)) { continue; }
  13617. req.matched_route = entry.matcher->pattern();
  13618. if (pre_request_handler_ &&
  13619. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  13620. return true;
  13621. }
  13622. ws_route = &entry;
  13623. if (entry.sub_protocol_selector) {
  13624. auto protocol_header = detail::get_combined_header_value(
  13625. req.headers, "Sec-WebSocket-Protocol");
  13626. if (!protocol_header.empty()) {
  13627. std::vector<std::string> protocols;
  13628. detail::split(protocol_header.data(),
  13629. protocol_header.data() + protocol_header.size(), ',',
  13630. [&](const char *b, const char *e) {
  13631. protocols.emplace_back(b, e);
  13632. });
  13633. selected_subprotocol = entry.sub_protocol_selector(protocols);
  13634. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  13635. if (std::find(protocols.begin(), protocols.end(),
  13636. selected_subprotocol) == protocols.end()) {
  13637. selected_subprotocol.clear();
  13638. }
  13639. }
  13640. }
  13641. return false;
  13642. }
  13643. return false;
  13644. };
  13645. auto answered = false;
  13646. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13647. answered = answer_before_upgrade();
  13648. #else
  13649. try {
  13650. answered = answer_before_upgrade();
  13651. } catch (...) {
  13652. if (!handle_exception(req, res)) {
  13653. return write_response(strm, close_if_answered, req, res);
  13654. }
  13655. answered = true;
  13656. }
  13657. #endif
  13658. if (answered) {
  13659. if (res.status == -1) { res.status = StatusCode::OK_200; }
  13660. return write_response_with_content(strm, close_if_answered, req, res);
  13661. }
  13662. if (ws_route) {
  13663. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  13664. auto accept_key = detail::websocket_accept_key(client_key);
  13665. // Send 101 Switching Protocols
  13666. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  13667. "Upgrade: websocket\r\n"
  13668. "Connection: Upgrade\r\n"
  13669. "Sec-WebSocket-Accept: " +
  13670. accept_key + "\r\n";
  13671. if (!selected_subprotocol.empty()) {
  13672. if (!detail::fields::is_field_value(selected_subprotocol)) {
  13673. return false;
  13674. }
  13675. handshake_response +=
  13676. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  13677. }
  13678. handshake_response += "\r\n";
  13679. if (strm.write(handshake_response.data(), handshake_response.size()) <
  13680. 0) {
  13681. return false;
  13682. }
  13683. connection_closed = true;
  13684. if (websocket_upgraded) { *websocket_upgraded = true; }
  13685. auto stopping = [this] { return is_stopping(); };
  13686. if (CPPHTTPLIB_WEBSOCKET_TCP_NODELAY) {
  13687. set_socket_opt(strm.socket(), IPPROTO_TCP, TCP_NODELAY, 1);
  13688. }
  13689. #ifdef CPPHTTPLIB_SSL_ENABLED
  13690. if (req.ssl) {
  13691. // wss: the heartbeat ping thread and the read path enter the same
  13692. // TLS session from different threads. Hand the WebSocket a stream
  13693. // that serializes every TLS call, so the shared SSLSocketStream on
  13694. // the plain HTTP/HTTPS paths stays untouched.
  13695. auto ws_strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  13696. strm.socket(), const_cast<tls::session_t>(req.ssl),
  13697. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  13698. write_timeout_sec_, write_timeout_usec_));
  13699. ws::WebSocket ws(std::move(ws_strm), req, true,
  13700. websocket_ping_interval_sec_,
  13701. websocket_max_missed_pongs_, stopping);
  13702. ws_route->handler(req, ws);
  13703. return true;
  13704. }
  13705. #endif
  13706. // Use WebSocket-specific read timeout instead of HTTP timeout
  13707. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0);
  13708. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  13709. websocket_max_missed_pongs_, stopping);
  13710. ws_route->handler(req, ws);
  13711. return true;
  13712. }
  13713. // No WebSocket route: route it as a plain HTTP request
  13714. }
  13715. // Routing
  13716. auto routed = false;
  13717. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13718. routed = routing(req, res, strm, is_upgrade);
  13719. #else
  13720. try {
  13721. routed = routing(req, res, strm, is_upgrade);
  13722. } catch (...) { routed = handle_exception(req, res); }
  13723. #endif
  13724. auto ret = false;
  13725. if (routed) {
  13726. if (res.status == -1) {
  13727. res.status = req.ranges.empty() ? StatusCode::OK_200
  13728. : StatusCode::PartialContent_206;
  13729. }
  13730. // Before the Range checks below, so they see the body's own length.
  13731. detail::prefer_assigned_body(res);
  13732. // Serve file content by using a content provider
  13733. auto file_open_error = false;
  13734. if (!res.file_content_path_.empty()) {
  13735. const auto &path = res.file_content_path_;
  13736. auto mm = std::make_shared<detail::mmap>(path.c_str());
  13737. if (!mm->is_open()) {
  13738. res.status = StatusCode::NotFound_404;
  13739. output_error_log(Error::OpenFile, &req);
  13740. file_open_error = true;
  13741. } else {
  13742. auto content_type = res.file_content_content_type_;
  13743. if (content_type.empty()) {
  13744. // One the handler set after set_file_content()
  13745. content_type = res.get_header_value("Content-Type");
  13746. }
  13747. if (content_type.empty()) {
  13748. content_type = detail::find_content_type(
  13749. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  13750. }
  13751. detail::set_file_content_provider(
  13752. res, mm, content_type,
  13753. static_file_encoding(req, res, content_type, mm->size()));
  13754. }
  13755. }
  13756. if (file_open_error) {
  13757. ret = write_response(strm, close_after_response, req, res);
  13758. } else if (detail::range_error(req, res)) {
  13759. detail::clear_content(res);
  13760. res.status = StatusCode::RangeNotSatisfiable_416;
  13761. ret = write_response(strm, close_after_response, req, res);
  13762. } else {
  13763. ret = write_response_with_content(strm, close_after_response, req, res);
  13764. }
  13765. } else {
  13766. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  13767. ret = write_response(strm, close_after_response, req, res);
  13768. }
  13769. // Drain any unconsumed framed body to prevent request smuggling on
  13770. // keep-alive. Without framing there is no body to drain — reading would
  13771. // consume the next request (issue #2450). If the response has committed the
  13772. // connection to close, there is no next request to protect. A body read in
  13773. // part cannot be drained from where it stopped, so the connection closes,
  13774. // as it does when the body is longer than the drain limit or does not
  13775. // arrive within the read timeout.
  13776. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  13777. !detail::has_header_token(res.headers, "Connection", "close")) {
  13778. strm.set_max_timeout(read_timeout_msec);
  13779. int dummy_status;
  13780. if (req.body_read_started_ ||
  13781. !detail::read_content(
  13782. strm, req, CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH, dummy_status,
  13783. nullptr, [](const char *, size_t, size_t, size_t) { return true; },
  13784. false)) {
  13785. connection_closed = true;
  13786. }
  13787. }
  13788. return ret;
  13789. }
  13790. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  13791. inline bool Server::process_and_close_socket(socket_t sock) {
  13792. std::string remote_addr;
  13793. int remote_port = 0;
  13794. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  13795. std::string local_addr;
  13796. int local_port = 0;
  13797. detail::get_local_ip_and_port(sock, local_addr, local_port);
  13798. bool websocket_upgraded = false;
  13799. auto ret = serve_guarded([&]() {
  13800. return detail::process_server_socket(
  13801. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  13802. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13803. write_timeout_usec_,
  13804. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  13805. return process_request(strm, remote_addr, remote_port, local_addr,
  13806. local_port, close_connection,
  13807. connection_closed, nullptr,
  13808. &websocket_upgraded);
  13809. });
  13810. });
  13811. detail::drain_and_close_socket(sock);
  13812. return ret;
  13813. }
  13814. inline void Server::output_log(const Request &req, const Response &res) const {
  13815. if (logger_) {
  13816. std::lock_guard<std::mutex> guard(logger_mutex_);
  13817. logger_(req, res);
  13818. }
  13819. }
  13820. inline void Server::output_pre_compression_log(const Request &req,
  13821. const Response &res) const {
  13822. if (pre_compression_logger_) {
  13823. std::lock_guard<std::mutex> guard(logger_mutex_);
  13824. pre_compression_logger_(req, res);
  13825. }
  13826. }
  13827. inline void Server::output_error_log(const Error &err,
  13828. const Request *req) const {
  13829. if (error_logger_) {
  13830. std::lock_guard<std::mutex> guard(logger_mutex_);
  13831. error_logger_(err, req);
  13832. }
  13833. }
  13834. /*
  13835. * Group 5: ClientImpl and Client (Universal) implementation
  13836. */
  13837. // HTTP client implementation
  13838. inline ClientImpl::ClientImpl(const std::string &host)
  13839. : ClientImpl(host, 80, std::string(), std::string()) {}
  13840. inline ClientImpl::ClientImpl(const std::string &host, int port)
  13841. : ClientImpl(host, port, std::string(), std::string()) {}
  13842. inline ClientImpl::ClientImpl(const std::string &host, int port,
  13843. const std::string &client_cert_path,
  13844. const std::string &client_key_path)
  13845. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  13846. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  13847. inline ClientImpl::~ClientImpl() {
  13848. // Wait until all the requests in flight are handled.
  13849. size_t retry_count = 10;
  13850. while (retry_count-- > 0) {
  13851. {
  13852. std::lock_guard<std::mutex> guard(socket_mutex_);
  13853. if (socket_requests_in_flight_ == 0) { break; }
  13854. }
  13855. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  13856. }
  13857. std::lock_guard<std::mutex> guard(socket_mutex_);
  13858. shutdown_socket(socket_);
  13859. close_socket(socket_);
  13860. }
  13861. inline bool ClientImpl::is_valid() const { return true; }
  13862. inline bool
  13863. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  13864. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  13865. if (no_proxy_entries_.empty()) { return true; }
  13866. // host_ is const so its normalized form is invariant; cache it. The
  13867. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  13868. if (host == host_) {
  13869. if (!host_normalized_valid_) {
  13870. host_normalized_ = detail::normalize_target(host_);
  13871. host_normalized_valid_ = true;
  13872. }
  13873. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13874. }
  13875. auto target = detail::normalize_target(host);
  13876. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13877. }
  13878. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13879. if (is_proxy_enabled_for_host(host_)) {
  13880. return detail::create_client_socket(
  13881. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13882. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13883. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13884. write_timeout_sec_, write_timeout_usec_, interface_, error,
  13885. stop_interrupt());
  13886. }
  13887. // Check is custom IP or hostname specified for host_
  13888. std::string connect_host;
  13889. std::string ip;
  13890. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13891. return detail::create_client_socket(
  13892. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13893. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13894. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13895. write_timeout_usec_, interface_, error, stop_interrupt());
  13896. }
  13897. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13898. Error &error) {
  13899. auto sock = create_client_socket(error);
  13900. if (sock == INVALID_SOCKET) { return false; }
  13901. socket.sock = sock;
  13902. return true;
  13903. }
  13904. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13905. socket_tls_settings_version_ = tls_settings_version_;
  13906. return create_and_connect_socket(socket, error);
  13907. }
  13908. inline bool ClientImpl::setup_proxy_connection(
  13909. Socket & /*socket*/,
  13910. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13911. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13912. return true;
  13913. }
  13914. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13915. bool /*shutdown_gracefully*/) {
  13916. // If there are any requests in flight from threads other than us, then it's
  13917. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13918. assert(socket_requests_in_flight_ == 0 ||
  13919. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13920. }
  13921. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13922. if (socket.sock == INVALID_SOCKET) { return; }
  13923. detail::shutdown_socket(socket.sock);
  13924. }
  13925. inline void ClientImpl::close_socket(Socket &socket) {
  13926. // If there are requests in flight in another thread, usually closing
  13927. // the socket will be fine and they will simply receive an error when
  13928. // using the closed socket, but it is still a bug since rarely the OS
  13929. // may reassign the socket id to be used for a new socket, and then
  13930. // suddenly they will be operating on a live socket that is different
  13931. // than the one they intended!
  13932. assert(socket_requests_in_flight_ == 0 ||
  13933. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13934. // It is also a bug if this happens while SSL is still active
  13935. #ifdef CPPHTTPLIB_SSL_ENABLED
  13936. assert(socket.ssl == nullptr);
  13937. #endif
  13938. if (socket.sock == INVALID_SOCKET) { return; }
  13939. detail::close_socket(socket.sock);
  13940. socket.sock = INVALID_SOCKET;
  13941. }
  13942. inline void ClientImpl::disconnect(bool gracefully) {
  13943. shutdown_ssl(socket_, gracefully);
  13944. shutdown_socket(socket_);
  13945. close_socket(socket_);
  13946. }
  13947. inline bool ClientImpl::socket_reusable() {
  13948. if (!socket_.is_open()) { return false; }
  13949. // RFC 9112 9.2: data with no request outstanding is not a response
  13950. if (detail::select_read(socket_.sock, 0, 0) != 0) {
  13951. disconnect(/*gracefully=*/false);
  13952. return false;
  13953. }
  13954. if (is_ssl() && socket_tls_settings_version_ != tls_settings_version_) {
  13955. disconnect(/*gracefully=*/true);
  13956. return false;
  13957. }
  13958. return true;
  13959. }
  13960. inline bool ClientImpl::prepare_socket(
  13961. std::unique_lock<std::mutex> &guard,
  13962. std::chrono::time_point<std::chrono::steady_clock> start_time,
  13963. Response &res, bool &success, Error &error) {
  13964. auto opened = true;
  13965. if (!socket_reusable()) {
  13966. Socket socket;
  13967. guard.unlock();
  13968. opened = ensure_socket_connection(socket, error);
  13969. if (opened) {
  13970. opened = setup_proxy_connection(socket, start_time, res, success, error);
  13971. } else {
  13972. success = false;
  13973. }
  13974. guard.lock();
  13975. socket_ = socket;
  13976. }
  13977. if (stop_requested_) {
  13978. disconnect(/*gracefully=*/false);
  13979. error = Error::Canceled;
  13980. success = false;
  13981. return false;
  13982. }
  13983. return opened;
  13984. }
  13985. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13986. Response &res,
  13987. bool skip_100_continue) const {
  13988. std::array<char, 2048> buf{};
  13989. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13990. if (!line_reader.getline()) { return false; }
  13991. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13992. res.reason)) {
  13993. return req.method == "CONNECT";
  13994. }
  13995. // Skip interim (1xx) responses along with their header fields, except a 100
  13996. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13997. // HTTP on the connection, so it is final. A server sending them without end
  13998. // would hold the client, so there may be only so many.
  13999. size_t interim_count = 0;
  14000. while (100 <= res.status && res.status < 200 &&
  14001. res.status != StatusCode::SwitchingProtocol_101 &&
  14002. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  14003. if (++interim_count > CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT) {
  14004. return false;
  14005. }
  14006. Headers interim_headers;
  14007. if (!detail::read_headers(strm, interim_headers)) { return false; }
  14008. if (!line_reader.getline()) { return false; } // next response line
  14009. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  14010. res.reason)) {
  14011. return false;
  14012. }
  14013. }
  14014. return true;
  14015. }
  14016. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  14017. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14018. // A same-origin redirect and a digest retry send through here again. Only
  14019. // the call the caller made reports a failure, once, with its request.
  14020. auto outermost = send_depth_++ == 0;
  14021. auto se = detail::scope_exit([&] { send_depth_--; });
  14022. if (outermost) {
  14023. error = Error::Success;
  14024. stop_requested_ = false;
  14025. }
  14026. auto ret = send_(req, res, error);
  14027. if (error == Error::SSLPeerCouldBeClosed_) {
  14028. assert(!ret);
  14029. ret = send_(req, res, error);
  14030. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  14031. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  14032. }
  14033. // Also an answer that carries an error, such as a proxy's 407
  14034. if (outermost && error != Error::Success) { output_error_log(error, &req); }
  14035. return ret;
  14036. }
  14037. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  14038. #ifdef CPPHTTPLIB_SSL_ENABLED
  14039. // Don't let an earlier attempt's TLS error show up in this one's Result. A
  14040. // client that failed to set up its TLS context keeps reporting why.
  14041. if (is_valid()) {
  14042. last_ssl_error_ = 0;
  14043. last_backend_error_ = 0;
  14044. }
  14045. #endif
  14046. {
  14047. std::unique_lock<std::mutex> guard(socket_mutex_);
  14048. // Set this to false immediately - if it ever gets set to true by the end
  14049. // of the request, we know another thread instructed us to close the
  14050. // socket.
  14051. socket_should_be_closed_when_request_is_done_ = false;
  14052. auto success = true;
  14053. if (!prepare_socket(guard, req.start_time_, res, success, error)) {
  14054. return success;
  14055. }
  14056. // Mark the current socket as being in use so that it cannot be closed by
  14057. // anyone else while this request is ongoing, even though we will be
  14058. // releasing the mutex.
  14059. if (socket_requests_in_flight_ > 1) {
  14060. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  14061. }
  14062. socket_requests_in_flight_ += 1;
  14063. socket_requests_are_from_thread_ = std::this_thread::get_id();
  14064. }
  14065. for (const auto &header : default_headers_) {
  14066. if (req.headers.find(header.first) == req.headers.end()) {
  14067. req.headers.insert(header);
  14068. }
  14069. }
  14070. auto ret = false;
  14071. auto close_connection = !keep_alive_;
  14072. auto se = detail::scope_exit([&]() {
  14073. // Briefly lock mutex in order to mark that a request is no longer ongoing
  14074. std::lock_guard<std::mutex> guard(socket_mutex_);
  14075. socket_requests_in_flight_ -= 1;
  14076. if (socket_requests_in_flight_ <= 0) {
  14077. assert(socket_requests_in_flight_ == 0);
  14078. socket_requests_are_from_thread_ = std::thread::id();
  14079. }
  14080. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  14081. !ret) {
  14082. disconnect(/*gracefully=*/true);
  14083. }
  14084. });
  14085. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  14086. strm.set_read_interrupt(stop_interrupt());
  14087. return handle_request(strm, req, res, close_connection, error);
  14088. });
  14089. if (!ret) {
  14090. if (error == Error::Success) { error = Error::Unknown; }
  14091. }
  14092. return ret;
  14093. }
  14094. inline Result ClientImpl::send(const Request &req) {
  14095. auto req2 = req;
  14096. return send_(std::move(req2));
  14097. }
  14098. inline Result ClientImpl::send_(Request &&req) {
  14099. auto res = detail::make_unique<Response>();
  14100. auto error = Error::Success;
  14101. #ifdef CPPHTTPLIB_SSL_ENABLED
  14102. // Hold the request lock until the Result has read this request's TLS error
  14103. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14104. #endif
  14105. auto ret = send(req, *res, error);
  14106. #ifdef CPPHTTPLIB_SSL_ENABLED
  14107. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  14108. last_ssl_error_, last_backend_error_};
  14109. #else
  14110. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  14111. #endif
  14112. }
  14113. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  14114. const std::string &ct) {
  14115. (void)for_stream;
  14116. // Default headers are meant for the origin and may carry its credentials, so
  14117. // keep them off the CONNECT request the proxy reads.
  14118. if (r.method != "CONNECT") {
  14119. for (const auto &header : default_headers_) {
  14120. if (!r.has_header(header.first)) { r.headers.insert(header); }
  14121. }
  14122. }
  14123. // RFC 9110 5.3 recommends sending control data such as Host first, so
  14124. // prepend it rather than appending it after the caller's own fields.
  14125. if (!r.has_header("Host")) {
  14126. r.headers.emplace_front(
  14127. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  14128. address_family_));
  14129. }
  14130. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  14131. if (!r.content_receiver) {
  14132. if (!r.has_header("Accept-Encoding")) {
  14133. std::string accept_encoding;
  14134. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  14135. accept_encoding = "br";
  14136. #endif
  14137. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  14138. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  14139. accept_encoding += "gzip, deflate";
  14140. #endif
  14141. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  14142. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  14143. accept_encoding += "zstd";
  14144. #endif
  14145. r.set_header("Accept-Encoding", accept_encoding);
  14146. }
  14147. detail::add_default_user_agent_header(r);
  14148. }
  14149. if (!r.body.empty()) {
  14150. if (!ct.empty() && !r.has_header("Content-Type")) {
  14151. r.headers.emplace("Content-Type", ct);
  14152. }
  14153. if (!r.has_header("Content-Length")) {
  14154. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  14155. }
  14156. }
  14157. }
  14158. inline ClientImpl::StreamHandle
  14159. ClientImpl::open_stream(const std::string &method, const std::string &path,
  14160. const Params &params, const Headers &headers,
  14161. const std::string &body,
  14162. const std::string &content_type) {
  14163. // Encode the target exactly like the buffered send path does, so that the
  14164. // same `path` produces the same request line through either API.
  14165. auto raw_query_path =
  14166. params.empty() ? path : append_query_params(path, params);
  14167. Request req;
  14168. req.method = method;
  14169. req.path = detail::encode_request_target(raw_query_path, path_encode_);
  14170. req.headers = headers;
  14171. req.body = body;
  14172. prepare_default_headers(req, true, content_type);
  14173. auto handle = open_stream_(req);
  14174. // Like a buffered request, a stream that fails to open is reported once
  14175. if (handle.error != Error::Success) { output_error_log(handle.error, &req); }
  14176. return handle;
  14177. }
  14178. inline ClientImpl::StreamHandle ClientImpl::open_stream_(Request &req) {
  14179. StreamHandle handle;
  14180. handle.response = detail::make_unique<Response>();
  14181. handle.error = Error::Success;
  14182. handle.connection_ = detail::make_unique<ClientConnection>();
  14183. {
  14184. // A request in flight uses socket_ without holding socket_mutex_
  14185. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14186. if (send_depth_ == 0) { stop_requested_ = false; }
  14187. std::unique_lock<std::mutex> guard(socket_mutex_);
  14188. auto success = true;
  14189. if (!prepare_socket(guard, std::chrono::steady_clock::now(),
  14190. *handle.response, success, handle.error)) {
  14191. if (!success) { handle.response.reset(); }
  14192. return handle;
  14193. }
  14194. transfer_socket_ownership_to_handle(handle);
  14195. }
  14196. #ifdef CPPHTTPLIB_SSL_ENABLED
  14197. if (is_ssl() && handle.connection_->session) {
  14198. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  14199. handle.connection_->sock, handle.connection_->session,
  14200. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14201. write_timeout_usec_);
  14202. } else {
  14203. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  14204. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  14205. write_timeout_sec_, write_timeout_usec_);
  14206. }
  14207. #else
  14208. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  14209. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  14210. write_timeout_sec_, write_timeout_usec_);
  14211. #endif
  14212. handle.stream_ = handle.socket_stream_.get();
  14213. auto &strm = *handle.stream_;
  14214. // Only for the head, as the handle may outlive this client
  14215. strm.set_read_interrupt(stop_interrupt());
  14216. auto release_interrupt =
  14217. detail::scope_exit([&] { strm.set_read_interrupt(nullptr); });
  14218. // After connecting, as for a buffered request
  14219. add_credential_headers(req);
  14220. // Build the request line and headers in memory first, like write_request()
  14221. // does, so that a rejected header leaves nothing on the wire.
  14222. {
  14223. detail::BufferStream bstrm;
  14224. // The path follows the authority in absolute-form, so one that does not
  14225. // begin with '/' (e.g. "@evil.example/x") would name another host.
  14226. auto prefix = proxy_target_prefix();
  14227. if ((!prefix.empty() && req.path[0] != '/') ||
  14228. detail::write_request_line(bstrm, req.method, prefix + req.path) < 0) {
  14229. handle.error = Error::Write;
  14230. handle.response.reset();
  14231. return handle;
  14232. }
  14233. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14234. handle.error)) {
  14235. handle.response.reset();
  14236. return handle;
  14237. }
  14238. const auto &data = bstrm.get_buffer();
  14239. if (!detail::write_data(strm, data.data(), data.size())) {
  14240. handle.error = Error::Write;
  14241. handle.response.reset();
  14242. return handle;
  14243. }
  14244. }
  14245. if (!req.body.empty()) {
  14246. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14247. handle.error = Error::Write;
  14248. handle.response.reset();
  14249. return handle;
  14250. }
  14251. }
  14252. if (!read_response_line(strm, req, *handle.response) ||
  14253. !detail::read_headers(strm, handle.response->headers)) {
  14254. handle.error = Error::Read;
  14255. handle.response.reset();
  14256. return handle;
  14257. }
  14258. handle.body_reader_.stream = handle.stream_;
  14259. handle.body_reader_.payload_max_length = payload_max_length_;
  14260. // RFC 9112 6.3: a response to HEAD, and a 204 or 304 response, ends with its
  14261. // header section, so none of its framing or coding headers apply.
  14262. if (req.method == "HEAD" ||
  14263. handle.response->status == StatusCode::NoContent_204 ||
  14264. handle.response->status == StatusCode::NotModified_304) {
  14265. handle.body_reader_.eof = true;
  14266. return handle;
  14267. }
  14268. // Same framing check as ClientImpl::process_request()
  14269. if (detail::has_conflicting_content_length(handle.response->headers)) {
  14270. handle.error = Error::Read;
  14271. handle.response.reset();
  14272. return handle;
  14273. }
  14274. if (handle.response->has_header("Content-Length")) {
  14275. bool is_invalid = false;
  14276. auto content_length = detail::get_header_value_u64(
  14277. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  14278. if (is_invalid) {
  14279. handle.error = Error::Read;
  14280. handle.response.reset();
  14281. return handle;
  14282. }
  14283. handle.body_reader_.has_content_length = true;
  14284. handle.body_reader_.content_length = content_length;
  14285. }
  14286. handle.body_reader_.chunked =
  14287. detail::is_chunked_transfer_encoding(handle.response->headers);
  14288. auto content_encoding = detail::get_combined_header_value(
  14289. handle.response->headers, "Content-Encoding");
  14290. if (decompress_ && !content_encoding.empty()) {
  14291. // Same policy as prepare_content_receiver(): reject a coding we know about
  14292. // but were not built with, pass an unrecognized one through as-is.
  14293. handle.decompressor_ = detail::create_decompressor(content_encoding);
  14294. if (!handle.decompressor_) {
  14295. if (detail::is_known_content_encoding(content_encoding)) {
  14296. handle.error = Error::UnsupportedContentEncoding;
  14297. handle.response.reset();
  14298. return handle;
  14299. }
  14300. } else if (!handle.decompressor_->is_valid()) {
  14301. handle.error = Error::Compression;
  14302. handle.response.reset();
  14303. return handle;
  14304. }
  14305. }
  14306. return handle;
  14307. }
  14308. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  14309. if (!is_valid() || !response) { return -1; }
  14310. auto n = decompressor_
  14311. ? read_with_decompression(buf, len)
  14312. : detail::read_body_content(stream_, body_reader_, buf, len);
  14313. if (n == 0) { parse_trailers_if_needed(); }
  14314. return n;
  14315. }
  14316. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  14317. size_t len) {
  14318. if (decompress_offset_ < decompress_buffer_.size()) {
  14319. auto available = decompress_buffer_.size() - decompress_offset_;
  14320. auto to_copy = (std::min)(len, available);
  14321. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  14322. decompress_offset_ += to_copy;
  14323. decompressed_bytes_read_ += to_copy;
  14324. return static_cast<ssize_t>(to_copy);
  14325. }
  14326. decompress_buffer_.clear();
  14327. decompress_offset_ = 0;
  14328. constexpr size_t kDecompressionBufferSize = 8192;
  14329. char compressed_buf[kDecompressionBufferSize];
  14330. while (true) {
  14331. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  14332. sizeof(compressed_buf));
  14333. if (n <= 0) { return n; }
  14334. auto exceeded = false;
  14335. bool decompress_ok = decompressor_->decompress(
  14336. compressed_buf, static_cast<size_t>(n),
  14337. [&](const char *data, size_t data_len) {
  14338. decompress_buffer_.append(data, data_len);
  14339. auto limit = body_reader_.payload_max_length;
  14340. exceeded =
  14341. limit > 0 &&
  14342. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  14343. return !exceeded;
  14344. });
  14345. if (!decompress_ok) {
  14346. body_reader_.last_error =
  14347. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  14348. return -1;
  14349. }
  14350. if (!decompress_buffer_.empty()) { break; }
  14351. }
  14352. auto to_copy = (std::min)(len, decompress_buffer_.size());
  14353. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  14354. decompress_offset_ = to_copy;
  14355. decompressed_bytes_read_ += to_copy;
  14356. return static_cast<ssize_t>(to_copy);
  14357. }
  14358. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  14359. // The trailers follow the last chunk, so there are none before it
  14360. auto &decoder = body_reader_.chunked_decoder;
  14361. if (!response || trailers_parsed_ || !decoder || !decoder->finished) {
  14362. return;
  14363. }
  14364. trailers_parsed_ = true;
  14365. decoder->parse_trailers_into(response->trailers, response->headers);
  14366. }
  14367. namespace detail {
  14368. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  14369. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  14370. size_t &out_chunk_offset,
  14371. size_t &out_chunk_total) {
  14372. if (finished) { return 0; }
  14373. if (chunk_remaining == 0) {
  14374. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  14375. if (!lr.getline()) { return -1; }
  14376. // Everything below is bounded by eol rather than by the buffer's NUL, so
  14377. // the line terminator is never mistaken for line content.
  14378. const char *eol = lr.ptr() + lr.size();
  14379. if (lr.end_with_crlf()) {
  14380. eol -= 2;
  14381. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  14382. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  14383. // getline() ends the line on a bare LF. That LF is the terminator, so it
  14384. // has to come off here or the check below would reject the line.
  14385. eol -= 1;
  14386. }
  14387. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  14388. const char *p = lr.ptr();
  14389. int v = 0;
  14390. if (p == eol || !is_hex(*p, v)) { return -1; }
  14391. size_t chunk_len = 0;
  14392. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  14393. for (; p < eol && is_hex(*p, v); ++p) {
  14394. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  14395. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  14396. }
  14397. while (p < eol && is_space_or_tab(*p)) {
  14398. ++p;
  14399. }
  14400. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  14401. // terminator, and it is built from tokens and quoted-strings, so it never
  14402. // holds a CR, LF or any other control character. getline() reads up to the
  14403. // CRLF, so a bare LF left in here would be swallowed as extension text
  14404. // while an intermediary that ends the line on it delimits the chunks
  14405. // differently, and the two disagree on where the body ends (request
  14406. // smuggling).
  14407. if (p < eol && *p != ';') { return -1; }
  14408. for (; p < eol; ++p) {
  14409. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  14410. }
  14411. // The bytes around the data are no payload, so they are counted on their
  14412. // own, as Go does: each chunk may spend 16 bytes and twice its data on
  14413. // them, which lets a stream send a byte at a time, and what goes past that
  14414. // in padding, leading zeros and extensions builds up to one header field.
  14415. overhead += lr.size() + 2;
  14416. overhead = overhead > 16 ? overhead - 16 : 0;
  14417. overhead = chunk_len > overhead / 2 ? 0 : overhead - 2 * chunk_len;
  14418. if (overhead > CPPHTTPLIB_HEADER_MAX_LENGTH) { return -1; }
  14419. if (chunk_len == 0) {
  14420. chunk_remaining = 0;
  14421. finished = true;
  14422. out_chunk_offset = 0;
  14423. out_chunk_total = 0;
  14424. return 0;
  14425. }
  14426. chunk_remaining = chunk_len;
  14427. last_chunk_total = chunk_remaining;
  14428. last_chunk_offset = 0;
  14429. }
  14430. auto to_read = (std::min)(chunk_remaining, len);
  14431. auto n = strm.read(buf, to_read);
  14432. if (n <= 0) { return -1; }
  14433. auto offset_before = last_chunk_offset;
  14434. last_chunk_offset += static_cast<size_t>(n);
  14435. chunk_remaining -= static_cast<size_t>(n);
  14436. out_chunk_offset = offset_before;
  14437. out_chunk_total = last_chunk_total;
  14438. if (chunk_remaining == 0) {
  14439. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  14440. if (!lr.getline()) { return -1; }
  14441. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  14442. }
  14443. return n;
  14444. }
  14445. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  14446. const Headers &src_headers) {
  14447. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  14448. if (!lr.getline()) { return false; }
  14449. return parse_trailers(lr, dest, src_headers);
  14450. }
  14451. // Only 301, 302, 303, 307 and 308 redirect. Any other 3xx, such as a 304, or
  14452. // a redirect without a Location, is a final response.
  14453. inline bool is_redirect(const Response &res) {
  14454. switch (res.status) {
  14455. case StatusCode::MovedPermanently_301:
  14456. case StatusCode::Found_302:
  14457. case StatusCode::SeeOther_303:
  14458. case StatusCode::TemporaryRedirect_307:
  14459. case StatusCode::PermanentRedirect_308:
  14460. return !res.get_header_value("Location").empty();
  14461. default: return false;
  14462. }
  14463. }
  14464. } // namespace detail
  14465. inline void
  14466. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  14467. handle.connection_->sock = socket_.sock;
  14468. #ifdef CPPHTTPLIB_SSL_ENABLED
  14469. handle.connection_->session = socket_.ssl;
  14470. socket_.ssl = nullptr;
  14471. #endif
  14472. socket_.sock = INVALID_SOCKET;
  14473. }
  14474. // A plain HTTP proxy reads the target in absolute-form (RFC 9112 3.2.2)
  14475. inline std::string ClientImpl::proxy_target_prefix() const {
  14476. if (is_ssl() || !is_proxy_enabled_for_host(host_)) { return std::string(); }
  14477. return "http://" + detail::make_host_and_port_string(host_, port_, false);
  14478. }
  14479. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  14480. Response &res, bool close_connection,
  14481. Error &error) {
  14482. if (req.path.empty()) {
  14483. error = Error::Connection;
  14484. return false;
  14485. }
  14486. auto req_save = req;
  14487. bool ret;
  14488. auto prefix = proxy_target_prefix();
  14489. if (!prefix.empty()) {
  14490. // The path follows the authority in absolute-form, so one that does not
  14491. // begin with '/' (e.g. "@evil.example/x") would name another host.
  14492. if (req.path[0] != '/') {
  14493. error = Error::Write;
  14494. return false;
  14495. }
  14496. auto req2 = req;
  14497. req2.path = prefix + req.path;
  14498. ret = process_request(strm, req2, res, close_connection, error);
  14499. req = std::move(req2);
  14500. req.path = req_save.path;
  14501. } else {
  14502. ret = process_request(strm, req, res, close_connection, error);
  14503. }
  14504. if (!ret) { return false; }
  14505. {
  14506. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  14507. // for this to be safe.
  14508. // This is safe to call because handle_request is only called by send_
  14509. // which locks the request mutex during the process. It would be a bug
  14510. // to call it from a different thread since it's a thread-safety issue
  14511. // to do these things to the socket if another thread is using the socket.
  14512. std::lock_guard<std::mutex> guard(socket_mutex_);
  14513. // Also when the request asked for it (e.g. a body that was never sent,
  14514. // or "Connection: close") or bytes follow the response (RFC 9112 9.2), so
  14515. // that a redirect or an auth retry below does not reuse the socket.
  14516. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  14517. strm.is_readable() ||
  14518. detail::has_header_token(res.headers, "Connection", "close") ||
  14519. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  14520. disconnect(/*gracefully=*/true);
  14521. }
  14522. }
  14523. if (follow_location_ && detail::is_redirect(res)) {
  14524. req = std::move(req_save);
  14525. // The client that followed the redirect has answered any challenge it
  14526. // could. Retrying below would sign another host's challenge and send it
  14527. // here.
  14528. return redirect(req, res, error);
  14529. }
  14530. #ifdef CPPHTTPLIB_SSL_ENABLED
  14531. if ((res.status == StatusCode::Unauthorized_401 ||
  14532. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  14533. req.authorization_count_ < 5) {
  14534. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  14535. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  14536. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  14537. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  14538. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  14539. return ret;
  14540. }
  14541. const auto &username =
  14542. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  14543. const auto &password =
  14544. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  14545. if (!username.empty() && !password.empty()) {
  14546. std::map<std::string, std::string> auth;
  14547. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  14548. Request new_req = req;
  14549. new_req.authorization_count_ += 1;
  14550. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  14551. : "Authorization");
  14552. new_req.headers.insert(detail::make_digest_authentication_header(
  14553. req, make_request_target(req), auth, new_req.authorization_count_,
  14554. detail::random_string(10), username, password, is_proxy));
  14555. Response new_res;
  14556. ret = send(new_req, new_res, error);
  14557. if (ret) { res = std::move(new_res); }
  14558. }
  14559. }
  14560. }
  14561. #endif
  14562. return ret;
  14563. }
  14564. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  14565. if (req.redirect_count_ == 0) {
  14566. error = Error::ExceedRedirectCount;
  14567. return false;
  14568. }
  14569. auto location = res.get_header_value("location");
  14570. if (location.empty()) { return false; }
  14571. auto next_url = detail::resolve_relative_location(location, req.path);
  14572. detail::UrlComponents uc;
  14573. if (!detail::parse_url(next_url, uc)) { return false; }
  14574. // Follow only http/https URLs and references starting with '/'
  14575. if (next_url[0] != '/' && uc.scheme != "http" && uc.scheme != "https") {
  14576. return false;
  14577. }
  14578. auto scheme = is_ssl() ? "https" : "http";
  14579. auto next_scheme = std::move(uc.scheme);
  14580. auto next_host = std::move(uc.host);
  14581. auto port_str = std::move(uc.port);
  14582. auto next_path = std::move(uc.path);
  14583. auto next_query = std::move(uc.query);
  14584. auto next_port = port_;
  14585. if (!port_str.empty()) {
  14586. if (!detail::parse_port(port_str, next_port)) { return false; }
  14587. } else if (!next_scheme.empty()) {
  14588. next_port = next_scheme == "https" ? 443 : 80;
  14589. }
  14590. if (next_scheme.empty()) { next_scheme = scheme; }
  14591. if (next_host.empty()) { next_host = host_; }
  14592. if (next_path.empty()) { next_path = "/"; }
  14593. // An absolute or absolute-path location can have dot segments too.
  14594. if (next_path[0] == '/') {
  14595. next_path = detail::remove_dot_segments(next_path);
  14596. }
  14597. auto path = std::move(next_path) + next_query;
  14598. // A Unix socket client sends "Host: localhost", so a Location naming
  14599. // localhost names this client too.
  14600. auto is_same_host = next_host == host_ ||
  14601. (address_family_ == AF_UNIX && next_host == "localhost");
  14602. // Same host redirect - use current client
  14603. if (next_scheme == scheme && is_same_host && next_port == port_) {
  14604. return detail::redirect(*this, req, res, path, location, error);
  14605. }
  14606. // Cross-host/scheme redirect - create new client with robust setup
  14607. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  14608. path, location, error);
  14609. }
  14610. // New method for robust redirect client creation
  14611. inline bool ClientImpl::create_redirect_client(
  14612. const std::string &scheme, const std::string &host, int port, Request &req,
  14613. Response &res, const std::string &path, const std::string &location,
  14614. Error &error) {
  14615. // Determine if we need SSL
  14616. auto need_ssl = (scheme == "https");
  14617. // Clean up request headers that are host/client specific
  14618. // Remove headers that should not be carried over to new host
  14619. auto headers_to_remove = std::vector<std::string>{
  14620. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  14621. for (const auto &header_name : headers_to_remove) {
  14622. auto it = req.headers.find(header_name);
  14623. while (it != req.headers.end()) {
  14624. it = req.headers.erase(it);
  14625. it = req.headers.find(header_name);
  14626. }
  14627. }
  14628. // Create appropriate client type and handle redirect
  14629. if (need_ssl) {
  14630. #ifdef CPPHTTPLIB_SSL_ENABLED
  14631. // Create SSL client for HTTPS redirect
  14632. SSLClient redirect_client(host, port);
  14633. // Setup basic client configuration first
  14634. setup_redirect_client(redirect_client);
  14635. redirect_client.enable_server_certificate_verification(
  14636. server_certificate_verification_);
  14637. redirect_client.enable_server_hostname_verification(
  14638. server_hostname_verification_);
  14639. redirect_client.system_ca_mode_ = system_ca_mode_;
  14640. // Transfer CA certificate to redirect client
  14641. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  14642. if (is_ssl()) {
  14643. auto &self = static_cast<SSLClient &>(*this);
  14644. // A store given to set_ca_cert_store() lives only in this client's
  14645. // context, which then holds all that is trusted.
  14646. if (self.ca_cert_store_set_) {
  14647. std::string pem;
  14648. {
  14649. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  14650. pem = detail::ca_certs_to_pem(self.ctx_);
  14651. }
  14652. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  14653. redirect_client.ca_cert_store_set_ = true;
  14654. } else if (self.custom_ca_loaded_) {
  14655. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  14656. ca_cert_pem_.size());
  14657. }
  14658. redirect_client.set_session_verifier(self.session_verifier_);
  14659. if (self.server_certificate_verifier_) {
  14660. redirect_client.set_server_certificate_verifier(
  14661. self.server_certificate_verifier_);
  14662. }
  14663. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  14664. redirect_client.enable_windows_cert_verification_ =
  14665. self.enable_windows_cert_verification_;
  14666. #endif
  14667. }
  14668. // Client certificates are set through constructor for SSLClient
  14669. // NOTE: SSLClient constructor already takes client_cert_path and
  14670. // client_key_path so we need to create it properly if client certs are
  14671. // needed
  14672. // Execute the redirect
  14673. return detail::redirect(redirect_client, req, res, path, location, error);
  14674. #else
  14675. // SSL not supported - set appropriate error
  14676. error = Error::SSLConnection;
  14677. return false;
  14678. #endif
  14679. } else {
  14680. // HTTP redirect
  14681. ClientImpl redirect_client(host, port);
  14682. // Setup client with robust configuration
  14683. setup_redirect_client(redirect_client);
  14684. // Execute the redirect
  14685. return detail::redirect(redirect_client, req, res, path, location, error);
  14686. }
  14687. }
  14688. // New method for robust client setup (based on basic_manual_redirect.cpp
  14689. // logic)
  14690. template <typename ClientType>
  14691. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  14692. // Copy basic settings first
  14693. client.set_connection_timeout(connection_timeout_sec_,
  14694. connection_timeout_usec_);
  14695. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14696. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  14697. client.set_max_timeout(max_timeout_msec_);
  14698. if (has_payload_max_length_) {
  14699. client.set_payload_max_length(payload_max_length_);
  14700. }
  14701. client.set_keep_alive(keep_alive_);
  14702. client.set_follow_location(
  14703. true); // Enable redirects to handle multi-step redirects
  14704. client.set_path_encode(path_encode_);
  14705. client.set_compress(compress_);
  14706. client.set_decompress(decompress_);
  14707. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  14708. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  14709. // 15.4, credentials must not be forwarded when redirecting to a different
  14710. // host. This function is only called for cross-host redirects; same-host
  14711. // redirects are handled directly in ClientImpl::redirect().
  14712. // Copy the proxy configuration unconditionally; the per-target bypass is
  14713. // re-evaluated at send time, so a later hop to a non-bypassed host can
  14714. // still use the proxy.
  14715. client.no_proxy_entries_ = no_proxy_entries_;
  14716. if (!proxy_host_.empty() && proxy_port_ != -1) {
  14717. client.set_proxy(proxy_host_, proxy_port_);
  14718. if (!proxy_basic_auth_username_.empty() ||
  14719. !proxy_basic_auth_password_.empty()) {
  14720. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  14721. proxy_basic_auth_password_);
  14722. }
  14723. if (!proxy_bearer_token_auth_token_.empty()) {
  14724. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  14725. }
  14726. #ifdef CPPHTTPLIB_SSL_ENABLED
  14727. if (!proxy_digest_auth_username_.empty()) {
  14728. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  14729. proxy_digest_auth_password_);
  14730. }
  14731. #endif
  14732. }
  14733. // Copy network and socket settings
  14734. client.addr_map_ = addr_map_;
  14735. client.tunnel_addr_map_ = tunnel_addr_map_;
  14736. // A Unix socket client reaches every host through its own socket, as curl's
  14737. // --unix-socket does, unless the caller mapped that host elsewhere. The
  14738. // Location's host is never taken as a socket path.
  14739. if (address_family_ == AF_UNIX) {
  14740. auto &target = client.addr_map_[client.host()];
  14741. if (target.empty()) { target = detail::addr_map_target(addr_map_, host_); }
  14742. }
  14743. client.set_address_family(address_family_);
  14744. client.set_tcp_nodelay(tcp_nodelay_);
  14745. client.set_ipv6_v6only(ipv6_v6only_);
  14746. if (socket_options_) { client.set_socket_options(socket_options_); }
  14747. if (!interface_.empty()) { client.set_interface(interface_); }
  14748. // Copy logging and headers. Not the error logger: a failure comes back to
  14749. // this client's send(), which reports it with the caller's request.
  14750. if (logger_) { client.set_logger(logger_); }
  14751. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  14752. // Each new client should generate its own headers based on its target host
  14753. }
  14754. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  14755. const Request &req,
  14756. Error &error) const {
  14757. auto is_shutting_down = []() { return false; };
  14758. if (req.is_chunked_content_provider_) {
  14759. auto compressor = compress_ ? detail::create_compressor().first
  14760. : std::unique_ptr<detail::compressor>();
  14761. if (!compressor) {
  14762. compressor = detail::make_unique<detail::nocompressor>();
  14763. }
  14764. return detail::write_content_chunked(strm, req.content_provider_,
  14765. is_shutting_down, *compressor, error);
  14766. } else {
  14767. return detail::write_content_with_progress(
  14768. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  14769. req.upload_progress, error);
  14770. }
  14771. }
  14772. // What goes on the request line for req: its path, encoded and without the
  14773. // fragment, with `req.params` as the query when the path has none.
  14774. inline std::string ClientImpl::make_request_target(const Request &req) const {
  14775. auto target = detail::encode_request_target(req.path, path_encode_);
  14776. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  14777. target = append_query_params(target, req.params);
  14778. }
  14779. return target;
  14780. }
  14781. inline void ClientImpl::add_credential_headers(Request &req) {
  14782. // A CONNECT request is read by the proxy; everything sent through the tunnel
  14783. // it opens is read by the origin. Each credential goes only to its own hop.
  14784. auto is_connect = req.method == "CONNECT";
  14785. if (!is_connect) {
  14786. detail::add_authorization_header(req, basic_auth_username_,
  14787. basic_auth_password_,
  14788. bearer_token_auth_token_, false);
  14789. }
  14790. // Proxy-Authorization is only sent when the proxy reads this message —
  14791. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  14792. // would leak proxy credentials to the destination server.
  14793. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  14794. detail::add_authorization_header(req, proxy_basic_auth_username_,
  14795. proxy_basic_auth_password_,
  14796. proxy_bearer_token_auth_token_, true);
  14797. }
  14798. }
  14799. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  14800. bool close_connection, Error &error,
  14801. bool skip_body, bool &rejected_locally) {
  14802. rejected_locally = false;
  14803. // Prepare additional headers
  14804. if (close_connection) {
  14805. if (!req.has_header("Connection")) {
  14806. req.set_header("Connection", "close");
  14807. }
  14808. }
  14809. std::string ct_for_defaults;
  14810. if (!req.has_header("Content-Type") && !req.body.empty()) {
  14811. ct_for_defaults = "text/plain";
  14812. }
  14813. prepare_default_headers(req, false, ct_for_defaults);
  14814. if (req.body.empty()) {
  14815. if (req.content_provider_) {
  14816. if (!req.is_chunked_content_provider_) {
  14817. if (!req.has_header("Content-Length")) {
  14818. auto length = std::to_string(req.content_length_);
  14819. req.set_header("Content-Length", length);
  14820. }
  14821. }
  14822. } else {
  14823. if (req.method == "POST" || req.method == "PUT" ||
  14824. req.method == "PATCH") {
  14825. req.set_header("Content-Length", "0");
  14826. }
  14827. }
  14828. }
  14829. add_credential_headers(req);
  14830. // Request line and headers
  14831. {
  14832. detail::BufferStream bstrm;
  14833. auto path_with_query = make_request_target(req);
  14834. // The query already came in through `req.path`; still populate
  14835. // `req.params` for handlers/users who read them.
  14836. auto query_part = detail::query_of(req.path);
  14837. if (!query_part.empty()) {
  14838. detail::parse_query_text(query_part, req.params);
  14839. }
  14840. // Write request line and headers
  14841. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  14842. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  14843. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  14844. // fail the request cleanly instead of emitting a request-line-less,
  14845. // header-injecting request.
  14846. error = Error::Write;
  14847. rejected_locally = true;
  14848. return false;
  14849. }
  14850. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14851. error)) {
  14852. rejected_locally = true;
  14853. return false;
  14854. }
  14855. // Flush buffer
  14856. auto &data = bstrm.get_buffer();
  14857. if (!detail::write_data(strm, data.data(), data.size())) {
  14858. error = Error::Write;
  14859. return false;
  14860. }
  14861. }
  14862. // After sending request line and headers, wait briefly for an early server
  14863. // response (e.g. 4xx) and avoid sending a potentially large request body
  14864. // unnecessarily. This workaround is only enabled on Windows because Unix
  14865. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  14866. // buffering can accept large writes even when the peer already responded.
  14867. // Check the stream first (which covers SSL via `is_readable()`), then
  14868. // fall back to select on the socket. Only perform the wait for very large
  14869. // request bodies to avoid interfering with normal small requests and
  14870. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  14871. // response. Skip this check when using Expect: 100-continue, as the protocol
  14872. // handles early responses properly.
  14873. #if defined(_WIN32)
  14874. if (!skip_body &&
  14875. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  14876. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  14877. auto start = std::chrono::high_resolution_clock::now();
  14878. for (;;) {
  14879. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  14880. // from SSL internals. If the underlying socket is readable, assume an
  14881. // early response may be present.
  14882. auto sock = strm.socket();
  14883. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  14884. return false;
  14885. }
  14886. // Fallback to stream-level check for non-socket streams or when the
  14887. // socket isn't reporting readable. Avoid using `is_readable()` for
  14888. // SSL, since `SSL_pending()` may report buffered records that do not
  14889. // indicate a complete application-level response yet.
  14890. if (!is_ssl() && strm.is_readable()) { return false; }
  14891. auto now = std::chrono::high_resolution_clock::now();
  14892. auto elapsed =
  14893. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  14894. .count();
  14895. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  14896. break;
  14897. }
  14898. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  14899. }
  14900. }
  14901. #endif
  14902. // Body
  14903. if (skip_body) { return true; }
  14904. return write_request_body(strm, req, error);
  14905. }
  14906. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  14907. Error &error) {
  14908. if (req.body.empty()) {
  14909. return write_content_with_provider(strm, req, error);
  14910. }
  14911. if (req.upload_progress) {
  14912. auto body_size = req.body.size();
  14913. size_t written = 0;
  14914. auto data = req.body.data();
  14915. while (written < body_size) {
  14916. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  14917. if (!detail::write_data(strm, data + written, to_write)) {
  14918. error = Error::Write;
  14919. return false;
  14920. }
  14921. written += to_write;
  14922. if (!req.upload_progress(written, body_size)) {
  14923. error = Error::Canceled;
  14924. return false;
  14925. }
  14926. }
  14927. } else {
  14928. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14929. error = Error::Write;
  14930. return false;
  14931. }
  14932. }
  14933. return true;
  14934. }
  14935. inline std::unique_ptr<Response>
  14936. ClientImpl::send_with_content_provider_and_receiver(
  14937. Request &req, const char *body, size_t content_length,
  14938. ContentProvider content_provider,
  14939. ContentProviderWithoutLength content_provider_without_length,
  14940. const std::string &content_type, ContentReceiver content_receiver,
  14941. Error &error) {
  14942. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14943. auto enc = compress_
  14944. ? detail::create_compressor()
  14945. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14946. nullptr, nullptr);
  14947. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14948. // A compressed or chunked body is framed by the library, not the caller
  14949. if (enc.second || content_provider_without_length) {
  14950. req.headers.erase("Content-Length");
  14951. }
  14952. if (enc.first && !content_provider_without_length) {
  14953. auto &compressor = enc.first;
  14954. if (content_provider) {
  14955. auto ok = true;
  14956. auto finished = false;
  14957. size_t offset = 0;
  14958. DataSink data_sink;
  14959. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14960. if (ok) {
  14961. auto last = offset + data_len == content_length;
  14962. auto ret = compressor->compress(
  14963. data, data_len, last,
  14964. [&](const char *compressed_data, size_t compressed_data_len) {
  14965. req.body.append(compressed_data, compressed_data_len);
  14966. return true;
  14967. });
  14968. if (ret) {
  14969. offset += data_len;
  14970. } else {
  14971. ok = false;
  14972. }
  14973. }
  14974. return ok;
  14975. };
  14976. // As in detail::write_content_with_progress(): the body is framed by
  14977. // content_length, so a provider that finishes early has truncated it.
  14978. // Stop and report that instead of calling the provider forever.
  14979. data_sink.done = [&]() { finished = true; };
  14980. while (ok && !finished && offset < content_length) {
  14981. if (!content_provider(offset, content_length - offset, data_sink)) {
  14982. error = Error::Canceled;
  14983. output_error_log(error, &req);
  14984. return nullptr;
  14985. }
  14986. }
  14987. // A short body here means either the provider stopped early or the
  14988. // compressor gave up. The branch below reports a failing compressor as
  14989. // Error::Compression, so keep the two distinguishable.
  14990. if (offset < content_length) {
  14991. error = ok ? Error::Write : Error::Compression;
  14992. output_error_log(error, &req);
  14993. return nullptr;
  14994. }
  14995. } else {
  14996. if (!compressor->compress(body, content_length, true,
  14997. [&](const char *data, size_t data_len) {
  14998. req.body.append(data, data_len);
  14999. return true;
  15000. })) {
  15001. error = Error::Compression;
  15002. output_error_log(error, &req);
  15003. return nullptr;
  15004. }
  15005. }
  15006. } else {
  15007. if (content_provider) {
  15008. req.content_length_ = content_length;
  15009. req.content_provider_ = std::move(content_provider);
  15010. req.is_chunked_content_provider_ = false;
  15011. } else if (content_provider_without_length) {
  15012. req.content_length_ = 0;
  15013. req.content_provider_ = detail::ContentProviderAdapter(
  15014. std::move(content_provider_without_length));
  15015. req.is_chunked_content_provider_ = true;
  15016. req.set_header("Transfer-Encoding", "chunked");
  15017. } else {
  15018. req.body.assign(body, content_length);
  15019. }
  15020. }
  15021. if (content_receiver) {
  15022. req.content_receiver =
  15023. [content_receiver](const char *data, size_t data_length,
  15024. size_t /*offset*/, size_t /*total_length*/) {
  15025. return content_receiver(data, data_length);
  15026. };
  15027. }
  15028. auto res = detail::make_unique<Response>();
  15029. return send(req, *res, error) ? std::move(res) : nullptr;
  15030. }
  15031. inline Result ClientImpl::send_with_content_provider_and_receiver(
  15032. const std::string &method, const std::string &path, const Headers &headers,
  15033. const char *body, size_t content_length, ContentProvider content_provider,
  15034. ContentProviderWithoutLength content_provider_without_length,
  15035. const std::string &content_type, ContentReceiver content_receiver,
  15036. UploadProgress progress) {
  15037. Request req;
  15038. req.method = method;
  15039. req.headers = headers;
  15040. req.path = path;
  15041. req.upload_progress = std::move(progress);
  15042. if (max_timeout_msec_ > 0) {
  15043. req.start_time_ = std::chrono::steady_clock::now();
  15044. }
  15045. auto error = Error::Success;
  15046. #ifdef CPPHTTPLIB_SSL_ENABLED
  15047. // Hold the request lock until the Result has read this request's TLS error
  15048. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  15049. #endif
  15050. auto res = send_with_content_provider_and_receiver(
  15051. req, body, content_length, std::move(content_provider),
  15052. std::move(content_provider_without_length), content_type,
  15053. std::move(content_receiver), error);
  15054. #ifdef CPPHTTPLIB_SSL_ENABLED
  15055. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  15056. last_backend_error_};
  15057. #else
  15058. return Result{std::move(res), error, std::move(req.headers)};
  15059. #endif
  15060. }
  15061. inline void ClientImpl::output_log(const Request &req,
  15062. const Response &res) const {
  15063. if (logger_) {
  15064. std::lock_guard<std::mutex> guard(logger_mutex_);
  15065. logger_(req, res);
  15066. }
  15067. }
  15068. inline void ClientImpl::output_error_log(const Error &err,
  15069. const Request *req) const {
  15070. if (error_logger_) {
  15071. std::lock_guard<std::mutex> guard(logger_mutex_);
  15072. error_logger_(err, req);
  15073. }
  15074. }
  15075. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  15076. Response &res, bool close_connection,
  15077. Error &error) {
  15078. // Auto-add Expect: 100-continue for large bodies
  15079. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  15080. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  15081. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  15082. req.set_header("Expect", "100-continue");
  15083. }
  15084. }
  15085. // Check for Expect: 100-continue
  15086. auto expect_100_continue =
  15087. detail::has_header_token(req.headers, "Expect", "100-continue");
  15088. // Send request (skip body if using Expect: 100-continue)
  15089. auto rejected_locally = false;
  15090. auto write_request_success =
  15091. write_request(strm, req, close_connection, error, expect_100_continue,
  15092. rejected_locally);
  15093. // A failed write normally still reads the response below, since the server
  15094. // may have answered early (e.g. 413/414) and closed while the body was being
  15095. // sent. A request rejected before any byte reached the socket gets no such
  15096. // response, and waiting for one would block until the read timeout.
  15097. if (rejected_locally) { return false; }
  15098. #ifdef CPPHTTPLIB_SSL_ENABLED
  15099. if (is_ssl() && !expect_100_continue) {
  15100. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  15101. if (!is_proxy_enabled) {
  15102. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  15103. error = Error::SSLPeerCouldBeClosed_;
  15104. return false;
  15105. }
  15106. }
  15107. }
  15108. #endif
  15109. // Handle Expect: 100-continue.
  15110. //
  15111. // Wait for an interim/early response by attempting to read the status line
  15112. // under a short timeout, instead of trusting raw socket readability. Over
  15113. // TLS, post-handshake records (e.g. session tickets) make the socket
  15114. // readable without any HTTP response being available; relying on
  15115. // `select_read` there caused the body to be withheld forever and the
  15116. // request to fail with `Read` (#2458). If no status line arrives within the
  15117. // timeout, send the body anyway (matching curl's behavior).
  15118. auto status_line_read = false;
  15119. if (expect_100_continue && write_request_success) {
  15120. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  15121. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  15122. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  15123. strm.set_read_timeout(sec, usec);
  15124. status_line_read = read_response_line(strm, req, res, false);
  15125. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  15126. }
  15127. if (!status_line_read) {
  15128. // No interim response within the timeout: send the body and handle the
  15129. // response as usual.
  15130. if (!write_request_body(strm, req, error)) { return false; }
  15131. expect_100_continue = false; // Switch to normal response handling
  15132. }
  15133. }
  15134. // Receive response and headers
  15135. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  15136. if ((!status_line_read &&
  15137. !read_response_line(strm, req, res, !expect_100_continue)) ||
  15138. !detail::read_headers(strm, res.headers)) {
  15139. if (write_request_success) { error = Error::Read; }
  15140. return false;
  15141. }
  15142. if (!write_request_success) { return false; }
  15143. // Handle Expect: 100-continue response
  15144. if (expect_100_continue) {
  15145. if (res.status == StatusCode::Continue_100) {
  15146. // Server accepted, send the body
  15147. if (!write_request_body(strm, req, error)) { return false; }
  15148. // Read the actual response
  15149. res.headers.clear();
  15150. res.body.clear();
  15151. if (!read_response_line(strm, req, res) ||
  15152. !detail::read_headers(strm, res.headers)) {
  15153. error = Error::Read;
  15154. return false;
  15155. }
  15156. } else {
  15157. // A final response came first, so the body this request declared was
  15158. // never sent, and the server may still be waiting for it. The
  15159. // connection cannot carry another request.
  15160. std::lock_guard<std::mutex> guard(socket_mutex_);
  15161. socket_should_be_closed_when_request_is_done_ = true;
  15162. }
  15163. }
  15164. // Body
  15165. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  15166. req.method != "CONNECT") {
  15167. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  15168. // whose final transfer coding is not chunked is not ambiguous: its body
  15169. // runs until the server closes the connection, so it is not rejected.
  15170. // HEAD/204 are excluded above and a 304 carries no body.
  15171. if (res.status != StatusCode::NotModified_304) {
  15172. if (detail::has_conflicting_content_length(res.headers)) {
  15173. error = Error::Read;
  15174. return false;
  15175. }
  15176. if (detail::has_faulty_transfer_encoding(res)) {
  15177. std::lock_guard<std::mutex> guard(socket_mutex_);
  15178. socket_should_be_closed_when_request_is_done_ = true;
  15179. }
  15180. }
  15181. auto redirect = follow_location_ && detail::is_redirect(res);
  15182. if (req.response_handler && !redirect) {
  15183. if (!req.response_handler(res)) {
  15184. error = Error::Canceled;
  15185. return false;
  15186. }
  15187. }
  15188. auto out =
  15189. req.content_receiver
  15190. ? static_cast<ContentReceiverWithProgress>(
  15191. [&](const char *buf, size_t n, size_t off, size_t len) {
  15192. if (redirect) { return true; }
  15193. auto ret = req.content_receiver(buf, n, off, len);
  15194. if (!ret) { error = Error::Canceled; }
  15195. return ret;
  15196. })
  15197. : static_cast<ContentReceiverWithProgress>(
  15198. [&](const char *buf, size_t n, size_t /*off*/,
  15199. size_t /*len*/) {
  15200. assert(res.body.size() + n <= res.body.max_size());
  15201. if (payload_max_length_ > 0 &&
  15202. (res.body.size() >= payload_max_length_ ||
  15203. n > payload_max_length_ - res.body.size())) {
  15204. return false;
  15205. }
  15206. res.body.append(buf, n);
  15207. return true;
  15208. });
  15209. auto progress = [&](size_t current, size_t total) {
  15210. if (!req.download_progress || redirect) { return true; }
  15211. auto ret = req.download_progress(current, total);
  15212. if (!ret) { error = Error::Canceled; }
  15213. return ret;
  15214. };
  15215. if (res.has_header("Content-Length")) {
  15216. if (!req.content_receiver) {
  15217. auto len = res.get_header_value_u64("Content-Length");
  15218. if (len > res.body.max_size()) {
  15219. error = Error::Read;
  15220. return false;
  15221. }
  15222. // Content-Length is only the server's claim, so reserve no more than
  15223. // payload_max_length_ allows, nor more than 1 MiB before any of the
  15224. // body has arrived. A longer body grows as it is read.
  15225. auto reserve_len =
  15226. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  15227. if (payload_max_length_ > 0) {
  15228. reserve_len = (std::min)(reserve_len, payload_max_length_);
  15229. }
  15230. res.body.reserve(reserve_len);
  15231. }
  15232. }
  15233. if (res.status != StatusCode::NotModified_304) {
  15234. auto content_status = 0;
  15235. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  15236. ? (std::numeric_limits<size_t>::max)()
  15237. : payload_max_length_;
  15238. if (!detail::read_content(strm, res, max_length, content_status,
  15239. std::move(progress), std::move(out),
  15240. decompress_)) {
  15241. if (error != Error::Canceled) {
  15242. // Tell the caller apart from a plain read failure when the body was
  15243. // over the payload limit or could not be decoded because of its
  15244. // Content-Encoding.
  15245. switch (content_status) {
  15246. case StatusCode::PayloadTooLarge_413:
  15247. error = Error::ExceedMaxPayloadSize;
  15248. break;
  15249. case StatusCode::UnsupportedMediaType_415:
  15250. error = Error::UnsupportedContentEncoding;
  15251. break;
  15252. case StatusCode::InternalServerError_500:
  15253. error = Error::Compression;
  15254. break;
  15255. default: error = Error::Read; break;
  15256. }
  15257. }
  15258. return false;
  15259. }
  15260. }
  15261. }
  15262. // Log
  15263. output_log(req, res);
  15264. return true;
  15265. }
  15266. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  15267. const std::string &boundary, const UploadFormDataItems &items,
  15268. const FormDataProviderItems &provider_items) const {
  15269. size_t cur_item = 0;
  15270. size_t cur_start = 0;
  15271. // cur_item and cur_start are copied to within the std::function and
  15272. // maintain state between successive calls
  15273. return [&, cur_item, cur_start](size_t offset,
  15274. DataSink &sink) mutable -> bool {
  15275. if (!offset && !items.empty()) {
  15276. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  15277. return true;
  15278. } else if (cur_item < provider_items.size()) {
  15279. if (!cur_start) {
  15280. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  15281. provider_items[cur_item], boundary);
  15282. offset += begin.size();
  15283. cur_start = offset;
  15284. sink.os << begin;
  15285. }
  15286. DataSink cur_sink;
  15287. auto has_data = true;
  15288. cur_sink.write = sink.write;
  15289. // Forward is_writable so a provider item asking whether it may keep
  15290. // going gets the outer sink's answer rather than the default `true`.
  15291. cur_sink.is_writable = sink.is_writable;
  15292. cur_sink.done = [&]() { has_data = false; };
  15293. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  15294. return false;
  15295. }
  15296. if (!has_data) {
  15297. sink.os << detail::serialize_multipart_formdata_item_end();
  15298. cur_item++;
  15299. cur_start = 0;
  15300. }
  15301. return true;
  15302. } else {
  15303. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  15304. sink.done();
  15305. return true;
  15306. }
  15307. };
  15308. }
  15309. inline bool ClientImpl::process_socket(
  15310. const Socket &socket,
  15311. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15312. std::function<bool(Stream &strm)> callback) {
  15313. return detail::process_client_socket(
  15314. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  15315. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  15316. }
  15317. inline bool ClientImpl::is_ssl() const { return false; }
  15318. inline Result ClientImpl::Get(const std::string &path,
  15319. DownloadProgress progress) {
  15320. return Get(path, Headers(), std::move(progress));
  15321. }
  15322. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  15323. DownloadProgress progress) {
  15324. return Get(path, params, Headers(), std::move(progress));
  15325. }
  15326. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  15327. const Headers &headers,
  15328. DownloadProgress progress) {
  15329. if (params.empty()) { return Get(path, headers); }
  15330. std::string path_with_query = append_query_params(path, params);
  15331. return Get(path_with_query, headers, std::move(progress));
  15332. }
  15333. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  15334. DownloadProgress progress) {
  15335. Request req;
  15336. req.method = "GET";
  15337. req.path = path;
  15338. req.headers = headers;
  15339. req.download_progress = std::move(progress);
  15340. if (max_timeout_msec_ > 0) {
  15341. req.start_time_ = std::chrono::steady_clock::now();
  15342. }
  15343. return send_(std::move(req));
  15344. }
  15345. inline Result ClientImpl::Get(const std::string &path,
  15346. ContentReceiver content_receiver,
  15347. DownloadProgress progress) {
  15348. return Get(path, Headers(), nullptr, std::move(content_receiver),
  15349. std::move(progress));
  15350. }
  15351. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  15352. ContentReceiver content_receiver,
  15353. DownloadProgress progress) {
  15354. return Get(path, headers, nullptr, std::move(content_receiver),
  15355. std::move(progress));
  15356. }
  15357. inline Result ClientImpl::Get(const std::string &path,
  15358. ResponseHandler response_handler,
  15359. ContentReceiver content_receiver,
  15360. DownloadProgress progress) {
  15361. return Get(path, Headers(), std::move(response_handler),
  15362. std::move(content_receiver), std::move(progress));
  15363. }
  15364. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  15365. ResponseHandler response_handler,
  15366. ContentReceiver content_receiver,
  15367. DownloadProgress progress) {
  15368. Request req;
  15369. req.method = "GET";
  15370. req.path = path;
  15371. req.headers = headers;
  15372. req.response_handler = std::move(response_handler);
  15373. req.content_receiver =
  15374. [content_receiver](const char *data, size_t data_length,
  15375. size_t /*offset*/, size_t /*total_length*/) {
  15376. return content_receiver(data, data_length);
  15377. };
  15378. req.download_progress = std::move(progress);
  15379. if (max_timeout_msec_ > 0) {
  15380. req.start_time_ = std::chrono::steady_clock::now();
  15381. }
  15382. return send_(std::move(req));
  15383. }
  15384. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  15385. const Headers &headers,
  15386. ContentReceiver content_receiver,
  15387. DownloadProgress progress) {
  15388. return Get(path, params, headers, nullptr, std::move(content_receiver),
  15389. std::move(progress));
  15390. }
  15391. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  15392. const Headers &headers,
  15393. ResponseHandler response_handler,
  15394. ContentReceiver content_receiver,
  15395. DownloadProgress progress) {
  15396. if (params.empty()) {
  15397. return Get(path, headers, std::move(response_handler),
  15398. std::move(content_receiver), std::move(progress));
  15399. }
  15400. std::string path_with_query = append_query_params(path, params);
  15401. return Get(path_with_query, headers, std::move(response_handler),
  15402. std::move(content_receiver), std::move(progress));
  15403. }
  15404. inline Result ClientImpl::Head(const std::string &path) {
  15405. return Head(path, Headers());
  15406. }
  15407. inline Result ClientImpl::Head(const std::string &path,
  15408. const Headers &headers) {
  15409. Request req;
  15410. req.method = "HEAD";
  15411. req.headers = headers;
  15412. req.path = path;
  15413. if (max_timeout_msec_ > 0) {
  15414. req.start_time_ = std::chrono::steady_clock::now();
  15415. }
  15416. return send_(std::move(req));
  15417. }
  15418. inline Result ClientImpl::Post(const std::string &path) {
  15419. return Post(path, std::string(), std::string());
  15420. }
  15421. inline Result ClientImpl::Post(const std::string &path,
  15422. const Headers &headers) {
  15423. return Post(path, headers, nullptr, 0, std::string());
  15424. }
  15425. inline Result ClientImpl::Post(const std::string &path, const char *body,
  15426. size_t content_length,
  15427. const std::string &content_type,
  15428. UploadProgress progress) {
  15429. return Post(path, Headers(), body, content_length, content_type, progress);
  15430. }
  15431. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  15432. const std::string &content_type,
  15433. UploadProgress progress) {
  15434. return Post(path, Headers(), body, content_type, progress);
  15435. }
  15436. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  15437. return Post(path, Headers(), params);
  15438. }
  15439. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  15440. ContentProvider content_provider,
  15441. const std::string &content_type,
  15442. UploadProgress progress) {
  15443. return Post(path, Headers(), content_length, std::move(content_provider),
  15444. content_type, progress);
  15445. }
  15446. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  15447. ContentProvider content_provider,
  15448. const std::string &content_type,
  15449. ContentReceiver content_receiver,
  15450. UploadProgress progress) {
  15451. return Post(path, Headers(), content_length, std::move(content_provider),
  15452. content_type, std::move(content_receiver), progress);
  15453. }
  15454. inline Result ClientImpl::Post(const std::string &path,
  15455. ContentProviderWithoutLength content_provider,
  15456. const std::string &content_type,
  15457. UploadProgress progress) {
  15458. return Post(path, Headers(), std::move(content_provider), content_type,
  15459. progress);
  15460. }
  15461. inline Result ClientImpl::Post(const std::string &path,
  15462. ContentProviderWithoutLength content_provider,
  15463. const std::string &content_type,
  15464. ContentReceiver content_receiver,
  15465. UploadProgress progress) {
  15466. return Post(path, Headers(), std::move(content_provider), content_type,
  15467. std::move(content_receiver), progress);
  15468. }
  15469. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15470. const Params &params) {
  15471. auto query = detail::params_to_query_str(params);
  15472. return Post(path, headers, query, "application/x-www-form-urlencoded");
  15473. }
  15474. inline Result ClientImpl::Post(const std::string &path,
  15475. const UploadFormDataItems &items,
  15476. UploadProgress progress) {
  15477. return Post(path, Headers(), items, progress);
  15478. }
  15479. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15480. const UploadFormDataItems &items,
  15481. UploadProgress progress) {
  15482. const auto &boundary = detail::make_multipart_data_boundary();
  15483. const auto &content_type =
  15484. detail::serialize_multipart_formdata_get_content_type(boundary);
  15485. auto content_length = detail::get_multipart_content_length(items, boundary);
  15486. return Post(path, headers, content_length,
  15487. detail::make_multipart_content_provider(items, boundary),
  15488. content_type, progress);
  15489. }
  15490. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15491. const UploadFormDataItems &items,
  15492. const std::string &boundary,
  15493. UploadProgress progress) {
  15494. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15495. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15496. }
  15497. const auto &content_type =
  15498. detail::serialize_multipart_formdata_get_content_type(boundary);
  15499. auto content_length = detail::get_multipart_content_length(items, boundary);
  15500. return Post(path, headers, content_length,
  15501. detail::make_multipart_content_provider(items, boundary),
  15502. content_type, progress);
  15503. }
  15504. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15505. const char *body, size_t content_length,
  15506. const std::string &content_type,
  15507. UploadProgress progress) {
  15508. return send_with_content_provider_and_receiver(
  15509. "POST", path, headers, body, content_length, nullptr, nullptr,
  15510. content_type, nullptr, progress);
  15511. }
  15512. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15513. const std::string &body,
  15514. const std::string &content_type,
  15515. UploadProgress progress) {
  15516. return send_with_content_provider_and_receiver(
  15517. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  15518. content_type, nullptr, progress);
  15519. }
  15520. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15521. size_t content_length,
  15522. ContentProvider content_provider,
  15523. const std::string &content_type,
  15524. UploadProgress progress) {
  15525. return send_with_content_provider_and_receiver(
  15526. "POST", path, headers, nullptr, content_length,
  15527. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15528. }
  15529. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15530. size_t content_length,
  15531. ContentProvider content_provider,
  15532. const std::string &content_type,
  15533. ContentReceiver content_receiver,
  15534. DownloadProgress progress) {
  15535. return send_with_content_provider_and_receiver(
  15536. "POST", path, headers, nullptr, content_length,
  15537. std::move(content_provider), nullptr, content_type,
  15538. std::move(content_receiver), std::move(progress));
  15539. }
  15540. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15541. ContentProviderWithoutLength content_provider,
  15542. const std::string &content_type,
  15543. UploadProgress progress) {
  15544. return send_with_content_provider_and_receiver(
  15545. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15546. content_type, nullptr, progress);
  15547. }
  15548. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15549. ContentProviderWithoutLength content_provider,
  15550. const std::string &content_type,
  15551. ContentReceiver content_receiver,
  15552. DownloadProgress progress) {
  15553. return send_with_content_provider_and_receiver(
  15554. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15555. content_type, std::move(content_receiver), std::move(progress));
  15556. }
  15557. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15558. const UploadFormDataItems &items,
  15559. const FormDataProviderItems &provider_items,
  15560. UploadProgress progress) {
  15561. const auto &boundary = detail::make_multipart_data_boundary();
  15562. const auto &content_type =
  15563. detail::serialize_multipart_formdata_get_content_type(boundary);
  15564. return send_with_content_provider_and_receiver(
  15565. "POST", path, headers, nullptr, 0, nullptr,
  15566. get_multipart_content_provider(boundary, items, provider_items),
  15567. content_type, nullptr, progress);
  15568. }
  15569. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15570. const std::string &body,
  15571. const std::string &content_type,
  15572. ContentReceiver content_receiver,
  15573. DownloadProgress progress) {
  15574. Request req;
  15575. req.method = "POST";
  15576. req.path = path;
  15577. req.headers = headers;
  15578. req.body = body;
  15579. req.content_receiver =
  15580. [content_receiver](const char *data, size_t data_length,
  15581. size_t /*offset*/, size_t /*total_length*/) {
  15582. return content_receiver(data, data_length);
  15583. };
  15584. req.download_progress = std::move(progress);
  15585. if (max_timeout_msec_ > 0) {
  15586. req.start_time_ = std::chrono::steady_clock::now();
  15587. }
  15588. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15589. return send_(std::move(req));
  15590. }
  15591. inline Result ClientImpl::Put(const std::string &path) {
  15592. return Put(path, std::string(), std::string());
  15593. }
  15594. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  15595. return Put(path, headers, nullptr, 0, std::string());
  15596. }
  15597. inline Result ClientImpl::Put(const std::string &path, const char *body,
  15598. size_t content_length,
  15599. const std::string &content_type,
  15600. UploadProgress progress) {
  15601. return Put(path, Headers(), body, content_length, content_type, progress);
  15602. }
  15603. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  15604. const std::string &content_type,
  15605. UploadProgress progress) {
  15606. return Put(path, Headers(), body, content_type, progress);
  15607. }
  15608. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  15609. return Put(path, Headers(), params);
  15610. }
  15611. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  15612. ContentProvider content_provider,
  15613. const std::string &content_type,
  15614. UploadProgress progress) {
  15615. return Put(path, Headers(), content_length, std::move(content_provider),
  15616. content_type, progress);
  15617. }
  15618. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  15619. ContentProvider content_provider,
  15620. const std::string &content_type,
  15621. ContentReceiver content_receiver,
  15622. UploadProgress progress) {
  15623. return Put(path, Headers(), content_length, std::move(content_provider),
  15624. content_type, std::move(content_receiver), progress);
  15625. }
  15626. inline Result ClientImpl::Put(const std::string &path,
  15627. ContentProviderWithoutLength content_provider,
  15628. const std::string &content_type,
  15629. UploadProgress progress) {
  15630. return Put(path, Headers(), std::move(content_provider), content_type,
  15631. progress);
  15632. }
  15633. inline Result ClientImpl::Put(const std::string &path,
  15634. ContentProviderWithoutLength content_provider,
  15635. const std::string &content_type,
  15636. ContentReceiver content_receiver,
  15637. UploadProgress progress) {
  15638. return Put(path, Headers(), std::move(content_provider), content_type,
  15639. std::move(content_receiver), progress);
  15640. }
  15641. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15642. const Params &params) {
  15643. auto query = detail::params_to_query_str(params);
  15644. return Put(path, headers, query, "application/x-www-form-urlencoded");
  15645. }
  15646. inline Result ClientImpl::Put(const std::string &path,
  15647. const UploadFormDataItems &items,
  15648. UploadProgress progress) {
  15649. return Put(path, Headers(), items, progress);
  15650. }
  15651. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15652. const UploadFormDataItems &items,
  15653. UploadProgress progress) {
  15654. const auto &boundary = detail::make_multipart_data_boundary();
  15655. const auto &content_type =
  15656. detail::serialize_multipart_formdata_get_content_type(boundary);
  15657. auto content_length = detail::get_multipart_content_length(items, boundary);
  15658. return Put(path, headers, content_length,
  15659. detail::make_multipart_content_provider(items, boundary),
  15660. content_type, progress);
  15661. }
  15662. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15663. const UploadFormDataItems &items,
  15664. const std::string &boundary,
  15665. UploadProgress progress) {
  15666. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15667. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15668. }
  15669. const auto &content_type =
  15670. detail::serialize_multipart_formdata_get_content_type(boundary);
  15671. auto content_length = detail::get_multipart_content_length(items, boundary);
  15672. return Put(path, headers, content_length,
  15673. detail::make_multipart_content_provider(items, boundary),
  15674. content_type, progress);
  15675. }
  15676. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15677. const char *body, size_t content_length,
  15678. const std::string &content_type,
  15679. UploadProgress progress) {
  15680. return send_with_content_provider_and_receiver(
  15681. "PUT", path, headers, body, content_length, nullptr, nullptr,
  15682. content_type, nullptr, progress);
  15683. }
  15684. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15685. const std::string &body,
  15686. const std::string &content_type,
  15687. UploadProgress progress) {
  15688. return send_with_content_provider_and_receiver(
  15689. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  15690. content_type, nullptr, progress);
  15691. }
  15692. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15693. size_t content_length,
  15694. ContentProvider content_provider,
  15695. const std::string &content_type,
  15696. UploadProgress progress) {
  15697. return send_with_content_provider_and_receiver(
  15698. "PUT", path, headers, nullptr, content_length,
  15699. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15700. }
  15701. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15702. size_t content_length,
  15703. ContentProvider content_provider,
  15704. const std::string &content_type,
  15705. ContentReceiver content_receiver,
  15706. UploadProgress progress) {
  15707. return send_with_content_provider_and_receiver(
  15708. "PUT", path, headers, nullptr, content_length,
  15709. std::move(content_provider), nullptr, content_type,
  15710. std::move(content_receiver), progress);
  15711. }
  15712. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15713. ContentProviderWithoutLength content_provider,
  15714. const std::string &content_type,
  15715. UploadProgress progress) {
  15716. return send_with_content_provider_and_receiver(
  15717. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15718. content_type, nullptr, progress);
  15719. }
  15720. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15721. ContentProviderWithoutLength content_provider,
  15722. const std::string &content_type,
  15723. ContentReceiver content_receiver,
  15724. UploadProgress progress) {
  15725. return send_with_content_provider_and_receiver(
  15726. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15727. content_type, std::move(content_receiver), progress);
  15728. }
  15729. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15730. const UploadFormDataItems &items,
  15731. const FormDataProviderItems &provider_items,
  15732. UploadProgress progress) {
  15733. const auto &boundary = detail::make_multipart_data_boundary();
  15734. const auto &content_type =
  15735. detail::serialize_multipart_formdata_get_content_type(boundary);
  15736. return send_with_content_provider_and_receiver(
  15737. "PUT", path, headers, nullptr, 0, nullptr,
  15738. get_multipart_content_provider(boundary, items, provider_items),
  15739. content_type, nullptr, progress);
  15740. }
  15741. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15742. const std::string &body,
  15743. const std::string &content_type,
  15744. ContentReceiver content_receiver,
  15745. DownloadProgress progress) {
  15746. Request req;
  15747. req.method = "PUT";
  15748. req.path = path;
  15749. req.headers = headers;
  15750. req.body = body;
  15751. req.content_receiver =
  15752. [content_receiver](const char *data, size_t data_length,
  15753. size_t /*offset*/, size_t /*total_length*/) {
  15754. return content_receiver(data, data_length);
  15755. };
  15756. req.download_progress = std::move(progress);
  15757. if (max_timeout_msec_ > 0) {
  15758. req.start_time_ = std::chrono::steady_clock::now();
  15759. }
  15760. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15761. return send_(std::move(req));
  15762. }
  15763. inline Result ClientImpl::Patch(const std::string &path) {
  15764. return Patch(path, std::string(), std::string());
  15765. }
  15766. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15767. UploadProgress progress) {
  15768. return Patch(path, headers, nullptr, 0, std::string(), progress);
  15769. }
  15770. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  15771. size_t content_length,
  15772. const std::string &content_type,
  15773. UploadProgress progress) {
  15774. return Patch(path, Headers(), body, content_length, content_type, progress);
  15775. }
  15776. inline Result ClientImpl::Patch(const std::string &path,
  15777. const std::string &body,
  15778. const std::string &content_type,
  15779. UploadProgress progress) {
  15780. return Patch(path, Headers(), body, content_type, progress);
  15781. }
  15782. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  15783. return Patch(path, Headers(), params);
  15784. }
  15785. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15786. ContentProvider content_provider,
  15787. const std::string &content_type,
  15788. UploadProgress progress) {
  15789. return Patch(path, Headers(), content_length, std::move(content_provider),
  15790. content_type, progress);
  15791. }
  15792. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15793. ContentProvider content_provider,
  15794. const std::string &content_type,
  15795. ContentReceiver content_receiver,
  15796. UploadProgress progress) {
  15797. return Patch(path, Headers(), content_length, std::move(content_provider),
  15798. content_type, std::move(content_receiver), progress);
  15799. }
  15800. inline Result ClientImpl::Patch(const std::string &path,
  15801. ContentProviderWithoutLength content_provider,
  15802. const std::string &content_type,
  15803. UploadProgress progress) {
  15804. return Patch(path, Headers(), std::move(content_provider), content_type,
  15805. progress);
  15806. }
  15807. inline Result ClientImpl::Patch(const std::string &path,
  15808. ContentProviderWithoutLength content_provider,
  15809. const std::string &content_type,
  15810. ContentReceiver content_receiver,
  15811. UploadProgress progress) {
  15812. return Patch(path, Headers(), std::move(content_provider), content_type,
  15813. std::move(content_receiver), progress);
  15814. }
  15815. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15816. const Params &params) {
  15817. auto query = detail::params_to_query_str(params);
  15818. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  15819. }
  15820. inline Result ClientImpl::Patch(const std::string &path,
  15821. const UploadFormDataItems &items,
  15822. UploadProgress progress) {
  15823. return Patch(path, Headers(), items, progress);
  15824. }
  15825. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15826. const UploadFormDataItems &items,
  15827. UploadProgress progress) {
  15828. const auto &boundary = detail::make_multipart_data_boundary();
  15829. const auto &content_type =
  15830. detail::serialize_multipart_formdata_get_content_type(boundary);
  15831. auto content_length = detail::get_multipart_content_length(items, boundary);
  15832. return Patch(path, headers, content_length,
  15833. detail::make_multipart_content_provider(items, boundary),
  15834. content_type, progress);
  15835. }
  15836. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15837. const UploadFormDataItems &items,
  15838. const std::string &boundary,
  15839. UploadProgress progress) {
  15840. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15841. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15842. }
  15843. const auto &content_type =
  15844. detail::serialize_multipart_formdata_get_content_type(boundary);
  15845. auto content_length = detail::get_multipart_content_length(items, boundary);
  15846. return Patch(path, headers, content_length,
  15847. detail::make_multipart_content_provider(items, boundary),
  15848. content_type, progress);
  15849. }
  15850. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15851. const char *body, size_t content_length,
  15852. const std::string &content_type,
  15853. UploadProgress progress) {
  15854. return send_with_content_provider_and_receiver(
  15855. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  15856. content_type, nullptr, progress);
  15857. }
  15858. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15859. const std::string &body,
  15860. const std::string &content_type,
  15861. UploadProgress progress) {
  15862. return send_with_content_provider_and_receiver(
  15863. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  15864. content_type, nullptr, progress);
  15865. }
  15866. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15867. size_t content_length,
  15868. ContentProvider content_provider,
  15869. const std::string &content_type,
  15870. UploadProgress progress) {
  15871. return send_with_content_provider_and_receiver(
  15872. "PATCH", path, headers, nullptr, content_length,
  15873. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15874. }
  15875. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15876. size_t content_length,
  15877. ContentProvider content_provider,
  15878. const std::string &content_type,
  15879. ContentReceiver content_receiver,
  15880. UploadProgress progress) {
  15881. return send_with_content_provider_and_receiver(
  15882. "PATCH", path, headers, nullptr, content_length,
  15883. std::move(content_provider), nullptr, content_type,
  15884. std::move(content_receiver), progress);
  15885. }
  15886. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15887. ContentProviderWithoutLength content_provider,
  15888. const std::string &content_type,
  15889. UploadProgress progress) {
  15890. return send_with_content_provider_and_receiver(
  15891. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15892. content_type, nullptr, progress);
  15893. }
  15894. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15895. ContentProviderWithoutLength content_provider,
  15896. const std::string &content_type,
  15897. ContentReceiver content_receiver,
  15898. UploadProgress progress) {
  15899. return send_with_content_provider_and_receiver(
  15900. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15901. content_type, std::move(content_receiver), progress);
  15902. }
  15903. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15904. const UploadFormDataItems &items,
  15905. const FormDataProviderItems &provider_items,
  15906. UploadProgress progress) {
  15907. const auto &boundary = detail::make_multipart_data_boundary();
  15908. const auto &content_type =
  15909. detail::serialize_multipart_formdata_get_content_type(boundary);
  15910. return send_with_content_provider_and_receiver(
  15911. "PATCH", path, headers, nullptr, 0, nullptr,
  15912. get_multipart_content_provider(boundary, items, provider_items),
  15913. content_type, nullptr, progress);
  15914. }
  15915. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15916. const std::string &body,
  15917. const std::string &content_type,
  15918. ContentReceiver content_receiver,
  15919. DownloadProgress progress) {
  15920. Request req;
  15921. req.method = "PATCH";
  15922. req.path = path;
  15923. req.headers = headers;
  15924. req.body = body;
  15925. req.content_receiver =
  15926. [content_receiver](const char *data, size_t data_length,
  15927. size_t /*offset*/, size_t /*total_length*/) {
  15928. return content_receiver(data, data_length);
  15929. };
  15930. req.download_progress = std::move(progress);
  15931. if (max_timeout_msec_ > 0) {
  15932. req.start_time_ = std::chrono::steady_clock::now();
  15933. }
  15934. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15935. return send_(std::move(req));
  15936. }
  15937. inline Result ClientImpl::Delete(const std::string &path,
  15938. DownloadProgress progress) {
  15939. return Delete(path, Headers(), std::string(), std::string(), progress);
  15940. }
  15941. inline Result ClientImpl::Delete(const std::string &path,
  15942. const Headers &headers,
  15943. DownloadProgress progress) {
  15944. return Delete(path, headers, std::string(), std::string(), progress);
  15945. }
  15946. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15947. size_t content_length,
  15948. const std::string &content_type,
  15949. DownloadProgress progress) {
  15950. return Delete(path, Headers(), body, content_length, content_type, progress);
  15951. }
  15952. inline Result ClientImpl::Delete(const std::string &path,
  15953. const std::string &body,
  15954. const std::string &content_type,
  15955. DownloadProgress progress) {
  15956. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15957. progress);
  15958. }
  15959. inline Result ClientImpl::Delete(const std::string &path,
  15960. const Headers &headers,
  15961. const std::string &body,
  15962. const std::string &content_type,
  15963. DownloadProgress progress) {
  15964. return Delete(path, headers, body.data(), body.size(), content_type,
  15965. progress);
  15966. }
  15967. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15968. DownloadProgress progress) {
  15969. return Delete(path, Headers(), params, progress);
  15970. }
  15971. inline Result ClientImpl::Delete(const std::string &path,
  15972. const Headers &headers, const Params &params,
  15973. DownloadProgress progress) {
  15974. auto query = detail::params_to_query_str(params);
  15975. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15976. progress);
  15977. }
  15978. inline Result ClientImpl::Delete(const std::string &path,
  15979. const Headers &headers, const char *body,
  15980. size_t content_length,
  15981. const std::string &content_type,
  15982. DownloadProgress progress) {
  15983. Request req;
  15984. req.method = "DELETE";
  15985. req.headers = headers;
  15986. req.path = path;
  15987. req.download_progress = std::move(progress);
  15988. if (max_timeout_msec_ > 0) {
  15989. req.start_time_ = std::chrono::steady_clock::now();
  15990. }
  15991. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15992. req.body.assign(body, content_length);
  15993. return send_(std::move(req));
  15994. }
  15995. inline Result ClientImpl::Options(const std::string &path) {
  15996. return Options(path, Headers());
  15997. }
  15998. inline Result ClientImpl::Options(const std::string &path,
  15999. const Headers &headers) {
  16000. Request req;
  16001. req.method = "OPTIONS";
  16002. req.headers = headers;
  16003. req.path = path;
  16004. if (max_timeout_msec_ > 0) {
  16005. req.start_time_ = std::chrono::steady_clock::now();
  16006. }
  16007. return send_(std::move(req));
  16008. }
  16009. inline void ClientImpl::stop() {
  16010. std::lock_guard<std::mutex> guard(socket_mutex_);
  16011. stop_requested_ = true;
  16012. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  16013. // do is to shutdown_socket, so that threads using this socket suddenly
  16014. // discover they can't read/write any more and error out. Everything else
  16015. // (closing the socket, shutting ssl down) is unsafe because these actions
  16016. // are not thread-safe.
  16017. if (socket_requests_in_flight_ > 0) {
  16018. shutdown_socket(socket_);
  16019. // Aside from that, we set a flag for the socket to be closed when we're
  16020. // done.
  16021. socket_should_be_closed_when_request_is_done_ = true;
  16022. return;
  16023. }
  16024. disconnect(/*gracefully=*/true);
  16025. }
  16026. inline std::string ClientImpl::host() const { return host_; }
  16027. inline int ClientImpl::port() const { return port_; }
  16028. inline size_t ClientImpl::is_socket_open() const {
  16029. std::lock_guard<std::mutex> guard(socket_mutex_);
  16030. return socket_.is_open();
  16031. }
  16032. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  16033. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  16034. connection_timeout_sec_ = sec;
  16035. connection_timeout_usec_ = usec;
  16036. }
  16037. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  16038. read_timeout_sec_ = sec;
  16039. read_timeout_usec_ = usec;
  16040. }
  16041. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  16042. write_timeout_sec_ = sec;
  16043. write_timeout_usec_ = usec;
  16044. }
  16045. inline void ClientImpl::set_max_timeout(time_t msec) {
  16046. max_timeout_msec_ = msec;
  16047. }
  16048. inline void ClientImpl::set_basic_auth(const std::string &username,
  16049. const std::string &password) {
  16050. basic_auth_username_ = username;
  16051. basic_auth_password_ = password;
  16052. }
  16053. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  16054. bearer_token_auth_token_ = token;
  16055. }
  16056. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  16057. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  16058. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  16059. inline void
  16060. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  16061. set_direct_hostname_addr_map(std::move(addr_map));
  16062. }
  16063. inline void ClientImpl::set_direct_hostname_addr_map(
  16064. std::map<std::string, std::string> addr_map) {
  16065. addr_map_ = std::move(addr_map);
  16066. }
  16067. inline void ClientImpl::set_tunnel_hostname_addr_map(
  16068. std::map<std::string, std::string> addr_map) {
  16069. tunnel_addr_map_ = std::move(addr_map);
  16070. }
  16071. inline void ClientImpl::set_default_headers(Headers headers) {
  16072. default_headers_ = std::move(headers);
  16073. }
  16074. inline void ClientImpl::set_header_writer(
  16075. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  16076. header_writer_ = writer;
  16077. }
  16078. inline void ClientImpl::set_address_family(int family) {
  16079. address_family_ = family;
  16080. }
  16081. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  16082. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  16083. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  16084. socket_options_ = std::move(socket_options);
  16085. }
  16086. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  16087. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  16088. inline void ClientImpl::set_payload_max_length(size_t length) {
  16089. payload_max_length_ = length;
  16090. has_payload_max_length_ = true;
  16091. }
  16092. inline void ClientImpl::set_interface(const std::string &intf) {
  16093. interface_ = intf;
  16094. }
  16095. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  16096. proxy_host_ = host;
  16097. proxy_port_ = port;
  16098. std::lock_guard<std::mutex> guard(socket_mutex_);
  16099. disconnect(/*gracefully=*/true);
  16100. }
  16101. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  16102. const std::string &password) {
  16103. proxy_basic_auth_username_ = username;
  16104. proxy_basic_auth_password_ = password;
  16105. }
  16106. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  16107. proxy_bearer_token_auth_token_ = token;
  16108. }
  16109. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  16110. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  16111. std::lock_guard<std::mutex> guard(socket_mutex_);
  16112. disconnect(/*gracefully=*/true);
  16113. }
  16114. #ifdef CPPHTTPLIB_SSL_ENABLED
  16115. inline void ClientImpl::set_digest_auth(const std::string &username,
  16116. const std::string &password) {
  16117. digest_auth_username_ = username;
  16118. digest_auth_password_ = password;
  16119. }
  16120. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  16121. const std::string &ca_cert_dir_path) {
  16122. ca_cert_file_path_ = ca_cert_file_path;
  16123. ca_cert_dir_path_ = ca_cert_dir_path;
  16124. }
  16125. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  16126. const std::string &password) {
  16127. proxy_digest_auth_username_ = username;
  16128. proxy_digest_auth_password_ = password;
  16129. }
  16130. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  16131. if (server_certificate_verification_ == enabled) { return; }
  16132. server_certificate_verification_ = enabled;
  16133. tls_settings_changed();
  16134. }
  16135. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  16136. if (server_hostname_verification_ == enabled) { return; }
  16137. server_hostname_verification_ = enabled;
  16138. tls_settings_changed();
  16139. }
  16140. inline void ClientImpl::enable_system_ca(bool enabled) {
  16141. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  16142. }
  16143. #endif
  16144. inline void ClientImpl::set_logger(Logger logger) {
  16145. logger_ = std::move(logger);
  16146. }
  16147. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  16148. error_logger_ = std::move(error_logger);
  16149. }
  16150. /*
  16151. * SSL/TLS Common Implementation
  16152. */
  16153. inline ClientConnection::~ClientConnection() {
  16154. #ifdef CPPHTTPLIB_SSL_ENABLED
  16155. if (session) {
  16156. tls::shutdown(session, true);
  16157. tls::free_session(session);
  16158. session = nullptr;
  16159. }
  16160. #endif
  16161. if (sock != INVALID_SOCKET) {
  16162. detail::close_socket(sock);
  16163. sock = INVALID_SOCKET;
  16164. }
  16165. }
  16166. // Universal client implementation
  16167. inline Client::Client(const std::string &scheme_host_port)
  16168. : Client(scheme_host_port, std::string(), std::string()) {}
  16169. inline Client::Client(const std::string &scheme_host_port,
  16170. const std::string &client_cert_path,
  16171. const std::string &client_key_path) {
  16172. detail::UrlComponents uc;
  16173. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  16174. auto &scheme = uc.scheme;
  16175. #ifdef CPPHTTPLIB_SSL_ENABLED
  16176. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  16177. #else
  16178. if (!scheme.empty() && scheme != "http") {
  16179. #endif
  16180. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  16181. std::string msg = "'" + scheme + "' scheme is not supported.";
  16182. throw std::invalid_argument(msg);
  16183. #endif
  16184. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  16185. return;
  16186. }
  16187. auto is_ssl = scheme == "https";
  16188. auto host = std::move(uc.host);
  16189. auto port = is_ssl ? 443 : 80;
  16190. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  16191. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  16192. return;
  16193. }
  16194. if (is_ssl) {
  16195. #ifdef CPPHTTPLIB_SSL_ENABLED
  16196. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  16197. client_key_path);
  16198. is_ssl_ = is_ssl;
  16199. #endif
  16200. } else {
  16201. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  16202. client_key_path);
  16203. }
  16204. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  16205. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  16206. // A URL, but not one this client can use, such as one with userinfo. A
  16207. // Unix socket path may have "//" further on.
  16208. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  16209. } else {
  16210. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  16211. // if port param below changes.
  16212. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  16213. client_cert_path, client_key_path);
  16214. }
  16215. }
  16216. inline Client::Client(const std::string &host, int port)
  16217. : Client(host, port, std::string(), std::string()) {}
  16218. inline Client::Client(const std::string &host, int port,
  16219. const std::string &client_cert_path,
  16220. const std::string &client_key_path)
  16221. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  16222. client_key_path)) {}
  16223. inline Client::~Client() = default;
  16224. inline bool Client::is_valid() const {
  16225. return cli_ != nullptr && cli_->is_valid();
  16226. }
  16227. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  16228. return cli_->Get(path, std::move(progress));
  16229. }
  16230. inline Result Client::Get(const std::string &path, const Headers &headers,
  16231. DownloadProgress progress) {
  16232. return cli_->Get(path, headers, std::move(progress));
  16233. }
  16234. inline Result Client::Get(const std::string &path,
  16235. ContentReceiver content_receiver,
  16236. DownloadProgress progress) {
  16237. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  16238. }
  16239. inline Result Client::Get(const std::string &path, const Headers &headers,
  16240. ContentReceiver content_receiver,
  16241. DownloadProgress progress) {
  16242. return cli_->Get(path, headers, std::move(content_receiver),
  16243. std::move(progress));
  16244. }
  16245. inline Result Client::Get(const std::string &path,
  16246. ResponseHandler response_handler,
  16247. ContentReceiver content_receiver,
  16248. DownloadProgress progress) {
  16249. return cli_->Get(path, std::move(response_handler),
  16250. std::move(content_receiver), std::move(progress));
  16251. }
  16252. inline Result Client::Get(const std::string &path, const Headers &headers,
  16253. ResponseHandler response_handler,
  16254. ContentReceiver content_receiver,
  16255. DownloadProgress progress) {
  16256. return cli_->Get(path, headers, std::move(response_handler),
  16257. std::move(content_receiver), std::move(progress));
  16258. }
  16259. inline Result Client::Get(const std::string &path, const Params &params,
  16260. DownloadProgress progress) {
  16261. return cli_->Get(path, params, std::move(progress));
  16262. }
  16263. inline Result Client::Get(const std::string &path, const Params &params,
  16264. const Headers &headers, DownloadProgress progress) {
  16265. return cli_->Get(path, params, headers, std::move(progress));
  16266. }
  16267. inline Result Client::Get(const std::string &path, const Params &params,
  16268. const Headers &headers,
  16269. ContentReceiver content_receiver,
  16270. DownloadProgress progress) {
  16271. return cli_->Get(path, params, headers, std::move(content_receiver),
  16272. std::move(progress));
  16273. }
  16274. inline Result Client::Get(const std::string &path, const Params &params,
  16275. const Headers &headers,
  16276. ResponseHandler response_handler,
  16277. ContentReceiver content_receiver,
  16278. DownloadProgress progress) {
  16279. return cli_->Get(path, params, headers, std::move(response_handler),
  16280. std::move(content_receiver), std::move(progress));
  16281. }
  16282. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  16283. inline Result Client::Head(const std::string &path, const Headers &headers) {
  16284. return cli_->Head(path, headers);
  16285. }
  16286. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  16287. inline Result Client::Post(const std::string &path, const Headers &headers) {
  16288. return cli_->Post(path, headers);
  16289. }
  16290. inline Result Client::Post(const std::string &path, const char *body,
  16291. size_t content_length,
  16292. const std::string &content_type,
  16293. UploadProgress progress) {
  16294. return cli_->Post(path, body, content_length, content_type, progress);
  16295. }
  16296. inline Result Client::Post(const std::string &path, const Headers &headers,
  16297. const char *body, size_t content_length,
  16298. const std::string &content_type,
  16299. UploadProgress progress) {
  16300. return cli_->Post(path, headers, body, content_length, content_type,
  16301. progress);
  16302. }
  16303. inline Result Client::Post(const std::string &path, const std::string &body,
  16304. const std::string &content_type,
  16305. UploadProgress progress) {
  16306. return cli_->Post(path, body, content_type, progress);
  16307. }
  16308. inline Result Client::Post(const std::string &path, const Headers &headers,
  16309. const std::string &body,
  16310. const std::string &content_type,
  16311. UploadProgress progress) {
  16312. return cli_->Post(path, headers, body, content_type, progress);
  16313. }
  16314. inline Result Client::Post(const std::string &path, size_t content_length,
  16315. ContentProvider content_provider,
  16316. const std::string &content_type,
  16317. UploadProgress progress) {
  16318. return cli_->Post(path, content_length, std::move(content_provider),
  16319. content_type, progress);
  16320. }
  16321. inline Result Client::Post(const std::string &path, size_t content_length,
  16322. ContentProvider content_provider,
  16323. const std::string &content_type,
  16324. ContentReceiver content_receiver,
  16325. UploadProgress progress) {
  16326. return cli_->Post(path, content_length, std::move(content_provider),
  16327. content_type, std::move(content_receiver), progress);
  16328. }
  16329. inline Result Client::Post(const std::string &path,
  16330. ContentProviderWithoutLength content_provider,
  16331. const std::string &content_type,
  16332. UploadProgress progress) {
  16333. return cli_->Post(path, std::move(content_provider), content_type, progress);
  16334. }
  16335. inline Result Client::Post(const std::string &path,
  16336. ContentProviderWithoutLength content_provider,
  16337. const std::string &content_type,
  16338. ContentReceiver content_receiver,
  16339. UploadProgress progress) {
  16340. return cli_->Post(path, std::move(content_provider), content_type,
  16341. std::move(content_receiver), progress);
  16342. }
  16343. inline Result Client::Post(const std::string &path, const Headers &headers,
  16344. size_t content_length,
  16345. ContentProvider content_provider,
  16346. const std::string &content_type,
  16347. UploadProgress progress) {
  16348. return cli_->Post(path, headers, content_length, std::move(content_provider),
  16349. content_type, progress);
  16350. }
  16351. inline Result Client::Post(const std::string &path, const Headers &headers,
  16352. size_t content_length,
  16353. ContentProvider content_provider,
  16354. const std::string &content_type,
  16355. ContentReceiver content_receiver,
  16356. DownloadProgress progress) {
  16357. return cli_->Post(path, headers, content_length, std::move(content_provider),
  16358. content_type, std::move(content_receiver), progress);
  16359. }
  16360. inline Result Client::Post(const std::string &path, const Headers &headers,
  16361. ContentProviderWithoutLength content_provider,
  16362. const std::string &content_type,
  16363. UploadProgress progress) {
  16364. return cli_->Post(path, headers, std::move(content_provider), content_type,
  16365. progress);
  16366. }
  16367. inline Result Client::Post(const std::string &path, const Headers &headers,
  16368. ContentProviderWithoutLength content_provider,
  16369. const std::string &content_type,
  16370. ContentReceiver content_receiver,
  16371. DownloadProgress progress) {
  16372. return cli_->Post(path, headers, std::move(content_provider), content_type,
  16373. std::move(content_receiver), progress);
  16374. }
  16375. inline Result Client::Post(const std::string &path, const Params &params) {
  16376. return cli_->Post(path, params);
  16377. }
  16378. inline Result Client::Post(const std::string &path, const Headers &headers,
  16379. const Params &params) {
  16380. return cli_->Post(path, headers, params);
  16381. }
  16382. inline Result Client::Post(const std::string &path,
  16383. const UploadFormDataItems &items,
  16384. UploadProgress progress) {
  16385. return cli_->Post(path, items, progress);
  16386. }
  16387. inline Result Client::Post(const std::string &path, const Headers &headers,
  16388. const UploadFormDataItems &items,
  16389. UploadProgress progress) {
  16390. return cli_->Post(path, headers, items, progress);
  16391. }
  16392. inline Result Client::Post(const std::string &path, const Headers &headers,
  16393. const UploadFormDataItems &items,
  16394. const std::string &boundary,
  16395. UploadProgress progress) {
  16396. return cli_->Post(path, headers, items, boundary, progress);
  16397. }
  16398. inline Result Client::Post(const std::string &path, const Headers &headers,
  16399. const UploadFormDataItems &items,
  16400. const FormDataProviderItems &provider_items,
  16401. UploadProgress progress) {
  16402. return cli_->Post(path, headers, items, provider_items, progress);
  16403. }
  16404. inline Result Client::Post(const std::string &path, const Headers &headers,
  16405. const std::string &body,
  16406. const std::string &content_type,
  16407. ContentReceiver content_receiver,
  16408. DownloadProgress progress) {
  16409. return cli_->Post(path, headers, body, content_type,
  16410. std::move(content_receiver), progress);
  16411. }
  16412. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  16413. inline Result Client::Put(const std::string &path, const Headers &headers) {
  16414. return cli_->Put(path, headers);
  16415. }
  16416. inline Result Client::Put(const std::string &path, const char *body,
  16417. size_t content_length,
  16418. const std::string &content_type,
  16419. UploadProgress progress) {
  16420. return cli_->Put(path, body, content_length, content_type, progress);
  16421. }
  16422. inline Result Client::Put(const std::string &path, const Headers &headers,
  16423. const char *body, size_t content_length,
  16424. const std::string &content_type,
  16425. UploadProgress progress) {
  16426. return cli_->Put(path, headers, body, content_length, content_type, progress);
  16427. }
  16428. inline Result Client::Put(const std::string &path, const std::string &body,
  16429. const std::string &content_type,
  16430. UploadProgress progress) {
  16431. return cli_->Put(path, body, content_type, progress);
  16432. }
  16433. inline Result Client::Put(const std::string &path, const Headers &headers,
  16434. const std::string &body,
  16435. const std::string &content_type,
  16436. UploadProgress progress) {
  16437. return cli_->Put(path, headers, body, content_type, progress);
  16438. }
  16439. inline Result Client::Put(const std::string &path, size_t content_length,
  16440. ContentProvider content_provider,
  16441. const std::string &content_type,
  16442. UploadProgress progress) {
  16443. return cli_->Put(path, content_length, std::move(content_provider),
  16444. content_type, progress);
  16445. }
  16446. inline Result Client::Put(const std::string &path, size_t content_length,
  16447. ContentProvider content_provider,
  16448. const std::string &content_type,
  16449. ContentReceiver content_receiver,
  16450. UploadProgress progress) {
  16451. return cli_->Put(path, content_length, std::move(content_provider),
  16452. content_type, std::move(content_receiver), progress);
  16453. }
  16454. inline Result Client::Put(const std::string &path,
  16455. ContentProviderWithoutLength content_provider,
  16456. const std::string &content_type,
  16457. UploadProgress progress) {
  16458. return cli_->Put(path, std::move(content_provider), content_type, progress);
  16459. }
  16460. inline Result Client::Put(const std::string &path,
  16461. ContentProviderWithoutLength content_provider,
  16462. const std::string &content_type,
  16463. ContentReceiver content_receiver,
  16464. UploadProgress progress) {
  16465. return cli_->Put(path, std::move(content_provider), content_type,
  16466. std::move(content_receiver), progress);
  16467. }
  16468. inline Result Client::Put(const std::string &path, const Headers &headers,
  16469. size_t content_length,
  16470. ContentProvider content_provider,
  16471. const std::string &content_type,
  16472. UploadProgress progress) {
  16473. return cli_->Put(path, headers, content_length, std::move(content_provider),
  16474. content_type, progress);
  16475. }
  16476. inline Result Client::Put(const std::string &path, const Headers &headers,
  16477. size_t content_length,
  16478. ContentProvider content_provider,
  16479. const std::string &content_type,
  16480. ContentReceiver content_receiver,
  16481. UploadProgress progress) {
  16482. return cli_->Put(path, headers, content_length, std::move(content_provider),
  16483. content_type, std::move(content_receiver), progress);
  16484. }
  16485. inline Result Client::Put(const std::string &path, const Headers &headers,
  16486. ContentProviderWithoutLength content_provider,
  16487. const std::string &content_type,
  16488. UploadProgress progress) {
  16489. return cli_->Put(path, headers, std::move(content_provider), content_type,
  16490. progress);
  16491. }
  16492. inline Result Client::Put(const std::string &path, const Headers &headers,
  16493. ContentProviderWithoutLength content_provider,
  16494. const std::string &content_type,
  16495. ContentReceiver content_receiver,
  16496. UploadProgress progress) {
  16497. return cli_->Put(path, headers, std::move(content_provider), content_type,
  16498. std::move(content_receiver), progress);
  16499. }
  16500. inline Result Client::Put(const std::string &path, const Params &params) {
  16501. return cli_->Put(path, params);
  16502. }
  16503. inline Result Client::Put(const std::string &path, const Headers &headers,
  16504. const Params &params) {
  16505. return cli_->Put(path, headers, params);
  16506. }
  16507. inline Result Client::Put(const std::string &path,
  16508. const UploadFormDataItems &items,
  16509. UploadProgress progress) {
  16510. return cli_->Put(path, items, progress);
  16511. }
  16512. inline Result Client::Put(const std::string &path, const Headers &headers,
  16513. const UploadFormDataItems &items,
  16514. UploadProgress progress) {
  16515. return cli_->Put(path, headers, items, progress);
  16516. }
  16517. inline Result Client::Put(const std::string &path, const Headers &headers,
  16518. const UploadFormDataItems &items,
  16519. const std::string &boundary,
  16520. UploadProgress progress) {
  16521. return cli_->Put(path, headers, items, boundary, progress);
  16522. }
  16523. inline Result Client::Put(const std::string &path, const Headers &headers,
  16524. const UploadFormDataItems &items,
  16525. const FormDataProviderItems &provider_items,
  16526. UploadProgress progress) {
  16527. return cli_->Put(path, headers, items, provider_items, progress);
  16528. }
  16529. inline Result Client::Put(const std::string &path, const Headers &headers,
  16530. const std::string &body,
  16531. const std::string &content_type,
  16532. ContentReceiver content_receiver,
  16533. DownloadProgress progress) {
  16534. return cli_->Put(path, headers, body, content_type, content_receiver,
  16535. progress);
  16536. }
  16537. inline Result Client::Patch(const std::string &path) {
  16538. return cli_->Patch(path);
  16539. }
  16540. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  16541. return cli_->Patch(path, headers);
  16542. }
  16543. inline Result Client::Patch(const std::string &path, const char *body,
  16544. size_t content_length,
  16545. const std::string &content_type,
  16546. UploadProgress progress) {
  16547. return cli_->Patch(path, body, content_length, content_type, progress);
  16548. }
  16549. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16550. const char *body, size_t content_length,
  16551. const std::string &content_type,
  16552. UploadProgress progress) {
  16553. return cli_->Patch(path, headers, body, content_length, content_type,
  16554. progress);
  16555. }
  16556. inline Result Client::Patch(const std::string &path, const std::string &body,
  16557. const std::string &content_type,
  16558. UploadProgress progress) {
  16559. return cli_->Patch(path, body, content_type, progress);
  16560. }
  16561. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16562. const std::string &body,
  16563. const std::string &content_type,
  16564. UploadProgress progress) {
  16565. return cli_->Patch(path, headers, body, content_type, progress);
  16566. }
  16567. inline Result Client::Patch(const std::string &path, size_t content_length,
  16568. ContentProvider content_provider,
  16569. const std::string &content_type,
  16570. UploadProgress progress) {
  16571. return cli_->Patch(path, content_length, std::move(content_provider),
  16572. content_type, progress);
  16573. }
  16574. inline Result Client::Patch(const std::string &path, size_t content_length,
  16575. ContentProvider content_provider,
  16576. const std::string &content_type,
  16577. ContentReceiver content_receiver,
  16578. UploadProgress progress) {
  16579. return cli_->Patch(path, content_length, std::move(content_provider),
  16580. content_type, std::move(content_receiver), progress);
  16581. }
  16582. inline Result Client::Patch(const std::string &path,
  16583. ContentProviderWithoutLength content_provider,
  16584. const std::string &content_type,
  16585. UploadProgress progress) {
  16586. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  16587. }
  16588. inline Result Client::Patch(const std::string &path,
  16589. ContentProviderWithoutLength content_provider,
  16590. const std::string &content_type,
  16591. ContentReceiver content_receiver,
  16592. UploadProgress progress) {
  16593. return cli_->Patch(path, std::move(content_provider), content_type,
  16594. std::move(content_receiver), progress);
  16595. }
  16596. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16597. size_t content_length,
  16598. ContentProvider content_provider,
  16599. const std::string &content_type,
  16600. UploadProgress progress) {
  16601. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  16602. content_type, progress);
  16603. }
  16604. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16605. size_t content_length,
  16606. ContentProvider content_provider,
  16607. const std::string &content_type,
  16608. ContentReceiver content_receiver,
  16609. UploadProgress progress) {
  16610. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  16611. content_type, std::move(content_receiver), progress);
  16612. }
  16613. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16614. ContentProviderWithoutLength content_provider,
  16615. const std::string &content_type,
  16616. UploadProgress progress) {
  16617. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16618. progress);
  16619. }
  16620. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16621. ContentProviderWithoutLength content_provider,
  16622. const std::string &content_type,
  16623. ContentReceiver content_receiver,
  16624. UploadProgress progress) {
  16625. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16626. std::move(content_receiver), progress);
  16627. }
  16628. inline Result Client::Patch(const std::string &path, const Params &params) {
  16629. return cli_->Patch(path, params);
  16630. }
  16631. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16632. const Params &params) {
  16633. return cli_->Patch(path, headers, params);
  16634. }
  16635. inline Result Client::Patch(const std::string &path,
  16636. const UploadFormDataItems &items,
  16637. UploadProgress progress) {
  16638. return cli_->Patch(path, items, progress);
  16639. }
  16640. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16641. const UploadFormDataItems &items,
  16642. UploadProgress progress) {
  16643. return cli_->Patch(path, headers, items, progress);
  16644. }
  16645. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16646. const UploadFormDataItems &items,
  16647. const std::string &boundary,
  16648. UploadProgress progress) {
  16649. return cli_->Patch(path, headers, items, boundary, progress);
  16650. }
  16651. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16652. const UploadFormDataItems &items,
  16653. const FormDataProviderItems &provider_items,
  16654. UploadProgress progress) {
  16655. return cli_->Patch(path, headers, items, provider_items, progress);
  16656. }
  16657. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16658. const std::string &body,
  16659. const std::string &content_type,
  16660. ContentReceiver content_receiver,
  16661. DownloadProgress progress) {
  16662. return cli_->Patch(path, headers, body, content_type, content_receiver,
  16663. progress);
  16664. }
  16665. inline Result Client::Delete(const std::string &path,
  16666. DownloadProgress progress) {
  16667. return cli_->Delete(path, progress);
  16668. }
  16669. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16670. DownloadProgress progress) {
  16671. return cli_->Delete(path, headers, progress);
  16672. }
  16673. inline Result Client::Delete(const std::string &path, const char *body,
  16674. size_t content_length,
  16675. const std::string &content_type,
  16676. DownloadProgress progress) {
  16677. return cli_->Delete(path, body, content_length, content_type, progress);
  16678. }
  16679. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16680. const char *body, size_t content_length,
  16681. const std::string &content_type,
  16682. DownloadProgress progress) {
  16683. return cli_->Delete(path, headers, body, content_length, content_type,
  16684. progress);
  16685. }
  16686. inline Result Client::Delete(const std::string &path, const std::string &body,
  16687. const std::string &content_type,
  16688. DownloadProgress progress) {
  16689. return cli_->Delete(path, body, content_type, progress);
  16690. }
  16691. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16692. const std::string &body,
  16693. const std::string &content_type,
  16694. DownloadProgress progress) {
  16695. return cli_->Delete(path, headers, body, content_type, progress);
  16696. }
  16697. inline Result Client::Delete(const std::string &path, const Params &params,
  16698. DownloadProgress progress) {
  16699. return cli_->Delete(path, params, progress);
  16700. }
  16701. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16702. const Params &params, DownloadProgress progress) {
  16703. return cli_->Delete(path, headers, params, progress);
  16704. }
  16705. inline Result Client::Options(const std::string &path) {
  16706. return cli_->Options(path);
  16707. }
  16708. inline Result Client::Options(const std::string &path, const Headers &headers) {
  16709. return cli_->Options(path, headers);
  16710. }
  16711. inline ClientImpl::StreamHandle
  16712. Client::open_stream(const std::string &method, const std::string &path,
  16713. const Params &params, const Headers &headers,
  16714. const std::string &body, const std::string &content_type) {
  16715. return cli_->open_stream(method, path, params, headers, body, content_type);
  16716. }
  16717. inline bool Client::send(Request &req, Response &res, Error &error) {
  16718. return cli_->send(req, res, error);
  16719. }
  16720. inline Result Client::send(const Request &req) { return cli_->send(req); }
  16721. inline void Client::stop() { cli_->stop(); }
  16722. inline std::string Client::host() const { return cli_->host(); }
  16723. inline int Client::port() const { return cli_->port(); }
  16724. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  16725. inline socket_t Client::socket() const { return cli_->socket(); }
  16726. inline void
  16727. Client::set_hostname_addr_map(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_direct_hostname_addr_map(
  16731. std::map<std::string, std::string> addr_map) {
  16732. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  16733. }
  16734. inline void Client::set_tunnel_hostname_addr_map(
  16735. std::map<std::string, std::string> addr_map) {
  16736. cli_->set_tunnel_hostname_addr_map(std::move(addr_map));
  16737. }
  16738. inline void Client::set_default_headers(Headers headers) {
  16739. cli_->set_default_headers(std::move(headers));
  16740. }
  16741. inline void Client::set_header_writer(
  16742. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  16743. cli_->set_header_writer(writer);
  16744. }
  16745. inline void Client::set_address_family(int family) {
  16746. cli_->set_address_family(family);
  16747. }
  16748. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  16749. inline void Client::set_socket_options(SocketOptions socket_options) {
  16750. cli_->set_socket_options(std::move(socket_options));
  16751. }
  16752. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  16753. cli_->set_connection_timeout(sec, usec);
  16754. }
  16755. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  16756. cli_->set_read_timeout(sec, usec);
  16757. }
  16758. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  16759. cli_->set_write_timeout(sec, usec);
  16760. }
  16761. inline void Client::set_basic_auth(const std::string &username,
  16762. const std::string &password) {
  16763. cli_->set_basic_auth(username, password);
  16764. }
  16765. inline void Client::set_bearer_token_auth(const std::string &token) {
  16766. cli_->set_bearer_token_auth(token);
  16767. }
  16768. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  16769. inline void Client::set_follow_location(bool on) {
  16770. cli_->set_follow_location(on);
  16771. }
  16772. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  16773. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  16774. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  16775. inline void Client::set_payload_max_length(size_t length) {
  16776. cli_->set_payload_max_length(length);
  16777. }
  16778. inline void Client::set_interface(const std::string &intf) {
  16779. cli_->set_interface(intf);
  16780. }
  16781. inline void Client::set_proxy(const std::string &host, int port) {
  16782. cli_->set_proxy(host, port);
  16783. }
  16784. inline void Client::set_proxy_basic_auth(const std::string &username,
  16785. const std::string &password) {
  16786. cli_->set_proxy_basic_auth(username, password);
  16787. }
  16788. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  16789. cli_->set_proxy_bearer_token_auth(token);
  16790. }
  16791. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  16792. cli_->set_no_proxy(patterns);
  16793. }
  16794. inline void Client::set_logger(Logger logger) {
  16795. cli_->set_logger(std::move(logger));
  16796. }
  16797. inline void Client::set_error_logger(ErrorLogger error_logger) {
  16798. cli_->set_error_logger(std::move(error_logger));
  16799. }
  16800. /*
  16801. * Group 6: SSL Server and Client implementation
  16802. */
  16803. #ifdef CPPHTTPLIB_SSL_ENABLED
  16804. // SSL HTTP server implementation
  16805. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  16806. const char *client_ca_cert_file_path,
  16807. const char *client_ca_cert_dir_path,
  16808. const char *private_key_password) {
  16809. using namespace tls;
  16810. ctx_ = create_server_context();
  16811. if (!ctx_) { return; }
  16812. // Load server certificate and private key
  16813. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  16814. private_key_password)) {
  16815. last_ssl_error_ = static_cast<int>(get_error());
  16816. free_context(ctx_);
  16817. ctx_ = nullptr;
  16818. return;
  16819. }
  16820. // Load client CA certificates for client authentication
  16821. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  16822. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  16823. client_ca_cert_dir_path)) {
  16824. last_ssl_error_ = static_cast<int>(get_error());
  16825. free_context(ctx_);
  16826. ctx_ = nullptr;
  16827. return;
  16828. }
  16829. // Enable client certificate verification
  16830. set_verify_client(ctx_, true);
  16831. }
  16832. }
  16833. inline SSLServer::SSLServer(const PemMemory &pem) {
  16834. using namespace tls;
  16835. ctx_ = create_server_context();
  16836. if (ctx_) {
  16837. std::string cert_buf, key_buf;
  16838. if (!set_server_cert_pem(
  16839. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16840. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16841. pem.private_key_password)) {
  16842. last_ssl_error_ = static_cast<int>(get_error());
  16843. free_context(ctx_);
  16844. ctx_ = nullptr;
  16845. } else if (pem.client_ca_pem) {
  16846. auto ca_len = pem.client_ca_pem_len ? pem.client_ca_pem_len
  16847. : strlen(pem.client_ca_pem);
  16848. if (!load_ca_pem(ctx_, pem.client_ca_pem, ca_len)) {
  16849. last_ssl_error_ = static_cast<int>(get_error());
  16850. free_context(ctx_);
  16851. ctx_ = nullptr;
  16852. } else {
  16853. set_verify_client(ctx_, true);
  16854. }
  16855. }
  16856. }
  16857. }
  16858. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  16859. using namespace tls;
  16860. ctx_ = create_server_context();
  16861. if (ctx_) {
  16862. if (!setup_callback(ctx_)) {
  16863. free_context(ctx_);
  16864. ctx_ = nullptr;
  16865. }
  16866. }
  16867. }
  16868. inline SSLServer::~SSLServer() {
  16869. if (ctx_) { tls::free_context(ctx_); }
  16870. }
  16871. inline bool SSLServer::is_valid() const {
  16872. return ctx_ != nullptr && Server::is_valid();
  16873. }
  16874. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  16875. using namespace tls;
  16876. session_t session = nullptr;
  16877. {
  16878. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16879. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  16880. session = create_session(static_cast<ctx_t>(ctx_), sock);
  16881. if (session) { handshakes_in_progress_++; }
  16882. }
  16883. if (!session) {
  16884. last_ssl_error_ = static_cast<int>(get_error());
  16885. detail::shutdown_socket(sock);
  16886. detail::close_socket(sock);
  16887. return false;
  16888. }
  16889. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  16890. bool handshake_done = false;
  16891. bool ret = false;
  16892. bool websocket_upgraded = false;
  16893. auto cleanup = detail::scope_exit([&] {
  16894. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  16895. free_session(session);
  16896. if (handshake_done) {
  16897. detail::drain_and_close_socket(sock);
  16898. } else {
  16899. detail::shutdown_socket(sock);
  16900. detail::close_socket(sock);
  16901. }
  16902. });
  16903. // Perform TLS accept handshake with timeout
  16904. TlsError tls_err;
  16905. auto accepted = false;
  16906. {
  16907. auto handshake_left = detail::scope_exit([&] {
  16908. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16909. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  16910. });
  16911. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  16912. read_timeout_usec_, &tls_err);
  16913. }
  16914. if (!accepted) {
  16915. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16916. // Map TlsError to legacy ssl_error for backward compatibility
  16917. if (tls_err.code == ErrorCode::WantRead) {
  16918. last_ssl_error_ = SSL_ERROR_WANT_READ;
  16919. } else if (tls_err.code == ErrorCode::WantWrite) {
  16920. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  16921. } else {
  16922. last_ssl_error_ = SSL_ERROR_SSL;
  16923. }
  16924. #else
  16925. last_ssl_error_ = static_cast<int>(get_error());
  16926. #endif
  16927. return false;
  16928. }
  16929. handshake_done = true;
  16930. std::string remote_addr;
  16931. int remote_port = 0;
  16932. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  16933. std::string local_addr;
  16934. int local_port = 0;
  16935. detail::get_local_ip_and_port(sock, local_addr, local_port);
  16936. ret = serve_guarded([&]() {
  16937. return detail::process_server_socket_ssl(
  16938. svr_sock_, session, sock, keep_alive_max_count_,
  16939. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  16940. write_timeout_sec_, write_timeout_usec_,
  16941. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  16942. return process_request(
  16943. strm, remote_addr, remote_port, local_addr, local_port,
  16944. close_connection, connection_closed,
  16945. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16946. });
  16947. });
  16948. return ret;
  16949. }
  16950. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16951. const char *key_pem,
  16952. const char *client_ca_pem,
  16953. const char *password) {
  16954. if (!ctx_) { return false; }
  16955. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16956. updates_pending_++;
  16957. auto se = detail::scope_exit([&] {
  16958. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16959. });
  16960. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16961. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16962. return false;
  16963. }
  16964. if (client_ca_pem) {
  16965. if (!tls::update_server_client_ca(ctx_, client_ca_pem)) { return false; }
  16966. // As in the constructors, a client CA makes client certificates required
  16967. tls::set_verify_client(ctx_, true);
  16968. }
  16969. return true;
  16970. }
  16971. // SSL HTTP client implementation
  16972. inline SSLClient::~SSLClient() {
  16973. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16974. // base function rather than the derived function once we get to the
  16975. // base class destructor, and won't free the SSL (causing a leak).
  16976. // This must happen before the context is freed below: some backends
  16977. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16978. // context, so freeing the context first leaves close_notify reading
  16979. // freed memory.
  16980. shutdown_ssl_impl(socket_, true);
  16981. if (ctx_) {
  16982. tls::free_context(ctx_);
  16983. ctx_ = nullptr;
  16984. }
  16985. }
  16986. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16987. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16988. shutdown_ssl_impl(socket, shutdown_gracefully);
  16989. }
  16990. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16991. bool shutdown_gracefully) {
  16992. if (socket.sock == INVALID_SOCKET) {
  16993. assert(socket.ssl == nullptr);
  16994. return;
  16995. }
  16996. if (socket.ssl) {
  16997. tls::shutdown(socket.ssl, shutdown_gracefully);
  16998. {
  16999. std::lock_guard<std::mutex> guard(ctx_mutex_);
  17000. tls::free_session(socket.ssl);
  17001. }
  17002. socket.ssl = nullptr;
  17003. }
  17004. assert(socket.ssl == nullptr);
  17005. }
  17006. inline bool SSLClient::process_socket(
  17007. const Socket &socket,
  17008. std::chrono::time_point<std::chrono::steady_clock> start_time,
  17009. std::function<bool(Stream &strm)> callback) {
  17010. assert(socket.ssl);
  17011. return detail::process_client_socket_ssl(
  17012. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  17013. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  17014. [&](detail::SSLSocketStream &strm) {
  17015. auto ret = callback(strm);
  17016. // A request that failed after the handshake reports Error::Read or
  17017. // Error::Write; keep the TLS error behind it, such as a fatal alert
  17018. // from the server, for Result::ssl_error() and ssl_backend_error()
  17019. const auto &tls_error = strm.tls_error();
  17020. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  17021. last_ssl_error_ = static_cast<int>(tls_error.code);
  17022. last_backend_error_ = tls_error.backend_code;
  17023. }
  17024. return ret;
  17025. });
  17026. }
  17027. inline bool SSLClient::is_ssl() const { return true; }
  17028. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  17029. if (!is_valid()) {
  17030. error = Error::SSLConnection;
  17031. return false;
  17032. }
  17033. return ClientImpl::create_and_connect_socket(socket, error);
  17034. }
  17035. inline bool SSLClient::setup_proxy_connection(
  17036. Socket &socket,
  17037. std::chrono::time_point<std::chrono::steady_clock> start_time,
  17038. Response &res, bool &success, Error &error) {
  17039. if (!is_proxy_enabled_for_host(host_)) { return true; }
  17040. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  17041. return false;
  17042. }
  17043. if (!initialize_ssl(socket, error)) {
  17044. shutdown_socket(socket);
  17045. close_socket(socket);
  17046. success = false;
  17047. return false;
  17048. }
  17049. return true;
  17050. }
  17051. // Assumes that socket is a connection being opened, which no other thread uses
  17052. inline bool SSLClient::connect_with_proxy(
  17053. Socket &socket,
  17054. std::chrono::time_point<std::chrono::steady_clock> start_time,
  17055. Response &res, bool &success, Error &error) {
  17056. success = true;
  17057. auto connect_target =
  17058. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  17059. auto retargeted = connect_target !=
  17060. detail::make_host_and_port_string_always_port(host_, port_);
  17061. Response proxy_res;
  17062. if (!detail::process_client_socket(
  17063. socket.sock, read_timeout_sec_, read_timeout_usec_,
  17064. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  17065. start_time, [&](Stream &strm) {
  17066. strm.set_read_interrupt(stop_interrupt());
  17067. Request req2;
  17068. req2.method = "CONNECT";
  17069. req2.path = connect_target;
  17070. if (retargeted) { req2.set_header("Host", connect_target); }
  17071. if (max_timeout_msec_ > 0) {
  17072. req2.start_time_ = std::chrono::steady_clock::now();
  17073. }
  17074. return process_request(strm, req2, proxy_res, false, error);
  17075. })) {
  17076. // Thread-safe to close everything because we are assuming there are no
  17077. // requests in flight
  17078. shutdown_ssl(socket, true);
  17079. shutdown_socket(socket);
  17080. close_socket(socket);
  17081. success = false;
  17082. return false;
  17083. }
  17084. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  17085. if (!proxy_digest_auth_username_.empty() &&
  17086. !proxy_digest_auth_password_.empty()) {
  17087. std::map<std::string, std::string> auth;
  17088. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  17089. // Close the current socket and create a new one for the authenticated
  17090. // request
  17091. shutdown_ssl(socket, true);
  17092. shutdown_socket(socket);
  17093. close_socket(socket);
  17094. // Create a new socket for the authenticated CONNECT request
  17095. if (!ensure_socket_connection(socket, error)) {
  17096. success = false;
  17097. return false;
  17098. }
  17099. proxy_res = Response();
  17100. if (!detail::process_client_socket(
  17101. socket.sock, read_timeout_sec_, read_timeout_usec_,
  17102. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  17103. start_time, [&](Stream &strm) {
  17104. strm.set_read_interrupt(stop_interrupt());
  17105. Request req3;
  17106. req3.method = "CONNECT";
  17107. req3.path = connect_target;
  17108. if (retargeted) { req3.set_header("Host", connect_target); }
  17109. req3.headers.insert(detail::make_digest_authentication_header(
  17110. req3, make_request_target(req3), auth, 1,
  17111. detail::random_string(10), proxy_digest_auth_username_,
  17112. proxy_digest_auth_password_, true));
  17113. if (max_timeout_msec_ > 0) {
  17114. req3.start_time_ = std::chrono::steady_clock::now();
  17115. }
  17116. return process_request(strm, req3, proxy_res, false, error);
  17117. })) {
  17118. // Thread-safe to close everything because we are assuming there are
  17119. // no requests in flight
  17120. shutdown_ssl(socket, true);
  17121. shutdown_socket(socket);
  17122. close_socket(socket);
  17123. success = false;
  17124. return false;
  17125. }
  17126. }
  17127. }
  17128. }
  17129. // If status code is not 200, proxy request is failed.
  17130. // Set error to ProxyConnection. A 407 is returned as the response of the
  17131. // request, so the caller sees the proxy asks for credentials; any other
  17132. // status would read as the answer of the origin, which it never reached.
  17133. if (proxy_res.status != StatusCode::OK_200) {
  17134. error = Error::ProxyConnection;
  17135. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  17136. res = std::move(proxy_res);
  17137. } else {
  17138. success = false;
  17139. }
  17140. // Thread-safe to close everything because we are assuming there are
  17141. // no requests in flight
  17142. shutdown_ssl(socket, true);
  17143. shutdown_socket(socket);
  17144. close_socket(socket);
  17145. return false;
  17146. }
  17147. return true;
  17148. }
  17149. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  17150. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  17151. if (is_proxy_enabled_for_host(host_)) { return true; }
  17152. if (!initialize_ssl(socket, error)) {
  17153. shutdown_socket(socket);
  17154. close_socket(socket);
  17155. return false;
  17156. }
  17157. return true;
  17158. }
  17159. // SSL HTTP client implementation
  17160. inline SSLClient::SSLClient(const std::string &host)
  17161. : SSLClient(host, 443, std::string(), std::string()) {}
  17162. inline SSLClient::SSLClient(const std::string &host, int port)
  17163. : SSLClient(host, port, std::string(), std::string()) {}
  17164. inline void SSLClient::init_ctx() {
  17165. ctx_ = tls::create_client_context();
  17166. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  17167. }
  17168. inline void SSLClient::reset_ctx_on_error() {
  17169. last_backend_error_ = tls::get_error();
  17170. tls::free_context(ctx_);
  17171. ctx_ = nullptr;
  17172. }
  17173. inline SSLClient::SSLClient(const std::string &host, int port,
  17174. const std::string &client_cert_path,
  17175. const std::string &client_key_path,
  17176. const std::string &private_key_password)
  17177. : ClientImpl(host, port, client_cert_path, client_key_path) {
  17178. init_ctx();
  17179. if (!ctx_) { return; }
  17180. if (!client_cert_path.empty() && !client_key_path.empty()) {
  17181. const char *password =
  17182. private_key_password.empty() ? nullptr : private_key_password.c_str();
  17183. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  17184. client_key_path.c_str(), password)) {
  17185. reset_ctx_on_error();
  17186. }
  17187. }
  17188. }
  17189. inline SSLClient::SSLClient(const std::string &host, int port,
  17190. const PemMemory &pem)
  17191. : ClientImpl(host, port) {
  17192. init_ctx();
  17193. if (!ctx_) { return; }
  17194. if (pem.cert_pem && pem.key_pem) {
  17195. std::string cert_buf, key_buf;
  17196. if (!tls::set_client_cert_pem(
  17197. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  17198. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  17199. pem.private_key_password)) {
  17200. reset_ctx_on_error();
  17201. }
  17202. }
  17203. }
  17204. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  17205. if (ca_cert_store && ctx_) {
  17206. // set_ca_store takes ownership of ca_cert_store
  17207. tls::set_ca_store(ctx_, ca_cert_store);
  17208. ca_cert_store_set_ = true;
  17209. } else if (ca_cert_store) {
  17210. tls::free_ca_store(ca_cert_store);
  17211. }
  17212. custom_ca_loaded_ = true;
  17213. tls_settings_changed();
  17214. }
  17215. inline void
  17216. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  17217. if (!ctx_) { return; }
  17218. server_certificate_verifier_ = verifier;
  17219. {
  17220. // Under the lock that creating a session from ctx_ takes
  17221. std::lock_guard<std::mutex> guard(ctx_mutex_);
  17222. tls::set_verify_callback(ctx_, std::move(verifier));
  17223. }
  17224. tls_settings_changed();
  17225. }
  17226. inline void SSLClient::set_session_verifier(
  17227. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  17228. session_verifier_ = std::move(verifier);
  17229. tls_settings_changed();
  17230. }
  17231. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  17232. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  17233. if (enable_windows_cert_verification_ == enabled) { return; }
  17234. enable_windows_cert_verification_ = enabled;
  17235. tls_settings_changed();
  17236. }
  17237. #endif
  17238. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  17239. std::size_t size) {
  17240. if (ctx_ && ca_cert && size > 0) {
  17241. // Every PEM loaded, for redirect transfer
  17242. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  17243. ca_cert_pem_ += '\n';
  17244. }
  17245. ca_cert_pem_.append(ca_cert, size);
  17246. tls::load_ca_pem(ctx_, ca_cert, size);
  17247. }
  17248. custom_ca_loaded_ = true;
  17249. tls_settings_changed();
  17250. }
  17251. inline bool SSLClient::load_certs() {
  17252. auto ret = true;
  17253. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  17254. // one client is shared across concurrent requests here.
  17255. std::call_once(initialize_cert_, [&]() {
  17256. std::lock_guard<std::mutex> guard(ctx_mutex_);
  17257. ret = detail::load_client_ca_config(ctx_, ca_cert_file_path_,
  17258. ca_cert_dir_path_, custom_ca_loaded_,
  17259. system_ca_mode_, last_backend_error_);
  17260. });
  17261. return ret;
  17262. }
  17263. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  17264. // Load CA certificates if server verification is enabled
  17265. if (server_certificate_verification_) {
  17266. if (!load_certs()) {
  17267. error = Error::SSLLoadingCerts;
  17268. return false;
  17269. }
  17270. }
  17271. detail::ClientTlsSessionOptions options;
  17272. options.server_hostname_verification = server_hostname_verification_;
  17273. options.session_verifier = session_verifier_;
  17274. options.interrupted = stop_interrupt();
  17275. options.ctx_mutex = &ctx_mutex_;
  17276. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  17277. options.windows_cert_verification = detail::use_windows_cert_verification(
  17278. enable_windows_cert_verification_, ca_cert_file_path_, ca_cert_dir_path_,
  17279. custom_ca_loaded_, system_ca_mode_);
  17280. // Only a verifier set through set_server_certificate_verifier() is seen
  17281. // here, not one installed with tls::set_verify_callback() directly.
  17282. options.server_certificate_verifier_set =
  17283. static_cast<bool>(server_certificate_verifier_);
  17284. #endif
  17285. tls::session_t session = nullptr;
  17286. // Use scope_exit to ensure session is freed on error paths
  17287. bool success = false;
  17288. auto session_guard = detail::scope_exit([&] {
  17289. if (!success) { tls::free_session(session); }
  17290. });
  17291. detail::ClientTlsSessionError tls_error;
  17292. if (!detail::setup_client_tls_session(
  17293. host_, ctx_, session, socket.sock, server_certificate_verification_,
  17294. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  17295. options)) {
  17296. error = tls_error.error;
  17297. last_ssl_error_ = tls_error.ssl_error;
  17298. last_backend_error_ = tls_error.backend_error;
  17299. return false;
  17300. }
  17301. success = true;
  17302. socket.ssl = session;
  17303. return true;
  17304. }
  17305. inline void Client::set_digest_auth(const std::string &username,
  17306. const std::string &password) {
  17307. cli_->set_digest_auth(username, password);
  17308. }
  17309. inline void Client::set_proxy_digest_auth(const std::string &username,
  17310. const std::string &password) {
  17311. cli_->set_proxy_digest_auth(username, password);
  17312. }
  17313. inline void Client::enable_server_certificate_verification(bool enabled) {
  17314. cli_->enable_server_certificate_verification(enabled);
  17315. }
  17316. inline void Client::enable_server_hostname_verification(bool enabled) {
  17317. cli_->enable_server_hostname_verification(enabled);
  17318. }
  17319. inline void Client::enable_system_ca(bool enabled) {
  17320. cli_->enable_system_ca(enabled);
  17321. }
  17322. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  17323. inline void Client::enable_windows_certificate_verification(bool enabled) {
  17324. if (is_ssl_) {
  17325. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  17326. enabled);
  17327. }
  17328. }
  17329. #endif
  17330. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  17331. const std::string &ca_cert_dir_path) {
  17332. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  17333. }
  17334. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  17335. if (is_ssl_) {
  17336. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  17337. } else if (ca_cert_store) {
  17338. tls::free_ca_store(ca_cert_store);
  17339. }
  17340. }
  17341. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  17342. if (is_ssl_) {
  17343. // Use the PEM-based path so the CA data is retained for redirect transfer
  17344. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  17345. }
  17346. }
  17347. inline void
  17348. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  17349. if (is_ssl_) {
  17350. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  17351. std::move(verifier));
  17352. }
  17353. }
  17354. inline void Client::set_session_verifier(
  17355. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  17356. if (is_ssl_) {
  17357. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  17358. }
  17359. }
  17360. inline tls::ctx_t Client::tls_context() const {
  17361. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  17362. return nullptr;
  17363. }
  17364. #endif // CPPHTTPLIB_SSL_ENABLED
  17365. /*
  17366. * Group 7: TLS abstraction layer - Common API
  17367. */
  17368. #ifdef CPPHTTPLIB_SSL_ENABLED
  17369. namespace tls {
  17370. // Helper for PeerCert construction
  17371. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  17372. return PeerCert(get_peer_cert(session));
  17373. }
  17374. namespace impl {
  17375. // set_verify_callback() can replace a callback while handshakes on other
  17376. // threads run it, so they share it, and take their reference under this lock.
  17377. inline std::mutex &verify_callback_mutex() {
  17378. static std::mutex mutex;
  17379. return mutex;
  17380. }
  17381. // The TLS libraries are C, so an exception from a verify callback must not
  17382. // unwind through them. It rejects the certificate instead.
  17383. inline bool run_verify_callback(const VerifyCallback &callback,
  17384. const VerifyContext &ctx) {
  17385. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  17386. return callback(ctx);
  17387. #else
  17388. try {
  17389. return callback(ctx);
  17390. } catch (...) { return false; }
  17391. #endif
  17392. }
  17393. // Check if a string is an IPv4 address
  17394. inline bool is_ipv4_address(const std::string &str) {
  17395. int dots = 0;
  17396. for (char c : str) {
  17397. if (c == '.') {
  17398. dots++;
  17399. } else if (!detail::is_ascii_digit(c)) {
  17400. return false;
  17401. }
  17402. }
  17403. return dots == 3;
  17404. }
  17405. // Parse IPv4 address string to bytes
  17406. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  17407. const char *p = str.c_str();
  17408. for (int i = 0; i < 4; i++) {
  17409. if (i > 0) {
  17410. if (*p != '.') { return false; }
  17411. p++;
  17412. }
  17413. int val = 0;
  17414. int digits = 0;
  17415. while (detail::is_ascii_digit(*p)) {
  17416. val = val * 10 + (*p - '0');
  17417. if (val > 255) { return false; }
  17418. p++;
  17419. digits++;
  17420. }
  17421. if (digits == 0) { return false; }
  17422. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  17423. if (digits > 1 && *(p - digits) == '0') { return false; }
  17424. out[i] = static_cast<unsigned char>(val);
  17425. }
  17426. return *p == '\0';
  17427. }
  17428. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  17429. // `out` must have room for at least 16 bytes. Returns the address length
  17430. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  17431. // literal. Used to match a host against iPAddress SANs the same way the
  17432. // OpenSSL backend does via X509_check_ip.
  17433. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  17434. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  17435. struct in6_addr addr6 = {};
  17436. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  17437. memcpy(out, &addr6, 16);
  17438. return 16;
  17439. }
  17440. return 0;
  17441. }
  17442. #ifdef _WIN32
  17443. // Enumerate Windows system certificates and call callback with DER data
  17444. template <typename Callback>
  17445. inline bool enumerate_windows_system_certs(Callback cb) {
  17446. bool loaded = false;
  17447. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17448. for (auto store_name : store_names) {
  17449. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  17450. if (hStore) {
  17451. PCCERT_CONTEXT pContext = nullptr;
  17452. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17453. nullptr) {
  17454. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  17455. loaded = true;
  17456. }
  17457. }
  17458. CertCloseStore(hStore, 0);
  17459. }
  17460. }
  17461. return loaded;
  17462. }
  17463. #endif
  17464. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17465. // The trust a certificate's Trust Settings give it for SSL server
  17466. // verification (SecTrustSettings.h). An empty array trusts it as a root.
  17467. // Otherwise the first usage-constraints dictionary that applies decides: one
  17468. // naming a policy other than SSL, a host name or an application does not
  17469. // apply, and a result left out means TrustRoot. Keychain Access writes "Never
  17470. // Trust" as kSecTrustSettingsResultDeny.
  17471. inline SecTrustSettingsResult
  17472. macos_ssl_trust_settings_result(CFArrayRef trust_settings) {
  17473. auto count = CFArrayGetCount(trust_settings);
  17474. if (count == 0) { return kSecTrustSettingsResultTrustRoot; }
  17475. for (CFIndex i = 0; i < count; i++) {
  17476. auto value = CFArrayGetValueAtIndex(trust_settings, i);
  17477. if (!value || CFGetTypeID(value) != CFDictionaryGetTypeID()) { continue; }
  17478. auto constraint = static_cast<CFDictionaryRef>(value);
  17479. auto policy_value =
  17480. CFDictionaryGetValue(constraint, kSecTrustSettingsPolicy);
  17481. if (policy_value) {
  17482. auto policy = static_cast<SecPolicyRef>(const_cast<void *>(policy_value));
  17483. auto is_ssl = false;
  17484. if (auto properties = SecPolicyCopyProperties(policy)) {
  17485. auto oid = CFDictionaryGetValue(properties, kSecPolicyOid);
  17486. is_ssl = oid && CFEqual(oid, kSecPolicyAppleSSL);
  17487. CFRelease(properties);
  17488. }
  17489. if (!is_ssl) { continue; }
  17490. }
  17491. if (CFDictionaryContainsKey(constraint, kSecTrustSettingsPolicyString) ||
  17492. CFDictionaryContainsKey(constraint, kSecTrustSettingsApplication)) {
  17493. continue;
  17494. }
  17495. auto result = kSecTrustSettingsResultTrustRoot;
  17496. auto number = static_cast<CFNumberRef>(
  17497. CFDictionaryGetValue(constraint, kSecTrustSettingsResult));
  17498. if (number) {
  17499. SInt32 number_value = 0;
  17500. if (!CFNumberGetValue(number, kCFNumberSInt32Type, &number_value)) {
  17501. continue;
  17502. }
  17503. result = static_cast<SecTrustSettingsResult>(number_value);
  17504. }
  17505. if (result == kSecTrustSettingsResultTrustRoot ||
  17506. result == kSecTrustSettingsResultTrustAsRoot ||
  17507. result == kSecTrustSettingsResultDeny) {
  17508. return result;
  17509. }
  17510. }
  17511. return kSecTrustSettingsResultUnspecified;
  17512. }
  17513. // Enumerate the macOS Keychain certificates trusted for SSL and call callback
  17514. // with DER data. A certificate with Trust Settings is not trusted just by
  17515. // having them: the settings say whether it is, and a per-user setting
  17516. // overrides the admin domain's, which overrides the system domain's (whose
  17517. // roots are all trusted). So a system root the user set to "Never Trust" is
  17518. // left out, as is one trusted only for S/MIME or code signing.
  17519. template <typename Callback>
  17520. inline bool enumerate_macos_keychain_certs(Callback cb) {
  17521. const SecTrustSettingsDomain domains[] = {
  17522. kSecTrustSettingsDomainUser,
  17523. kSecTrustSettingsDomainAdmin,
  17524. kSecTrustSettingsDomainSystem,
  17525. };
  17526. std::set<std::string> decided;
  17527. std::vector<std::string> trusted;
  17528. for (auto domain : domains) {
  17529. CFArrayRef certs = nullptr;
  17530. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  17531. if (status != errSecSuccess || !certs) {
  17532. if (certs) CFRelease(certs);
  17533. continue;
  17534. }
  17535. CFIndex count = CFArrayGetCount(certs);
  17536. for (CFIndex i = 0; i < count; i++) {
  17537. SecCertificateRef cert =
  17538. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  17539. CFDataRef data = SecCertificateCopyData(cert);
  17540. if (!data) { continue; }
  17541. std::string der(reinterpret_cast<const char *>(CFDataGetBytePtr(data)),
  17542. static_cast<size_t>(CFDataGetLength(data)));
  17543. CFRelease(data);
  17544. // Decided by a domain that overrides this one
  17545. if (decided.find(der) != decided.end()) { continue; }
  17546. auto result = kSecTrustSettingsResultTrustRoot;
  17547. if (domain != kSecTrustSettingsDomainSystem) {
  17548. result = kSecTrustSettingsResultUnspecified;
  17549. CFArrayRef trust_settings = nullptr;
  17550. if (SecTrustSettingsCopyTrustSettings(cert, domain, &trust_settings) ==
  17551. errSecSuccess &&
  17552. trust_settings) {
  17553. result = macos_ssl_trust_settings_result(trust_settings);
  17554. }
  17555. if (trust_settings) CFRelease(trust_settings);
  17556. }
  17557. // Neither trusted nor distrusted here; a domain below may decide
  17558. if (result == kSecTrustSettingsResultUnspecified) { continue; }
  17559. decided.insert(der);
  17560. if (result == kSecTrustSettingsResultTrustRoot ||
  17561. result == kSecTrustSettingsResultTrustAsRoot) {
  17562. trusted.push_back(std::move(der));
  17563. }
  17564. }
  17565. CFRelease(certs);
  17566. }
  17567. bool loaded = false;
  17568. for (const auto &der : trusted) {
  17569. if (cb(reinterpret_cast<const unsigned char *>(der.data()), der.size())) {
  17570. loaded = true;
  17571. }
  17572. }
  17573. return loaded;
  17574. }
  17575. #endif
  17576. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  17577. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  17578. // Common CA certificate file paths on Linux/Unix
  17579. inline const char **system_ca_paths() {
  17580. static const char *paths[] = {
  17581. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  17582. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  17583. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  17584. "/etc/pki/tls/cacert.pem", // OpenELEC
  17585. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  17586. nullptr};
  17587. return paths;
  17588. }
  17589. // Common CA certificate directory paths on Linux/Unix
  17590. inline const char **system_ca_dirs() {
  17591. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  17592. "/etc/pki/tls/certs", // RHEL/CentOS
  17593. "/usr/share/ca-certificates", // Other
  17594. nullptr};
  17595. return dirs;
  17596. }
  17597. #endif
  17598. } // namespace impl
  17599. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  17600. const char *ca_dir) {
  17601. if (!ctx) { return false; }
  17602. bool success = true;
  17603. if (ca_file && *ca_file) {
  17604. if (!load_ca_file(ctx, ca_file)) { success = false; }
  17605. }
  17606. if (ca_dir && *ca_dir) {
  17607. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  17608. }
  17609. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17610. // Set CA list for client certificate request (CertificateRequest message)
  17611. if (ca_file && *ca_file) {
  17612. auto list = SSL_load_client_CA_file(ca_file);
  17613. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  17614. }
  17615. #endif
  17616. return success;
  17617. }
  17618. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17619. const char *password) {
  17620. return set_client_cert_pem(ctx, cert, key, password);
  17621. }
  17622. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  17623. const char *key_path, const char *password) {
  17624. return set_client_cert_file(ctx, cert_path, key_path, password);
  17625. }
  17626. // PeerCert implementation
  17627. inline PeerCert::PeerCert() = default;
  17628. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  17629. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  17630. other.cert_ = nullptr;
  17631. }
  17632. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  17633. if (this != &other) {
  17634. if (cert_) { free_cert(cert_); }
  17635. cert_ = other.cert_;
  17636. other.cert_ = nullptr;
  17637. }
  17638. return *this;
  17639. }
  17640. inline PeerCert::~PeerCert() {
  17641. if (cert_) { free_cert(cert_); }
  17642. }
  17643. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  17644. inline std::string PeerCert::subject_cn() const {
  17645. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  17646. }
  17647. inline std::string PeerCert::issuer_name() const {
  17648. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  17649. }
  17650. inline bool PeerCert::check_hostname(const char *hostname) const {
  17651. return cert_ ? verify_hostname(cert_, hostname) : false;
  17652. }
  17653. inline std::vector<SanEntry> PeerCert::sans() const {
  17654. std::vector<SanEntry> result;
  17655. if (cert_) { get_cert_sans(cert_, result); }
  17656. return result;
  17657. }
  17658. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  17659. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  17660. }
  17661. inline std::string PeerCert::serial() const {
  17662. return cert_ ? get_cert_serial(cert_) : std::string();
  17663. }
  17664. // VerifyContext method implementations
  17665. inline std::string VerifyContext::subject_cn() const {
  17666. return cert ? get_cert_subject_cn(cert) : std::string();
  17667. }
  17668. inline std::string VerifyContext::issuer_name() const {
  17669. return cert ? get_cert_issuer_name(cert) : std::string();
  17670. }
  17671. inline bool VerifyContext::check_hostname(const char *hostname) const {
  17672. return cert ? verify_hostname(cert, hostname) : false;
  17673. }
  17674. inline std::vector<SanEntry> VerifyContext::sans() const {
  17675. std::vector<SanEntry> result;
  17676. if (cert) { get_cert_sans(cert, result); }
  17677. return result;
  17678. }
  17679. inline bool VerifyContext::validity(time_t &not_before,
  17680. time_t &not_after) const {
  17681. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  17682. }
  17683. inline std::string VerifyContext::serial() const {
  17684. return cert ? get_cert_serial(cert) : std::string();
  17685. }
  17686. // TlsError static method implementation
  17687. inline std::string TlsError::verify_error_to_string(long error_code) {
  17688. return verify_error_string(error_code);
  17689. }
  17690. } // namespace tls
  17691. // Request::peer_cert() implementation
  17692. inline tls::PeerCert Request::peer_cert() const {
  17693. return tls::get_peer_cert_from_session(ssl);
  17694. }
  17695. // Request::sni() implementation
  17696. inline std::string Request::sni() const {
  17697. if (!ssl) { return std::string(); }
  17698. const char *s = tls::get_sni(ssl);
  17699. return s ? std::string(s) : std::string();
  17700. }
  17701. #endif // CPPHTTPLIB_SSL_ENABLED
  17702. /*
  17703. * Group 8: TLS abstraction layer - OpenSSL backend
  17704. */
  17705. /*
  17706. * OpenSSL Backend Implementation
  17707. */
  17708. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17709. namespace tls {
  17710. namespace impl {
  17711. // Helper to map OpenSSL SSL_get_error to ErrorCode
  17712. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  17713. switch (ssl_error) {
  17714. case SSL_ERROR_NONE: return ErrorCode::Success;
  17715. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  17716. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  17717. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  17718. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  17719. case SSL_ERROR_SSL:
  17720. default: return ErrorCode::Fatal;
  17721. }
  17722. }
  17723. // Fills in a failed SSL_connect(). One that the server certificate's
  17724. // verification stopped reports the verify result, as the other backends and
  17725. // a check after the handshake do.
  17726. inline void fill_connect_error(SSL *ssl, int ret, TlsError &err) {
  17727. auto ssl_err = SSL_get_error(ssl, ret);
  17728. auto error = ERR_get_error();
  17729. err.code = map_ssl_error(ssl_err, err.sys_errno);
  17730. err.backend_code = error;
  17731. if (ssl_err != SSL_ERROR_SSL || ERR_GET_LIB(error) != ERR_LIB_SSL ||
  17732. ERR_GET_REASON(error) != SSL_R_CERTIFICATE_VERIFY_FAILED) {
  17733. return;
  17734. }
  17735. // A certificate only a verify callback turned down carries no verdict of
  17736. // its own, and fails as any other handshake does
  17737. auto verify_result = SSL_get_verify_result(ssl);
  17738. if (verify_result == X509_V_OK || verify_result == X509_V_ERR_UNSPECIFIED) {
  17739. return;
  17740. }
  17741. err.code = verify_result == X509_V_ERR_HOSTNAME_MISMATCH
  17742. ? ErrorCode::HostnameMismatch
  17743. : ErrorCode::CertVerifyFailed;
  17744. err.backend_code = static_cast<uint64_t>(verify_result);
  17745. }
  17746. // Helper: Create client CA list from PEM string
  17747. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  17748. // Caller takes ownership of returned list
  17749. inline STACK_OF(X509_NAME) *
  17750. create_client_ca_list_from_pem(const char *ca_pem) {
  17751. if (!ca_pem) { return nullptr; }
  17752. auto ca_list = sk_X509_NAME_new_null();
  17753. if (!ca_list) { return nullptr; }
  17754. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  17755. if (!bio) {
  17756. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  17757. return nullptr;
  17758. }
  17759. X509 *cert = nullptr;
  17760. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17761. nullptr) {
  17762. const X509_NAME *name = X509_get_subject_name(cert);
  17763. if (name) {
  17764. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  17765. }
  17766. X509_free(cert);
  17767. }
  17768. BIO_free(bio);
  17769. return ca_list;
  17770. }
  17771. inline void free_verify_callback(void * /*parent*/, void *ptr,
  17772. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  17773. long /*argl*/, void * /*argp*/) {
  17774. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  17775. }
  17776. // The SSL_CTX owns its verify callback, so each client or server sees only
  17777. // its own, on whichever thread runs the handshake.
  17778. inline int verify_callback_index() {
  17779. static const auto index = SSL_CTX_get_ex_new_index(
  17780. 0, nullptr, nullptr, nullptr, free_verify_callback);
  17781. return index;
  17782. }
  17783. // OpenSSL verify callback wrapper
  17784. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  17785. // Get SSL object from X509_STORE_CTX
  17786. auto ssl = static_cast<SSL *>(
  17787. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  17788. if (!ssl) { return preverify_ok; }
  17789. std::shared_ptr<VerifyCallback> callback;
  17790. {
  17791. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  17792. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  17793. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  17794. if (stored) { callback = *stored; }
  17795. }
  17796. if (!callback) { return preverify_ok; }
  17797. // Get current certificate and depth
  17798. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  17799. int depth = X509_STORE_CTX_get_error_depth(ctx);
  17800. int error = X509_STORE_CTX_get_error(ctx);
  17801. // Build context
  17802. VerifyContext verify_ctx;
  17803. verify_ctx.session = static_cast<session_t>(ssl);
  17804. verify_ctx.cert = static_cast<cert_t>(cert);
  17805. verify_ctx.depth = depth;
  17806. verify_ctx.preverify_ok = (preverify_ok != 0);
  17807. verify_ctx.error_code = error;
  17808. verify_ctx.error_string =
  17809. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  17810. auto accepted = run_verify_callback(*callback, verify_ctx);
  17811. // A client verifying the server during the handshake, which is what
  17812. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  17813. if (!SSL_is_server(ssl) &&
  17814. (SSL_get_verify_mode(ssl) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  17815. accepted = accepted && preverify_ok;
  17816. }
  17817. return accepted ? 1 : 0;
  17818. }
  17819. // Sets the verify mode from whether the peer's certificate is required and
  17820. // whether a verify callback is set.
  17821. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  17822. auto has_callback =
  17823. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  17824. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  17825. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  17826. SSL_CTX_set_verify(ssl_ctx, mode,
  17827. has_callback ? openssl_verify_callback : nullptr);
  17828. }
  17829. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  17830. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  17831. // that must be released with release_store_objects
  17832. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  17833. OPENSSL_VERSION_NUMBER >= 0x30300000L
  17834. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17835. #endif
  17836. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  17837. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17838. return X509_STORE_get1_objects(store);
  17839. #else
  17840. return X509_STORE_get0_objects(store);
  17841. #endif
  17842. }
  17843. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  17844. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17845. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  17846. #else
  17847. (void)objs; // get0 variant returns an internal pointer; nothing to free
  17848. #endif
  17849. }
  17850. } // namespace impl
  17851. inline ctx_t create_client_context() {
  17852. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  17853. if (ctx) {
  17854. // Disable auto-retry to properly handle non-blocking I/O
  17855. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  17856. // Set minimum TLS version
  17857. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17858. }
  17859. return static_cast<ctx_t>(ctx);
  17860. }
  17861. inline void free_context(ctx_t ctx) {
  17862. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  17863. }
  17864. inline bool set_min_version(ctx_t ctx, Version version) {
  17865. if (!ctx) return false;
  17866. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  17867. static_cast<uint16_t>(version)) == 1;
  17868. }
  17869. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17870. if (!ctx || !pem || len == 0) return false;
  17871. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17872. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17873. if (!store) return false;
  17874. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  17875. if (!bio) return false;
  17876. bool ok = true;
  17877. X509 *cert = nullptr;
  17878. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17879. nullptr) {
  17880. if (X509_STORE_add_cert(store, cert) != 1) {
  17881. // Ignore duplicate errors
  17882. auto err = ERR_peek_last_error();
  17883. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  17884. ok = false;
  17885. }
  17886. }
  17887. X509_free(cert);
  17888. if (!ok) break;
  17889. }
  17890. BIO_free(bio);
  17891. // Clear any "no more certificates" errors
  17892. ERR_clear_error();
  17893. return ok;
  17894. }
  17895. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17896. if (!ctx || !file_path) return false;
  17897. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  17898. nullptr) == 1;
  17899. }
  17900. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17901. if (!ctx || !dir_path) return false;
  17902. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  17903. dir_path) == 1;
  17904. }
  17905. inline bool load_system_certs(ctx_t ctx) {
  17906. if (!ctx) return false;
  17907. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17908. #ifdef _WIN32
  17909. // Windows: Load from system certificate store (ROOT and CA)
  17910. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17911. if (!store) return false;
  17912. bool loaded_any = false;
  17913. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17914. for (auto store_name : store_names) {
  17915. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  17916. if (!hStore) continue;
  17917. PCCERT_CONTEXT pContext = nullptr;
  17918. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17919. nullptr) {
  17920. const unsigned char *data = pContext->pbCertEncoded;
  17921. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  17922. if (x509) {
  17923. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17924. X509_free(x509);
  17925. }
  17926. }
  17927. CertCloseStore(hStore, 0);
  17928. }
  17929. return loaded_any;
  17930. #elif defined(__APPLE__)
  17931. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17932. // macOS: Load from Keychain
  17933. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17934. if (!store) return false;
  17935. auto loaded_any = impl::enumerate_macos_keychain_certs(
  17936. [&](const unsigned char *data, size_t len) {
  17937. auto x509 = d2i_X509(nullptr, &data, static_cast<long>(len));
  17938. if (!x509) { return false; }
  17939. auto added = X509_STORE_add_cert(store, x509) == 1;
  17940. X509_free(x509);
  17941. return added;
  17942. });
  17943. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17944. #else
  17945. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17946. #endif
  17947. #else
  17948. // Other Unix: use default verify paths
  17949. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17950. #endif
  17951. }
  17952. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17953. const char *password) {
  17954. if (!ctx || !cert || !key) return false;
  17955. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17956. // Load certificate
  17957. auto cert_bio = BIO_new_mem_buf(cert, -1);
  17958. if (!cert_bio) return false;
  17959. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17960. BIO_free(cert_bio);
  17961. if (!x509) return false;
  17962. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  17963. X509_free(x509);
  17964. if (!cert_ok) return false;
  17965. // Load private key
  17966. auto key_bio = BIO_new_mem_buf(key, -1);
  17967. if (!key_bio) return false;
  17968. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17969. password ? const_cast<char *>(password)
  17970. : nullptr);
  17971. BIO_free(key_bio);
  17972. if (!pkey) return false;
  17973. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  17974. EVP_PKEY_free(pkey);
  17975. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  17976. }
  17977. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17978. const char *key_path, const char *password) {
  17979. if (!ctx || !cert_path || !key_path) return false;
  17980. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17981. if (password && password[0] != '\0') {
  17982. SSL_CTX_set_default_passwd_cb_userdata(
  17983. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  17984. }
  17985. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  17986. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  17987. }
  17988. inline ctx_t create_server_context() {
  17989. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17990. if (ctx) {
  17991. // No renegotiation, as on the other backends: it would run a handshake
  17992. // that SSLServer::update_certs_pem() does not wait for
  17993. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  17994. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  17995. SSL_OP_NO_RENEGOTIATION);
  17996. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17997. // Without one, a client resuming its session is sent a fatal alert once
  17998. // client certificates are verified.
  17999. static const unsigned char sid_ctx[] = "cpp-httplib";
  18000. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  18001. }
  18002. return static_cast<ctx_t>(ctx);
  18003. }
  18004. inline void set_verify_client(ctx_t ctx, bool require) {
  18005. if (!ctx) return;
  18006. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  18007. }
  18008. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18009. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  18010. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18011. SSL *ssl = SSL_new(ssl_ctx);
  18012. if (!ssl) return nullptr;
  18013. // Disable auto-retry for proper non-blocking I/O handling
  18014. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  18015. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  18016. if (!bio) {
  18017. SSL_free(ssl);
  18018. return nullptr;
  18019. }
  18020. SSL_set_bio(ssl, bio, bio);
  18021. return static_cast<session_t>(ssl);
  18022. }
  18023. inline void free_session(session_t session) {
  18024. if (session) { SSL_free(static_cast<SSL *>(session)); }
  18025. }
  18026. inline bool set_sni(session_t session, const char *hostname,
  18027. bool verify_hostname) {
  18028. if (!session || !hostname) return false;
  18029. auto ssl = static_cast<SSL *>(session);
  18030. // The handshake's chain verification then checks the name as well
  18031. if (verify_hostname) {
  18032. auto param = SSL_get0_param(ssl);
  18033. X509_VERIFY_PARAM_set_hostflags(param, X509_CHECK_FLAG_NEVER_CHECK_SUBJECT);
  18034. if (X509_VERIFY_PARAM_set1_host(param, hostname, strlen(hostname)) != 1) {
  18035. return false;
  18036. }
  18037. }
  18038. #if defined(OPENSSL_IS_BORINGSSL)
  18039. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  18040. #else
  18041. // Direct call instead of macro to suppress -Wold-style-cast warning
  18042. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  18043. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  18044. #endif
  18045. }
  18046. inline TlsError connect(session_t session) {
  18047. if (!session) { return TlsError(); }
  18048. auto ssl = static_cast<SSL *>(session);
  18049. auto ret = SSL_connect(ssl);
  18050. TlsError err;
  18051. if (ret == 1) {
  18052. err.code = ErrorCode::Success;
  18053. } else {
  18054. impl::fill_connect_error(ssl, ret, err);
  18055. }
  18056. return err;
  18057. }
  18058. inline TlsError accept(session_t session) {
  18059. if (!session) { return TlsError(); }
  18060. auto ssl = static_cast<SSL *>(session);
  18061. auto ret = SSL_accept(ssl);
  18062. TlsError err;
  18063. if (ret == 1) {
  18064. err.code = ErrorCode::Success;
  18065. } else {
  18066. auto ssl_err = SSL_get_error(ssl, ret);
  18067. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  18068. err.backend_code = ERR_get_error();
  18069. }
  18070. return err;
  18071. }
  18072. inline bool connect_nonblocking(session_t session, socket_t sock,
  18073. time_t timeout_sec, time_t timeout_usec,
  18074. TlsError *err,
  18075. const std::function<bool()> &interrupted) {
  18076. if (!session) {
  18077. if (err) { err->code = ErrorCode::Fatal; }
  18078. return false;
  18079. }
  18080. auto ssl = static_cast<SSL *>(session);
  18081. auto bio = SSL_get_rbio(ssl);
  18082. // Set non-blocking mode for handshake
  18083. detail::set_nonblocking(sock, true);
  18084. if (bio) { BIO_set_nbio(bio, 1); }
  18085. auto cleanup = detail::scope_exit([&]() {
  18086. // Restore blocking mode after handshake
  18087. if (bio) { BIO_set_nbio(bio, 0); }
  18088. detail::set_nonblocking(sock, false);
  18089. });
  18090. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18091. auto res = 0;
  18092. while ((res = SSL_connect(ssl)) != 1) {
  18093. auto ssl_err = SSL_get_error(ssl, res);
  18094. switch (ssl_err) {
  18095. case SSL_ERROR_WANT_READ:
  18096. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  18097. continue;
  18098. }
  18099. break;
  18100. case SSL_ERROR_WANT_WRITE:
  18101. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  18102. continue;
  18103. }
  18104. break;
  18105. default: break;
  18106. }
  18107. if (err) { impl::fill_connect_error(ssl, res, *err); }
  18108. return false;
  18109. }
  18110. if (err) { err->code = ErrorCode::Success; }
  18111. return true;
  18112. }
  18113. inline bool accept_nonblocking(session_t session, socket_t sock,
  18114. time_t timeout_sec, time_t timeout_usec,
  18115. TlsError *err) {
  18116. if (!session) {
  18117. if (err) { err->code = ErrorCode::Fatal; }
  18118. return false;
  18119. }
  18120. auto ssl = static_cast<SSL *>(session);
  18121. auto bio = SSL_get_rbio(ssl);
  18122. // Set non-blocking mode for handshake
  18123. detail::set_nonblocking(sock, true);
  18124. if (bio) { BIO_set_nbio(bio, 1); }
  18125. auto cleanup = detail::scope_exit([&]() {
  18126. // Restore blocking mode after handshake
  18127. if (bio) { BIO_set_nbio(bio, 0); }
  18128. detail::set_nonblocking(sock, false);
  18129. });
  18130. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18131. auto res = 0;
  18132. while ((res = SSL_accept(ssl)) != 1) {
  18133. auto ssl_err = SSL_get_error(ssl, res);
  18134. switch (ssl_err) {
  18135. case SSL_ERROR_WANT_READ:
  18136. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18137. break;
  18138. case SSL_ERROR_WANT_WRITE:
  18139. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18140. break;
  18141. default: break;
  18142. }
  18143. if (err) {
  18144. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  18145. err->backend_code = ERR_get_error();
  18146. }
  18147. return false;
  18148. }
  18149. if (err) { err->code = ErrorCode::Success; }
  18150. return true;
  18151. }
  18152. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18153. if (!session || !buf) {
  18154. err.code = ErrorCode::Fatal;
  18155. return -1;
  18156. }
  18157. auto ssl = static_cast<SSL *>(session);
  18158. constexpr auto max_len =
  18159. static_cast<size_t>((std::numeric_limits<int>::max)());
  18160. if (len > max_len) { len = max_len; }
  18161. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  18162. if (ret > 0) {
  18163. err.code = ErrorCode::Success;
  18164. return ret;
  18165. }
  18166. auto ssl_err = SSL_get_error(ssl, ret);
  18167. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  18168. if (err.code == ErrorCode::PeerClosed) {
  18169. return 0;
  18170. } // Gracefully handle the peer closed state.
  18171. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  18172. return -1;
  18173. }
  18174. inline ssize_t write(session_t session, const void *buf, size_t len,
  18175. TlsError &err) {
  18176. if (!session || !buf) {
  18177. err.code = ErrorCode::Fatal;
  18178. return -1;
  18179. }
  18180. auto ssl = static_cast<SSL *>(session);
  18181. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  18182. if (ret > 0) {
  18183. err.code = ErrorCode::Success;
  18184. return ret;
  18185. }
  18186. auto ssl_err = SSL_get_error(ssl, ret);
  18187. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  18188. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  18189. return -1;
  18190. }
  18191. inline int pending(const_session_t session) {
  18192. if (!session) return 0;
  18193. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  18194. }
  18195. inline void shutdown(session_t session, bool graceful) {
  18196. if (!session) return;
  18197. auto ssl = static_cast<SSL *>(session);
  18198. if (graceful) {
  18199. // Send close_notify without waiting for the peer's. The connection is
  18200. // closed right after this, so a unidirectional shutdown is enough, and an
  18201. // idle peer that never answers would otherwise hold this thread until the
  18202. // read timeout. The other backends do not wait either.
  18203. SSL_shutdown(ssl);
  18204. }
  18205. }
  18206. inline bool is_peer_closed(session_t session, socket_t sock) {
  18207. if (!session) return true;
  18208. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  18209. detail::set_nonblocking(sock, true);
  18210. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18211. auto ssl = static_cast<SSL *>(session);
  18212. char buf;
  18213. auto ret = SSL_peek(ssl, &buf, 1);
  18214. if (ret > 0) return false;
  18215. auto err = SSL_get_error(ssl, ret);
  18216. return err == SSL_ERROR_ZERO_RETURN;
  18217. }
  18218. inline cert_t get_peer_cert(const_session_t session) {
  18219. if (!session) return nullptr;
  18220. return static_cast<cert_t>(SSL_get1_peer_certificate(
  18221. static_cast<SSL *>(const_cast<void *>(session))));
  18222. }
  18223. inline size_t get_peer_certs(const_session_t session,
  18224. std::vector<cert_t> &certs) {
  18225. certs.clear();
  18226. if (!session) { return 0; }
  18227. auto ssl = static_cast<const SSL *>(session);
  18228. // On the server side, the chain leaves out the peer's own certificate
  18229. if (SSL_is_server(ssl)) {
  18230. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  18231. }
  18232. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  18233. auto count = sk_X509_num(sk);
  18234. for (decltype(count) i = 0; i < count; i++) {
  18235. auto x509 = sk_X509_value(sk, i);
  18236. X509_up_ref(x509);
  18237. certs.push_back(static_cast<cert_t>(x509));
  18238. }
  18239. }
  18240. return certs.size();
  18241. }
  18242. inline void free_cert(cert_t cert) {
  18243. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  18244. }
  18245. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18246. if (!cert || !hostname) return false;
  18247. auto x509 = static_cast<X509 *>(cert);
  18248. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  18249. if (detail::is_ip_address(hostname)) {
  18250. return X509_check_ip_asc(x509, hostname, 0) == 1;
  18251. }
  18252. return X509_check_host(x509, hostname, strlen(hostname),
  18253. X509_CHECK_FLAG_NEVER_CHECK_SUBJECT, nullptr) == 1;
  18254. }
  18255. inline uint64_t hostname_mismatch_code() {
  18256. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  18257. }
  18258. inline long get_verify_result(const_session_t session) {
  18259. if (!session) return X509_V_ERR_UNSPECIFIED;
  18260. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  18261. }
  18262. inline std::string get_cert_subject_cn(cert_t cert) {
  18263. if (!cert) return "";
  18264. auto x509 = static_cast<X509 *>(cert);
  18265. auto subject_name = X509_get_subject_name(x509);
  18266. if (!subject_name) return "";
  18267. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  18268. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  18269. if (idx < 0) return "";
  18270. auto entry = X509_NAME_get_entry(subject_name, idx);
  18271. if (!entry) return "";
  18272. auto data = X509_NAME_ENTRY_get_data(entry);
  18273. if (!data) return "";
  18274. return std::string(
  18275. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  18276. static_cast<size_t>(ASN1_STRING_length(data)));
  18277. }
  18278. inline std::string get_cert_issuer_name(cert_t cert) {
  18279. if (!cert) return "";
  18280. auto x509 = static_cast<X509 *>(cert);
  18281. auto issuer_name = X509_get_issuer_name(x509);
  18282. if (!issuer_name) return "";
  18283. char buf[256];
  18284. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  18285. return std::string(buf);
  18286. }
  18287. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18288. sans.clear();
  18289. if (!cert) return false;
  18290. auto x509 = static_cast<X509 *>(cert);
  18291. auto names = static_cast<GENERAL_NAMES *>(
  18292. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18293. if (!names) return true; // No SANs is valid
  18294. auto count = sk_GENERAL_NAME_num(names);
  18295. for (decltype(count) i = 0; i < count; i++) {
  18296. auto gen = sk_GENERAL_NAME_value(names, i);
  18297. if (!gen) continue;
  18298. SanEntry entry;
  18299. switch (gen->type) {
  18300. case GEN_DNS:
  18301. entry.type = SanType::DNS;
  18302. if (gen->d.dNSName) {
  18303. entry.value = std::string(
  18304. reinterpret_cast<const char *>(
  18305. ASN1_STRING_get0_data(gen->d.dNSName)),
  18306. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  18307. }
  18308. break;
  18309. case GEN_IPADD:
  18310. entry.type = SanType::IP;
  18311. if (gen->d.iPAddress) {
  18312. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  18313. auto len = ASN1_STRING_length(gen->d.iPAddress);
  18314. if (len == 4) {
  18315. // IPv4
  18316. char buf[INET_ADDRSTRLEN];
  18317. inet_ntop(AF_INET, data, buf, sizeof(buf));
  18318. entry.value = buf;
  18319. } else if (len == 16) {
  18320. // IPv6
  18321. char buf[INET6_ADDRSTRLEN];
  18322. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  18323. entry.value = buf;
  18324. }
  18325. }
  18326. break;
  18327. case GEN_EMAIL:
  18328. entry.type = SanType::EMAIL;
  18329. if (gen->d.rfc822Name) {
  18330. entry.value = std::string(
  18331. reinterpret_cast<const char *>(
  18332. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  18333. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  18334. }
  18335. break;
  18336. case GEN_URI:
  18337. entry.type = SanType::URI;
  18338. if (gen->d.uniformResourceIdentifier) {
  18339. entry.value = std::string(
  18340. reinterpret_cast<const char *>(
  18341. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  18342. static_cast<size_t>(
  18343. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  18344. }
  18345. break;
  18346. default: entry.type = SanType::OTHER; break;
  18347. }
  18348. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18349. }
  18350. GENERAL_NAMES_free(names);
  18351. return true;
  18352. }
  18353. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18354. time_t &not_after) {
  18355. if (!cert) return false;
  18356. auto x509 = static_cast<X509 *>(cert);
  18357. auto nb = X509_get0_notBefore(x509);
  18358. auto na = X509_get0_notAfter(x509);
  18359. if (!nb || !na) return false;
  18360. ASN1_TIME *epoch = ASN1_TIME_new();
  18361. if (!epoch) return false;
  18362. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  18363. if (!ASN1_TIME_set(epoch, 0)) return false;
  18364. int pday, psec;
  18365. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  18366. not_before = 86400 * (time_t)pday + psec;
  18367. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  18368. not_after = 86400 * (time_t)pday + psec;
  18369. return true;
  18370. }
  18371. inline std::string get_cert_serial(cert_t cert) {
  18372. if (!cert) return "";
  18373. auto x509 = static_cast<X509 *>(cert);
  18374. auto serial = X509_get_serialNumber(x509);
  18375. if (!serial) return "";
  18376. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  18377. if (!bn) return "";
  18378. auto hex = BN_bn2hex(bn);
  18379. BN_free(bn);
  18380. if (!hex) return "";
  18381. std::string result(hex);
  18382. OPENSSL_free(hex);
  18383. return result;
  18384. }
  18385. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18386. if (!cert) return false;
  18387. auto x509 = static_cast<X509 *>(cert);
  18388. auto len = i2d_X509(x509, nullptr);
  18389. if (len < 0) return false;
  18390. der.resize(static_cast<size_t>(len));
  18391. auto p = der.data();
  18392. i2d_X509(x509, &p);
  18393. return true;
  18394. }
  18395. inline const char *get_sni(const_session_t session) {
  18396. if (!session) return nullptr;
  18397. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  18398. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  18399. }
  18400. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  18401. inline uint64_t get_error() { return ERR_get_error(); }
  18402. inline std::string error_string(uint64_t code) {
  18403. char buf[256];
  18404. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  18405. sizeof(buf));
  18406. return std::string(buf);
  18407. }
  18408. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18409. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  18410. if (!mem) { return nullptr; }
  18411. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  18412. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  18413. if (!inf) { return nullptr; }
  18414. auto store = X509_STORE_new();
  18415. if (store) {
  18416. auto count = sk_X509_INFO_num(inf);
  18417. for (decltype(count) i = 0; i < count; i++) {
  18418. auto itmp = sk_X509_INFO_value(inf, i);
  18419. if (!itmp) { continue; }
  18420. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  18421. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  18422. }
  18423. }
  18424. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  18425. return static_cast<ca_store_t>(store);
  18426. }
  18427. inline void free_ca_store(ca_store_t store) {
  18428. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  18429. }
  18430. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18431. if (!ctx || !store) { return false; }
  18432. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18433. auto x509_store = static_cast<X509_STORE *>(store);
  18434. // Check if same store is already set
  18435. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  18436. // SSL_CTX_set_cert_store takes ownership and frees the old store
  18437. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  18438. return true;
  18439. }
  18440. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18441. certs.clear();
  18442. if (!ctx) { return 0; }
  18443. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18444. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  18445. if (!store) { return 0; }
  18446. auto objs = impl::get_store_objects(store);
  18447. if (!objs) { return 0; }
  18448. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  18449. auto count = sk_X509_OBJECT_num(objs);
  18450. for (decltype(count) i = 0; i < count; i++) {
  18451. auto obj = sk_X509_OBJECT_value(objs, i);
  18452. if (!obj) { continue; }
  18453. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  18454. auto x509 = X509_OBJECT_get0_X509(obj);
  18455. if (x509) {
  18456. // Increment reference count so caller can free it
  18457. X509_up_ref(x509);
  18458. certs.push_back(static_cast<cert_t>(x509));
  18459. }
  18460. }
  18461. }
  18462. return certs.size();
  18463. }
  18464. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18465. std::vector<std::string> names;
  18466. if (!ctx) { return names; }
  18467. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18468. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  18469. if (!store) { return names; }
  18470. auto objs = impl::get_store_objects(store);
  18471. if (!objs) { return names; }
  18472. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  18473. auto count = sk_X509_OBJECT_num(objs);
  18474. for (decltype(count) i = 0; i < count; i++) {
  18475. auto obj = sk_X509_OBJECT_value(objs, i);
  18476. if (!obj) { continue; }
  18477. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  18478. auto x509 = X509_OBJECT_get0_X509(obj);
  18479. if (x509) {
  18480. auto subject = X509_get_subject_name(x509);
  18481. if (subject) {
  18482. char buf[512];
  18483. X509_NAME_oneline(subject, buf, sizeof(buf));
  18484. names.push_back(buf);
  18485. }
  18486. }
  18487. }
  18488. }
  18489. return names;
  18490. }
  18491. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18492. const char *key_pem, const char *password) {
  18493. if (!ctx || !cert_pem || !key_pem) { return false; }
  18494. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18495. // Load certificate from PEM
  18496. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  18497. if (!cert_bio) { return false; }
  18498. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  18499. BIO_free(cert_bio);
  18500. if (!cert) { return false; }
  18501. // Load private key from PEM
  18502. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  18503. if (!key_bio) {
  18504. X509_free(cert);
  18505. return false;
  18506. }
  18507. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  18508. password ? const_cast<char *>(password)
  18509. : nullptr);
  18510. BIO_free(key_bio);
  18511. if (!key) {
  18512. X509_free(cert);
  18513. return false;
  18514. }
  18515. // Update certificate and key
  18516. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  18517. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  18518. X509_free(cert);
  18519. EVP_PKEY_free(key);
  18520. return ret;
  18521. }
  18522. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18523. if (!ctx || !ca_pem) { return false; }
  18524. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18525. // Create new X509_STORE from PEM
  18526. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  18527. if (!store) { return false; }
  18528. // A resumed session is not verified again, so the ticket keys from before
  18529. // go, or a client verified under the old CAs could go on resuming.
  18530. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  18531. unsigned char ticket_keys[48];
  18532. #else
  18533. unsigned char ticket_keys[80];
  18534. #endif
  18535. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  18536. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  18537. sizeof(ticket_keys)) != 1) {
  18538. free_ca_store(store);
  18539. return false;
  18540. }
  18541. // SSL_CTX_set_cert_store takes ownership
  18542. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  18543. // Set client CA list for client certificate request
  18544. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  18545. if (ca_list) {
  18546. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  18547. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  18548. }
  18549. // The cached sessions go for the same reason.
  18550. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  18551. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  18552. #else
  18553. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  18554. #endif
  18555. return true;
  18556. }
  18557. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18558. if (!ctx) { return false; }
  18559. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18560. auto index = impl::verify_callback_index();
  18561. if (index < 0) { return false; }
  18562. std::shared_ptr<VerifyCallback> *stored = nullptr;
  18563. if (callback) {
  18564. stored = new std::shared_ptr<VerifyCallback>(
  18565. std::make_shared<VerifyCallback>(std::move(callback)));
  18566. }
  18567. std::shared_ptr<VerifyCallback> *previous = nullptr;
  18568. {
  18569. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  18570. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  18571. SSL_CTX_get_ex_data(ssl_ctx, index));
  18572. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  18573. delete stored;
  18574. return false;
  18575. }
  18576. }
  18577. // A handshake running the previous callback keeps it until it returns.
  18578. delete previous;
  18579. // A resumed handshake shows no certificate to run the callback on.
  18580. if (stored) {
  18581. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  18582. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  18583. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  18584. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  18585. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  18586. #endif
  18587. }
  18588. // Keep requiring the peer's certificate if set_verify_client() asked for it
  18589. auto require =
  18590. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  18591. impl::apply_verify_mode(ssl_ctx, require);
  18592. return true;
  18593. }
  18594. inline long get_verify_error(const_session_t session) {
  18595. if (!session) { return -1; }
  18596. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  18597. return SSL_get_verify_result(ssl);
  18598. }
  18599. inline std::string verify_error_string(long error_code) {
  18600. if (error_code == X509_V_OK) { return ""; }
  18601. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  18602. return str ? str : "unknown error";
  18603. }
  18604. } // namespace tls
  18605. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  18606. /*
  18607. * Group 9: TLS abstraction layer - Mbed TLS backend
  18608. */
  18609. /*
  18610. * Mbed TLS Backend Implementation
  18611. */
  18612. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  18613. namespace tls {
  18614. namespace impl {
  18615. // Mbed TLS session wrapper
  18616. struct MbedTlsSession {
  18617. mbedtls_ssl_context ssl;
  18618. socket_t sock = INVALID_SOCKET;
  18619. std::string hostname; // For client: set via set_sni
  18620. std::string sni_hostname; // For server: received from client via SNI callback
  18621. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  18622. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  18623. // (e.g. a response that arrived while this side was still in its post-write
  18624. // check), the byte is pushed back here and served by the next read().
  18625. unsigned char peeked_byte = 0;
  18626. bool has_peeked_byte = false;
  18627. // Set by set_sni() when the caller disabled hostname verification, so the
  18628. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  18629. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  18630. // OpenSSL and wolfSSL keep them independent).
  18631. bool suppress_hostname_mismatch = false;
  18632. // Copied from the owning MbedTlsContext at creation, so a handshake only
  18633. // ever runs the callback of its own context.
  18634. VerifyCallback verify_callback;
  18635. bool is_server = false;
  18636. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  18637. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  18638. MbedTlsSession(const MbedTlsSession &) = delete;
  18639. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  18640. };
  18641. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  18642. // queue)
  18643. inline int &mbedtls_last_error() {
  18644. static thread_local int err = 0;
  18645. return err;
  18646. }
  18647. // Helper to map Mbed TLS error to ErrorCode
  18648. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  18649. uint32_t verify_flags) {
  18650. if (ret == 0) { return ErrorCode::Success; }
  18651. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  18652. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  18653. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  18654. return ErrorCode::PeerClosed;
  18655. }
  18656. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  18657. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  18658. out_errno = errno;
  18659. return ErrorCode::SyscallError;
  18660. }
  18661. if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
  18662. // EOF without close_notify
  18663. out_errno = 0;
  18664. return ErrorCode::SyscallError;
  18665. }
  18666. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  18667. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  18668. // the handshake's chain verification (see set_sni()); a mismatch there
  18669. // is reported the same way as any other verify_flags bit. Report it as
  18670. // HostnameMismatch, matching the other backends and the post-handshake
  18671. // identity check below, but only when naming is the sole problem -
  18672. // if the chain itself is also untrusted/expired/etc., that takes
  18673. // priority over the naming detail.
  18674. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  18675. return ErrorCode::HostnameMismatch;
  18676. }
  18677. return ErrorCode::CertVerifyFailed;
  18678. }
  18679. return ErrorCode::Fatal;
  18680. }
  18681. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  18682. // return value, including the verify-flags-dependent HostnameMismatch
  18683. // mapping; shared by connect() and connect_nonblocking() so the
  18684. // backend_code policy for that mapping only lives in one place.
  18685. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  18686. int ret) {
  18687. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  18688. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  18689. err.backend_code = err.code == ErrorCode::HostnameMismatch
  18690. ? static_cast<uint64_t>(verify_flags)
  18691. : static_cast<uint64_t>(-ret);
  18692. }
  18693. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  18694. // non-fatal notification delivered between records, not an error and not
  18695. // application data, so I/O calls that see it should just be retried. Kept in
  18696. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  18697. // splitting the closing brace across an #if.
  18698. inline bool mbedtls_is_session_ticket(int ret) {
  18699. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  18700. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  18701. #else
  18702. (void)ret;
  18703. return false;
  18704. #endif
  18705. }
  18706. // BIO-like send callback for Mbed TLS
  18707. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  18708. size_t len) {
  18709. auto sock = *static_cast<socket_t *>(ctx);
  18710. #ifdef _WIN32
  18711. auto ret =
  18712. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  18713. if (ret == SOCKET_ERROR) {
  18714. int err = WSAGetLastError();
  18715. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  18716. return MBEDTLS_ERR_NET_SEND_FAILED;
  18717. }
  18718. #else
  18719. auto ret = send(sock, buf, len, 0);
  18720. if (ret < 0) {
  18721. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18722. return MBEDTLS_ERR_SSL_WANT_WRITE;
  18723. }
  18724. return MBEDTLS_ERR_NET_SEND_FAILED;
  18725. }
  18726. #endif
  18727. return static_cast<int>(ret);
  18728. }
  18729. // BIO-like recv callback for Mbed TLS
  18730. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  18731. auto sock = *static_cast<socket_t *>(ctx);
  18732. #ifdef _WIN32
  18733. auto ret =
  18734. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  18735. if (ret == SOCKET_ERROR) {
  18736. int err = WSAGetLastError();
  18737. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  18738. return MBEDTLS_ERR_NET_RECV_FAILED;
  18739. }
  18740. #else
  18741. auto ret = recv(sock, buf, len, 0);
  18742. if (ret < 0) {
  18743. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18744. return MBEDTLS_ERR_SSL_WANT_READ;
  18745. }
  18746. return MBEDTLS_ERR_NET_RECV_FAILED;
  18747. }
  18748. #endif
  18749. // EOF is MBEDTLS_ERR_SSL_CONN_EOF; only a close_notify is a clean end
  18750. return static_cast<int>(ret);
  18751. }
  18752. // MbedTlsContext constructor/destructor implementations
  18753. inline MbedTlsContext::MbedTlsContext() {
  18754. mbedtls_ssl_config_init(&conf);
  18755. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18756. mbedtls_entropy_init(&entropy);
  18757. mbedtls_ctr_drbg_init(&ctr_drbg);
  18758. #endif
  18759. mbedtls_x509_crt_init(&ca_chain);
  18760. mbedtls_x509_crt_init(&own_cert);
  18761. mbedtls_pk_init(&own_key);
  18762. }
  18763. inline MbedTlsContext::~MbedTlsContext() {
  18764. mbedtls_pk_free(&own_key);
  18765. mbedtls_x509_crt_free(&own_cert);
  18766. mbedtls_x509_crt_free(&ca_chain);
  18767. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18768. mbedtls_ctr_drbg_free(&ctr_drbg);
  18769. mbedtls_entropy_free(&entropy);
  18770. #endif
  18771. mbedtls_ssl_config_free(&conf);
  18772. }
  18773. // Thread-local storage for SNI captured during handshake
  18774. // This is needed because the SNI callback doesn't have a way to pass
  18775. // session-specific data before the session is fully set up
  18776. inline std::string &mbedpending_sni() {
  18777. static thread_local std::string sni;
  18778. return sni;
  18779. }
  18780. // SNI callback for Mbed TLS server to capture client's SNI hostname
  18781. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  18782. const unsigned char *name, size_t name_len) {
  18783. (void)p_ctx;
  18784. (void)ssl;
  18785. // Store SNI name in thread-local storage
  18786. // It will be retrieved and stored in the session after handshake
  18787. if (name && name_len > 0) {
  18788. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  18789. } else {
  18790. mbedpending_sni().clear();
  18791. }
  18792. return 0; // Accept any SNI
  18793. }
  18794. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  18795. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  18796. }
  18797. // MbedTLS verify callback wrapper
  18798. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  18799. int cert_depth, uint32_t *flags) {
  18800. // data points to the MbedTlsSession
  18801. auto *session = static_cast<MbedTlsSession *>(data);
  18802. // set_sni() disabled hostname verification for this session: ignore the
  18803. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  18804. // pass/fail decision still comes from the remaining flags (and, below, from
  18805. // the user's own verify callback).
  18806. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  18807. const auto &callback = session->verify_callback;
  18808. if (!callback) { return 0; } // Continue with default verification
  18809. // Build context
  18810. VerifyContext verify_ctx;
  18811. verify_ctx.session = static_cast<session_t>(session);
  18812. verify_ctx.cert = static_cast<cert_t>(crt);
  18813. verify_ctx.depth = cert_depth;
  18814. verify_ctx.preverify_ok = (*flags == 0);
  18815. verify_ctx.error_code = static_cast<long>(*flags);
  18816. // Convert Mbed TLS flags to error string
  18817. static thread_local char error_buf[256];
  18818. if (*flags != 0) {
  18819. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  18820. verify_ctx.error_string = error_buf;
  18821. } else {
  18822. verify_ctx.error_string = nullptr;
  18823. }
  18824. bool accepted = run_verify_callback(callback, verify_ctx);
  18825. if (accepted) {
  18826. // Overrides the built-in verification only on a server, as on OpenSSL and
  18827. // wolfSSL, whose clients check the verify result after the handshake
  18828. if (session->is_server) { *flags = 0; }
  18829. return 0;
  18830. }
  18831. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  18832. }
  18833. // Sets the authentication mode from whether the peer's certificate is required
  18834. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  18835. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  18836. inline void apply_verify_mode(MbedTlsContext &mctx) {
  18837. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  18838. if (mctx.verify_client) {
  18839. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  18840. } else if (mctx.verify_callback) {
  18841. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  18842. }
  18843. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  18844. }
  18845. } // namespace impl
  18846. inline ctx_t create_client_context() {
  18847. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18848. if (!ctx) { return nullptr; }
  18849. ctx->is_server = false;
  18850. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18851. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18852. if (!detail::ensure_mbedtls_psa_crypto()) {
  18853. delete ctx;
  18854. return nullptr;
  18855. }
  18856. int ret;
  18857. #else
  18858. // Seed the random number generator
  18859. const char *pers = "httplib_client";
  18860. int ret = mbedtls_ctr_drbg_seed(
  18861. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18862. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18863. if (ret != 0) {
  18864. impl::mbedtls_last_error() = ret;
  18865. delete ctx;
  18866. return nullptr;
  18867. }
  18868. #endif
  18869. // Set up SSL config for client
  18870. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  18871. MBEDTLS_SSL_TRANSPORT_STREAM,
  18872. MBEDTLS_SSL_PRESET_DEFAULT);
  18873. if (ret != 0) {
  18874. impl::mbedtls_last_error() = ret;
  18875. delete ctx;
  18876. return nullptr;
  18877. }
  18878. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18879. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18880. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18881. #endif
  18882. // Default: verify peer certificate
  18883. ctx->verify_client = true;
  18884. impl::apply_verify_mode(*ctx);
  18885. // Set minimum TLS version to 1.2
  18886. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18887. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18888. #else
  18889. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18890. MBEDTLS_SSL_MINOR_VERSION_3);
  18891. #endif
  18892. return static_cast<ctx_t>(ctx);
  18893. }
  18894. inline ctx_t create_server_context() {
  18895. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18896. if (!ctx) { return nullptr; }
  18897. ctx->is_server = true;
  18898. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18899. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18900. if (!detail::ensure_mbedtls_psa_crypto()) {
  18901. delete ctx;
  18902. return nullptr;
  18903. }
  18904. int ret;
  18905. #else
  18906. // Seed the random number generator
  18907. const char *pers = "httplib_server";
  18908. int ret = mbedtls_ctr_drbg_seed(
  18909. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18910. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18911. if (ret != 0) {
  18912. impl::mbedtls_last_error() = ret;
  18913. delete ctx;
  18914. return nullptr;
  18915. }
  18916. #endif
  18917. // Set up SSL config for server
  18918. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  18919. MBEDTLS_SSL_TRANSPORT_STREAM,
  18920. MBEDTLS_SSL_PRESET_DEFAULT);
  18921. if (ret != 0) {
  18922. impl::mbedtls_last_error() = ret;
  18923. delete ctx;
  18924. return nullptr;
  18925. }
  18926. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18927. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18928. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18929. #endif
  18930. // Default: don't verify client
  18931. impl::apply_verify_mode(*ctx);
  18932. // Set minimum TLS version to 1.2
  18933. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18934. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18935. #else
  18936. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18937. MBEDTLS_SSL_MINOR_VERSION_3);
  18938. #endif
  18939. // Set SNI callback to capture client's SNI hostname
  18940. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  18941. return static_cast<ctx_t>(ctx);
  18942. }
  18943. inline void free_context(ctx_t ctx) {
  18944. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  18945. }
  18946. inline bool set_min_version(ctx_t ctx, Version version) {
  18947. if (!ctx) { return false; }
  18948. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18949. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18950. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  18951. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  18952. if (version >= Version::TLS1_3) {
  18953. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18954. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  18955. #endif
  18956. }
  18957. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  18958. #else
  18959. // Mbed TLS 2.x uses major/minor version numbers
  18960. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  18961. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  18962. if (version >= Version::TLS1_3) {
  18963. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18964. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  18965. #else
  18966. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  18967. #endif
  18968. }
  18969. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  18970. #endif
  18971. return true;
  18972. }
  18973. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18974. if (!ctx || !pem) { return false; }
  18975. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18976. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  18977. // Add null terminator if not present
  18978. std::string pem_str(pem, len);
  18979. int ret = mbedtls_x509_crt_parse(
  18980. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18981. pem_str.size() + 1);
  18982. if (ret != 0) {
  18983. impl::mbedtls_last_error() = ret;
  18984. return false;
  18985. }
  18986. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18987. return true;
  18988. }
  18989. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18990. if (!ctx || !file_path) { return false; }
  18991. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18992. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  18993. if (ret != 0) {
  18994. impl::mbedtls_last_error() = ret;
  18995. return false;
  18996. }
  18997. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18998. return true;
  18999. }
  19000. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  19001. if (!ctx || !dir_path) { return false; }
  19002. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19003. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  19004. if (ret < 0) { // Returns number of certs on success, negative on error
  19005. impl::mbedtls_last_error() = ret;
  19006. return false;
  19007. }
  19008. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  19009. return true;
  19010. }
  19011. inline bool load_system_certs(ctx_t ctx) {
  19012. if (!ctx) { return false; }
  19013. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19014. bool loaded = false;
  19015. #ifdef _WIN32
  19016. loaded = impl::enumerate_windows_system_certs(
  19017. [&](const unsigned char *data, size_t len) {
  19018. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  19019. });
  19020. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19021. loaded = impl::enumerate_macos_keychain_certs(
  19022. [&](const unsigned char *data, size_t len) {
  19023. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  19024. });
  19025. #else
  19026. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19027. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  19028. loaded = true;
  19029. break;
  19030. }
  19031. }
  19032. if (!loaded) {
  19033. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19034. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  19035. loaded = true;
  19036. break;
  19037. }
  19038. }
  19039. }
  19040. #endif
  19041. if (loaded) {
  19042. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  19043. }
  19044. return loaded;
  19045. }
  19046. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19047. const char *password) {
  19048. if (!ctx || !cert || !key) { return false; }
  19049. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19050. // Parse certificate
  19051. std::string cert_str(cert);
  19052. int ret = mbedtls_x509_crt_parse(
  19053. &mctx->own_cert,
  19054. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  19055. cert_str.size() + 1);
  19056. if (ret != 0) {
  19057. impl::mbedtls_last_error() = ret;
  19058. return false;
  19059. }
  19060. // Parse private key
  19061. std::string key_str(key);
  19062. const unsigned char *pwd =
  19063. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  19064. size_t pwd_len = password ? strlen(password) : 0;
  19065. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  19066. ret = mbedtls_pk_parse_key(
  19067. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  19068. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  19069. &mctx->ctr_drbg);
  19070. #else
  19071. ret = mbedtls_pk_parse_key(
  19072. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  19073. key_str.size() + 1, pwd, pwd_len);
  19074. #endif
  19075. if (ret != 0) {
  19076. impl::mbedtls_last_error() = ret;
  19077. return false;
  19078. }
  19079. // Verify that the certificate and private key match.
  19080. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  19081. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  19082. #ifndef CPPHTTPLIB_MBEDTLS_V4
  19083. #ifdef CPPHTTPLIB_MBEDTLS_V3
  19084. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  19085. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  19086. #else
  19087. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  19088. #endif
  19089. if (ret != 0) {
  19090. impl::mbedtls_last_error() = ret;
  19091. return false;
  19092. }
  19093. #endif
  19094. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  19095. if (ret != 0) {
  19096. impl::mbedtls_last_error() = ret;
  19097. return false;
  19098. }
  19099. return true;
  19100. }
  19101. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19102. const char *key_path, const char *password) {
  19103. if (!ctx || !cert_path || !key_path) { return false; }
  19104. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19105. // Parse certificate file
  19106. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  19107. if (ret != 0) {
  19108. impl::mbedtls_last_error() = ret;
  19109. return false;
  19110. }
  19111. // Parse private key file
  19112. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  19113. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  19114. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  19115. #else
  19116. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  19117. #endif
  19118. if (ret != 0) {
  19119. impl::mbedtls_last_error() = ret;
  19120. return false;
  19121. }
  19122. // Verify that the certificate and private key match.
  19123. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  19124. #ifndef CPPHTTPLIB_MBEDTLS_V4
  19125. #ifdef CPPHTTPLIB_MBEDTLS_V3
  19126. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  19127. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  19128. #else
  19129. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  19130. #endif
  19131. if (ret != 0) {
  19132. impl::mbedtls_last_error() = ret;
  19133. return false;
  19134. }
  19135. #endif
  19136. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  19137. if (ret != 0) {
  19138. impl::mbedtls_last_error() = ret;
  19139. return false;
  19140. }
  19141. return true;
  19142. }
  19143. inline void set_verify_client(ctx_t ctx, bool require) {
  19144. if (!ctx) { return; }
  19145. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19146. mctx->verify_client = require;
  19147. impl::apply_verify_mode(*mctx);
  19148. }
  19149. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19150. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19151. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19152. auto session = new (std::nothrow) impl::MbedTlsSession();
  19153. if (!session) { return nullptr; }
  19154. session->sock = sock;
  19155. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  19156. if (ret != 0) {
  19157. impl::mbedtls_last_error() = ret;
  19158. delete session;
  19159. return nullptr;
  19160. }
  19161. // Explicitly opt out of in-handshake hostname verification by default;
  19162. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  19163. // fails outright when no hostname was set. set_sni() installs the real
  19164. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  19165. // caller verifies the certificate identity post-handshake via
  19166. // verify_hostname().
  19167. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  19168. // Set BIO callbacks
  19169. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  19170. impl::mbedtls_net_recv_cb, nullptr);
  19171. // Installed always, as it also masks the hostname mismatch that set_sni()
  19172. // may ask for. The session runs its own copy of the user's callback, which
  19173. // set_verify_callback() cannot replace under a handshake.
  19174. session->verify_callback = mctx->verify_callback;
  19175. session->is_server = mctx->is_server;
  19176. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  19177. return static_cast<session_t>(session);
  19178. }
  19179. inline void free_session(session_t session) {
  19180. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  19181. }
  19182. inline bool set_sni(session_t session, const char *hostname,
  19183. bool verify_hostname) {
  19184. if (!session || !hostname) { return false; }
  19185. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19186. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  19187. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  19188. // independently, so a disabled hostname check is handled below by masking
  19189. // the resulting mismatch flag instead of skipping this call.
  19190. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  19191. if (ret != 0) {
  19192. impl::mbedtls_last_error() = ret;
  19193. return false;
  19194. }
  19195. msession->hostname = hostname;
  19196. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  19197. return true;
  19198. }
  19199. inline TlsError connect(session_t session) {
  19200. TlsError err;
  19201. if (!session) {
  19202. err.code = ErrorCode::Fatal;
  19203. return err;
  19204. }
  19205. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19206. int ret;
  19207. do {
  19208. ret = mbedtls_ssl_handshake(&msession->ssl);
  19209. } while (impl::mbedtls_is_session_ticket(ret));
  19210. if (ret == 0) {
  19211. err.code = ErrorCode::Success;
  19212. } else {
  19213. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  19214. impl::mbedtls_last_error() = ret;
  19215. }
  19216. return err;
  19217. }
  19218. inline TlsError accept(session_t session) {
  19219. // A failed handshake leaves its SNI behind, so start without it
  19220. impl::mbedpending_sni().clear();
  19221. // Same as connect for Mbed TLS - handshake works for both client and server
  19222. auto result = connect(session);
  19223. // After successful handshake, capture SNI from thread-local storage
  19224. if (result.code == ErrorCode::Success && session) {
  19225. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19226. msession->sni_hostname = std::move(impl::mbedpending_sni());
  19227. }
  19228. return result;
  19229. }
  19230. inline bool connect_nonblocking(session_t session, socket_t sock,
  19231. time_t timeout_sec, time_t timeout_usec,
  19232. TlsError *err,
  19233. const std::function<bool()> &interrupted) {
  19234. if (!session) {
  19235. if (err) { err->code = ErrorCode::Fatal; }
  19236. return false;
  19237. }
  19238. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19239. // Set socket to non-blocking mode
  19240. detail::set_nonblocking(sock, true);
  19241. auto cleanup =
  19242. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19243. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19244. int ret;
  19245. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  19246. // Non-fatal TLS 1.3 ticket; retry immediately.
  19247. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  19248. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  19249. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  19250. continue;
  19251. }
  19252. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  19253. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  19254. continue;
  19255. }
  19256. }
  19257. // TlsError or timeout
  19258. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  19259. impl::mbedtls_last_error() = ret;
  19260. return false;
  19261. }
  19262. if (err) { err->code = ErrorCode::Success; }
  19263. return true;
  19264. }
  19265. inline bool accept_nonblocking(session_t session, socket_t sock,
  19266. time_t timeout_sec, time_t timeout_usec,
  19267. TlsError *err) {
  19268. // A failed handshake leaves its SNI behind, so start without it
  19269. impl::mbedpending_sni().clear();
  19270. // Same implementation as connect for Mbed TLS
  19271. bool result =
  19272. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  19273. // After successful handshake, capture SNI from thread-local storage
  19274. if (result && session) {
  19275. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19276. msession->sni_hostname = std::move(impl::mbedpending_sni());
  19277. }
  19278. return result;
  19279. }
  19280. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19281. if (!session || !buf) {
  19282. err.code = ErrorCode::Fatal;
  19283. return -1;
  19284. }
  19285. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19286. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  19287. if (msession->has_peeked_byte) {
  19288. if (len == 0) { return 0; }
  19289. auto p = static_cast<unsigned char *>(buf);
  19290. p[0] = msession->peeked_byte;
  19291. msession->has_peeked_byte = false;
  19292. size_t n = 1;
  19293. // Top up with any already-decrypted bytes without risking a block.
  19294. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  19295. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  19296. if (extra > 0) { n += static_cast<size_t>(extra); }
  19297. }
  19298. err.code = ErrorCode::Success;
  19299. return static_cast<ssize_t>(n);
  19300. }
  19301. int ret;
  19302. do {
  19303. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  19304. len);
  19305. } while (impl::mbedtls_is_session_ticket(ret));
  19306. if (ret > 0) {
  19307. err.code = ErrorCode::Success;
  19308. return static_cast<ssize_t>(ret);
  19309. }
  19310. // 0 means EOF without close_notify, which is an error as on OpenSSL
  19311. if (ret == 0) { ret = MBEDTLS_ERR_SSL_CONN_EOF; }
  19312. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  19313. err.backend_code = static_cast<uint64_t>(-ret);
  19314. impl::mbedtls_last_error() = ret;
  19315. // mbedTLS signals a clean close_notify via a negative error code rather
  19316. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  19317. if (err.code == ErrorCode::PeerClosed) { return 0; }
  19318. return -1;
  19319. }
  19320. inline ssize_t write(session_t session, const void *buf, size_t len,
  19321. TlsError &err) {
  19322. if (!session || !buf) {
  19323. err.code = ErrorCode::Fatal;
  19324. return -1;
  19325. }
  19326. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19327. int ret;
  19328. do {
  19329. ret = mbedtls_ssl_write(&msession->ssl,
  19330. static_cast<const unsigned char *>(buf), len);
  19331. } while (impl::mbedtls_is_session_ticket(ret));
  19332. if (ret > 0) {
  19333. err.code = ErrorCode::Success;
  19334. return static_cast<ssize_t>(ret);
  19335. }
  19336. if (ret == 0) {
  19337. err.code = ErrorCode::PeerClosed;
  19338. return 0;
  19339. }
  19340. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  19341. err.backend_code = static_cast<uint64_t>(-ret);
  19342. impl::mbedtls_last_error() = ret;
  19343. return -1;
  19344. }
  19345. inline int pending(const_session_t session) {
  19346. if (!session) { return 0; }
  19347. auto msession =
  19348. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19349. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  19350. (msession->has_peeked_byte ? 1 : 0);
  19351. }
  19352. inline void shutdown(session_t session, bool graceful) {
  19353. if (!session) { return; }
  19354. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19355. if (graceful) {
  19356. // Try to send close_notify, but don't block forever
  19357. int ret;
  19358. int attempts = 0;
  19359. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  19360. attempts < 3) {
  19361. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  19362. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  19363. break;
  19364. }
  19365. attempts++;
  19366. }
  19367. }
  19368. }
  19369. inline bool is_peer_closed(session_t session, socket_t sock) {
  19370. if (!session || sock == INVALID_SOCKET) { return true; }
  19371. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19372. // Check if there's already decrypted or pushed-back data available.
  19373. // If so, the connection is definitely alive.
  19374. if (msession->has_peeked_byte ||
  19375. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  19376. return false;
  19377. }
  19378. // Set socket to non-blocking to avoid blocking on read
  19379. detail::set_nonblocking(sock, true);
  19380. auto cleanup =
  19381. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19382. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  19383. // on application data — e.g. a response that already arrived — push the
  19384. // byte back so the next read() delivers it instead of losing it.
  19385. unsigned char buf;
  19386. int ret;
  19387. do {
  19388. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  19389. } while (impl::mbedtls_is_session_ticket(ret));
  19390. // If we got data or WANT_READ (would block), connection is alive
  19391. if (ret > 0) {
  19392. msession->peeked_byte = buf;
  19393. msession->has_peeked_byte = true;
  19394. return false;
  19395. }
  19396. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  19397. // If we get a peer close notify or a connection reset, the peer is closed
  19398. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  19399. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  19400. }
  19401. inline cert_t get_peer_cert(const_session_t session) {
  19402. if (!session) { return nullptr; }
  19403. auto msession =
  19404. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19405. // Mbed TLS returns a pointer to the internal peer cert chain.
  19406. // WARNING: This pointer is only valid while the session is active.
  19407. // Do not use the certificate after calling free_session().
  19408. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  19409. return const_cast<mbedtls_x509_crt *>(cert);
  19410. }
  19411. inline size_t get_peer_certs(const_session_t session,
  19412. std::vector<cert_t> &certs) {
  19413. certs.clear();
  19414. // Mbed TLS parses the whole received chain into a list headed by the peer
  19415. // certificate, owned by the session like get_peer_cert()'s result
  19416. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  19417. crt && crt->raw.len > 0; crt = crt->next) {
  19418. certs.push_back(static_cast<cert_t>(crt));
  19419. }
  19420. return certs.size();
  19421. }
  19422. inline void free_cert(cert_t cert) {
  19423. // Mbed TLS: every cert_t handed out points into a session's or a context's
  19424. // chain, so there is nothing to free. Callers still call this for the other
  19425. // backends.
  19426. (void)cert;
  19427. }
  19428. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19429. if (!cert || !hostname) { return false; }
  19430. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  19431. std::string host_str(hostname);
  19432. // Check if hostname is an IP address (IPv4 or IPv6)
  19433. unsigned char ip_bytes[16];
  19434. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19435. auto is_ip = ip_len > 0;
  19436. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  19437. // in buf.tag and the raw value in buf.p / buf.len.
  19438. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  19439. if (!san->buf.p || san->buf.len == 0) { continue; }
  19440. const unsigned char *p = san->buf.p;
  19441. size_t len = san->buf.len;
  19442. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  19443. if (is_ip) {
  19444. // For an IP host, only a matching iPAddress SAN of the same family
  19445. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  19446. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  19447. memcmp(p, ip_bytes, ip_len) == 0) {
  19448. return true;
  19449. }
  19450. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  19451. std::string san_name(reinterpret_cast<const char *>(p), len);
  19452. if (detail::match_hostname(san_name, host_str)) { return true; }
  19453. }
  19454. }
  19455. return false;
  19456. }
  19457. inline uint64_t hostname_mismatch_code() {
  19458. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  19459. }
  19460. inline long get_verify_result(const_session_t session) {
  19461. if (!session) { return -1; }
  19462. auto msession =
  19463. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19464. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  19465. // Return 0 (X509_V_OK equivalent) if verification passed
  19466. return flags == 0 ? 0 : static_cast<long>(flags);
  19467. }
  19468. inline std::string get_cert_subject_cn(cert_t cert) {
  19469. if (!cert) return "";
  19470. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19471. // Find the CN in the subject
  19472. const mbedtls_x509_name *name = &x509->subject;
  19473. while (name != nullptr) {
  19474. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  19475. return std::string(reinterpret_cast<const char *>(name->val.p),
  19476. name->val.len);
  19477. }
  19478. name = name->next;
  19479. }
  19480. return "";
  19481. }
  19482. inline std::string get_cert_issuer_name(cert_t cert) {
  19483. if (!cert) return "";
  19484. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19485. // Build a human-readable issuer name string
  19486. char buf[512];
  19487. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  19488. if (ret < 0) return "";
  19489. return std::string(buf);
  19490. }
  19491. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19492. sans.clear();
  19493. if (!cert) return false;
  19494. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19495. // Parse the Subject Alternative Name extension
  19496. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  19497. while (cur != nullptr) {
  19498. if (cur->buf.len > 0) {
  19499. const unsigned char *p = cur->buf.p;
  19500. size_t value_len = cur->buf.len;
  19501. SanEntry entry;
  19502. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  19503. case MBEDTLS_X509_SAN_DNS_NAME:
  19504. entry.type = SanType::DNS;
  19505. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19506. break;
  19507. case MBEDTLS_X509_SAN_IP_ADDRESS:
  19508. entry.type = SanType::IP;
  19509. if (value_len == 4) {
  19510. // IPv4
  19511. char buf[16];
  19512. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  19513. entry.value = buf;
  19514. } else if (value_len == 16) {
  19515. // IPv6
  19516. char buf[64];
  19517. snprintf(buf, sizeof(buf),
  19518. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19519. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19520. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  19521. p[10], p[11], p[12], p[13], p[14], p[15]);
  19522. entry.value = buf;
  19523. }
  19524. break;
  19525. case MBEDTLS_X509_SAN_RFC822_NAME:
  19526. entry.type = SanType::EMAIL;
  19527. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19528. break;
  19529. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  19530. entry.type = SanType::URI;
  19531. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19532. break;
  19533. default: entry.type = SanType::OTHER; break;
  19534. }
  19535. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19536. }
  19537. cur = cur->next;
  19538. }
  19539. return true;
  19540. }
  19541. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19542. time_t &not_after) {
  19543. if (!cert) return false;
  19544. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19545. // Convert mbedtls_x509_time to time_t
  19546. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  19547. struct tm tm_time = {};
  19548. tm_time.tm_year = t.year - 1900;
  19549. tm_time.tm_mon = t.mon - 1;
  19550. tm_time.tm_mday = t.day;
  19551. tm_time.tm_hour = t.hour;
  19552. tm_time.tm_min = t.min;
  19553. tm_time.tm_sec = t.sec;
  19554. #ifdef _WIN32
  19555. return _mkgmtime(&tm_time);
  19556. #else
  19557. return timegm(&tm_time);
  19558. #endif
  19559. };
  19560. not_before = to_time_t(x509->valid_from);
  19561. not_after = to_time_t(x509->valid_to);
  19562. return true;
  19563. }
  19564. inline std::string get_cert_serial(cert_t cert) {
  19565. if (!cert) return "";
  19566. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19567. // Convert serial number to hex string
  19568. std::string result;
  19569. result.reserve(x509->serial.len * 2);
  19570. for (size_t i = 0; i < x509->serial.len; i++) {
  19571. char hex[3];
  19572. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  19573. result += hex;
  19574. }
  19575. return result;
  19576. }
  19577. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19578. if (!cert) return false;
  19579. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  19580. if (!crt->raw.p || crt->raw.len == 0) return false;
  19581. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  19582. return true;
  19583. }
  19584. inline const char *get_sni(const_session_t session) {
  19585. if (!session) return nullptr;
  19586. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  19587. // For server: return SNI received from client during handshake
  19588. if (!msession->sni_hostname.empty()) {
  19589. return msession->sni_hostname.c_str();
  19590. }
  19591. // For client: return the hostname set via set_sni
  19592. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  19593. return nullptr;
  19594. }
  19595. inline uint64_t peek_error() {
  19596. // Mbed TLS doesn't have an error queue, return the last error
  19597. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  19598. }
  19599. inline uint64_t get_error() {
  19600. // Mbed TLS doesn't have an error queue, return and clear the last error
  19601. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  19602. impl::mbedtls_last_error() = 0;
  19603. return err;
  19604. }
  19605. inline std::string error_string(uint64_t code) {
  19606. char buf[256];
  19607. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  19608. return std::string(buf);
  19609. }
  19610. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19611. #ifdef CPPHTTPLIB_MBEDTLS_V4
  19612. // Parsing certificates needs PSA Crypto, and no context may exist yet
  19613. if (!detail::ensure_mbedtls_psa_crypto()) { return nullptr; }
  19614. #endif
  19615. if (!pem) { return nullptr; }
  19616. // mbedtls_x509_crt_parse expects null-terminated PEM
  19617. std::string pem_str(pem, len);
  19618. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  19619. if (!ca_chain) { return nullptr; }
  19620. mbedtls_x509_crt_init(ca_chain);
  19621. auto ret = mbedtls_x509_crt_parse(
  19622. ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  19623. pem_str.size() + 1);
  19624. if (ret != 0) {
  19625. mbedtls_x509_crt_free(ca_chain);
  19626. delete ca_chain;
  19627. return nullptr;
  19628. }
  19629. return static_cast<ca_store_t>(ca_chain);
  19630. }
  19631. inline void free_ca_store(ca_store_t store) {
  19632. if (store) {
  19633. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19634. mbedtls_x509_crt_free(ca_chain);
  19635. delete ca_chain;
  19636. }
  19637. }
  19638. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19639. if (!ctx || !store) { return false; }
  19640. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19641. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19642. // Free existing CA chain
  19643. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  19644. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  19645. // Copy the CA chain (deep copy)
  19646. // Parse from the raw data of the source cert
  19647. mbedtls_x509_crt *src = ca_chain;
  19648. while (src != nullptr) {
  19649. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  19650. src->raw.len);
  19651. if (ret != 0) {
  19652. free_ca_store(store);
  19653. return false;
  19654. }
  19655. src = src->next;
  19656. }
  19657. // This function takes ownership of the store; the chain was deep-copied
  19658. // above, so release the source
  19659. free_ca_store(store);
  19660. // Update the SSL config to use the new CA chain
  19661. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19662. return true;
  19663. }
  19664. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19665. certs.clear();
  19666. if (!ctx) { return 0; }
  19667. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19668. // Owned by the context; see free_cert()
  19669. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  19670. cert = cert->next) {
  19671. certs.push_back(static_cast<cert_t>(cert));
  19672. }
  19673. return certs.size();
  19674. }
  19675. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19676. std::vector<std::string> names;
  19677. if (!ctx) { return names; }
  19678. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19679. // Iterate through the CA chain
  19680. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  19681. while (cert != nullptr && cert->raw.len > 0) {
  19682. char buf[512];
  19683. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  19684. if (ret > 0) { names.push_back(buf); }
  19685. cert = cert->next;
  19686. }
  19687. return names;
  19688. }
  19689. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19690. const char *key_pem, const char *password) {
  19691. if (!ctx || !cert_pem || !key_pem) { return false; }
  19692. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19693. // Parse into new objects first, so that a bad pair leaves the old one in
  19694. // place, and swap them in after; the old ones are freed on the way out.
  19695. mbedtls_x509_crt cert;
  19696. mbedtls_pk_context key;
  19697. mbedtls_x509_crt_init(&cert);
  19698. mbedtls_pk_init(&key);
  19699. auto se = detail::scope_exit([&] {
  19700. mbedtls_x509_crt_free(&cert);
  19701. mbedtls_pk_free(&key);
  19702. });
  19703. // Parse certificate PEM
  19704. int ret = mbedtls_x509_crt_parse(
  19705. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  19706. strlen(cert_pem) + 1);
  19707. if (ret != 0) {
  19708. impl::mbedtls_last_error() = ret;
  19709. return false;
  19710. }
  19711. // Parse private key PEM
  19712. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  19713. ret = mbedtls_pk_parse_key(
  19714. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19715. strlen(key_pem) + 1,
  19716. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19717. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  19718. &mbed_ctx->ctr_drbg);
  19719. #else
  19720. ret = mbedtls_pk_parse_key(
  19721. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19722. strlen(key_pem) + 1,
  19723. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19724. password ? strlen(password) : 0);
  19725. #endif
  19726. if (ret != 0) {
  19727. impl::mbedtls_last_error() = ret;
  19728. return false;
  19729. }
  19730. std::swap(mbed_ctx->own_cert, cert);
  19731. std::swap(mbed_ctx->own_key, key);
  19732. // Configure SSL to use the new certificate and key
  19733. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  19734. &mbed_ctx->own_key);
  19735. if (ret != 0) {
  19736. impl::mbedtls_last_error() = ret;
  19737. return false;
  19738. }
  19739. return true;
  19740. }
  19741. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19742. if (!ctx || !ca_pem) { return false; }
  19743. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19744. // Parse into a new chain first, so that a bad one leaves the old in place
  19745. mbedtls_x509_crt chain;
  19746. mbedtls_x509_crt_init(&chain);
  19747. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  19748. // Parse CA PEM
  19749. int ret = mbedtls_x509_crt_parse(
  19750. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  19751. strlen(ca_pem) + 1);
  19752. if (ret != 0) {
  19753. impl::mbedtls_last_error() = ret;
  19754. return false;
  19755. }
  19756. std::swap(mbed_ctx->ca_chain, chain);
  19757. // Update SSL config to use new CA chain
  19758. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19759. return true;
  19760. }
  19761. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19762. if (!ctx) { return false; }
  19763. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19764. // create_session() hands each session its own copy to run.
  19765. mbed_ctx->verify_callback = std::move(callback);
  19766. impl::apply_verify_mode(*mbed_ctx);
  19767. return true;
  19768. }
  19769. inline long get_verify_error(const_session_t session) {
  19770. if (!session) { return -1; }
  19771. auto *msession =
  19772. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19773. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  19774. }
  19775. inline std::string verify_error_string(long error_code) {
  19776. if (error_code == 0) { return ""; }
  19777. char buf[256];
  19778. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  19779. static_cast<uint32_t>(error_code));
  19780. // Remove trailing newline if present
  19781. std::string result(buf);
  19782. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  19783. result.pop_back();
  19784. }
  19785. return result;
  19786. }
  19787. } // namespace tls
  19788. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  19789. /*
  19790. * Group 10: TLS abstraction layer - wolfSSL backend
  19791. */
  19792. /*
  19793. * wolfSSL Backend Implementation
  19794. */
  19795. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  19796. namespace tls {
  19797. namespace impl {
  19798. // wolfSSL session wrapper
  19799. struct WolfSSLSession {
  19800. WOLFSSL *ssl = nullptr;
  19801. socket_t sock = INVALID_SOCKET;
  19802. std::string hostname; // For client: set via set_sni
  19803. std::string sni_hostname; // For server: received from client via SNI callback
  19804. WolfSSLSession() = default;
  19805. ~WolfSSLSession() {
  19806. if (ssl) { wolfSSL_free(ssl); }
  19807. }
  19808. WolfSSLSession(const WolfSSLSession &) = delete;
  19809. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  19810. };
  19811. // Thread-local error code accessor for wolfSSL
  19812. inline uint64_t &wolfssl_last_error() {
  19813. static thread_local uint64_t err = 0;
  19814. return err;
  19815. }
  19816. // Helper to map wolfSSL error to ErrorCode.
  19817. // ssl_error is the value from wolfSSL_get_error().
  19818. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  19819. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  19820. int &out_errno) {
  19821. switch (ssl_error) {
  19822. case SSL_ERROR_NONE: return ErrorCode::Success;
  19823. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  19824. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  19825. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  19826. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  19827. // EOF without close_notify
  19828. case SOCKET_PEER_CLOSED_E: out_errno = 0; return ErrorCode::SyscallError;
  19829. default:
  19830. if (ssl) {
  19831. // wolfSSL stores the low-level error code as a negative value.
  19832. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  19833. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  19834. if (low_err == DOMAIN_NAME_MISMATCH) {
  19835. return ErrorCode::HostnameMismatch;
  19836. }
  19837. // Check verify result to distinguish cert verification from generic SSL
  19838. // errors.
  19839. long vr = wolfSSL_get_verify_result(ssl);
  19840. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  19841. }
  19842. return ErrorCode::Fatal;
  19843. }
  19844. }
  19845. // WolfSSLContext constructor/destructor implementations
  19846. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  19847. inline WolfSSLContext::~WolfSSLContext() {
  19848. if (ctx) { wolfSSL_CTX_free(ctx); }
  19849. }
  19850. // Thread-local storage for SNI captured during handshake
  19851. inline std::string &wolfssl_pending_sni() {
  19852. static thread_local std::string sni;
  19853. return sni;
  19854. }
  19855. // SNI callback for wolfSSL server to capture client's SNI hostname
  19856. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  19857. (void)ret;
  19858. (void)exArg;
  19859. void *name_data = nullptr;
  19860. unsigned short name_len =
  19861. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  19862. if (name_data && name_len > 0) {
  19863. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  19864. name_len);
  19865. } else {
  19866. wolfssl_pending_sni().clear();
  19867. }
  19868. return 0; // Continue regardless
  19869. }
  19870. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  19871. // runs the verify callback of its own context.
  19872. inline int context_ex_data_index() {
  19873. static const auto index =
  19874. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19875. return index;
  19876. }
  19877. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  19878. // other tls:: function takes.
  19879. inline int session_ex_data_index() {
  19880. static const auto index =
  19881. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19882. return index;
  19883. }
  19884. // A resumed session skips the client's certificate, so a server that checks
  19885. // one would let in a certificate checked against another server's CA, as
  19886. // wolfSSL shares its session cache between contexts, or against a CA since
  19887. // replaced by update_server_client_ca().
  19888. inline void disable_server_resumption(WolfSSLContext *wctx) {
  19889. if (!wctx->is_server) { return; }
  19890. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  19891. #ifdef HAVE_SESSION_TICKET
  19892. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  19893. #endif
  19894. }
  19895. // wolfSSL verify callback wrapper
  19896. inline int wolfssl_verify_callback(int preverify_ok,
  19897. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  19898. // Get the WOLFSSL object from the X509_STORE_CTX
  19899. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  19900. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  19901. if (!ssl) { return preverify_ok; }
  19902. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  19903. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  19904. if (!wctx) { return preverify_ok; }
  19905. std::shared_ptr<VerifyCallback> callback;
  19906. {
  19907. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  19908. callback = wctx->verify_callback;
  19909. }
  19910. if (!callback) { return preverify_ok; }
  19911. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  19912. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  19913. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  19914. VerifyContext verify_ctx;
  19915. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  19916. verify_ctx.cert = static_cast<cert_t>(cert);
  19917. verify_ctx.depth = depth;
  19918. verify_ctx.preverify_ok = (preverify_ok != 0);
  19919. verify_ctx.error_code = static_cast<long>(err);
  19920. if (err != 0) {
  19921. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  19922. } else {
  19923. verify_ctx.error_string = nullptr;
  19924. }
  19925. auto accepted = run_verify_callback(*callback, verify_ctx);
  19926. // A client verifying the server during the handshake, which is what
  19927. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  19928. if (!wolfSSL_is_server(ssl) &&
  19929. (wolfSSL_get_verify_mode(ssl) & WOLFSSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  19930. accepted = accepted && preverify_ok;
  19931. }
  19932. return accepted ? 1 : 0;
  19933. }
  19934. // Sets the verify mode from whether the peer's certificate is required and
  19935. // whether a verify callback is set.
  19936. inline void apply_verify_mode(WolfSSLContext &wctx) {
  19937. auto has_callback = static_cast<bool>(wctx.verify_callback);
  19938. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  19939. auto mode = wctx.verify_client
  19940. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19941. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  19942. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  19943. has_callback ? wolfssl_verify_callback : nullptr);
  19944. }
  19945. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  19946. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  19947. wolfSSL_CTX_set_default_passwd_cb(
  19948. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  19949. auto *pwd = static_cast<const char *>(userdata);
  19950. if (!pwd) return 0;
  19951. auto len = static_cast<int>(strlen(pwd));
  19952. if (len > size) len = size;
  19953. memcpy(buf, pwd, static_cast<size_t>(len));
  19954. return len;
  19955. });
  19956. }
  19957. } // namespace impl
  19958. inline ctx_t create_client_context() {
  19959. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19960. if (!ctx) { return nullptr; }
  19961. ctx->is_server = false;
  19962. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  19963. if (!method) {
  19964. delete ctx;
  19965. return nullptr;
  19966. }
  19967. ctx->ctx = wolfSSL_CTX_new(method);
  19968. if (!ctx->ctx ||
  19969. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19970. WOLFSSL_SUCCESS) {
  19971. delete ctx;
  19972. return nullptr;
  19973. }
  19974. // Default: verify peer certificate
  19975. ctx->verify_client = true;
  19976. impl::apply_verify_mode(*ctx);
  19977. return static_cast<ctx_t>(ctx);
  19978. }
  19979. inline ctx_t create_server_context() {
  19980. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19981. if (!ctx) { return nullptr; }
  19982. ctx->is_server = true;
  19983. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  19984. if (!method) {
  19985. delete ctx;
  19986. return nullptr;
  19987. }
  19988. ctx->ctx = wolfSSL_CTX_new(method);
  19989. if (!ctx->ctx ||
  19990. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19991. WOLFSSL_SUCCESS) {
  19992. delete ctx;
  19993. return nullptr;
  19994. }
  19995. // Default: don't verify client
  19996. impl::apply_verify_mode(*ctx);
  19997. // Enable SNI on server
  19998. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  19999. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  20000. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  20001. return static_cast<ctx_t>(ctx);
  20002. }
  20003. inline void free_context(ctx_t ctx) {
  20004. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  20005. }
  20006. inline bool set_min_version(ctx_t ctx, Version version) {
  20007. if (!ctx) { return false; }
  20008. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20009. int min_ver = WOLFSSL_TLSV1_2;
  20010. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  20011. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  20012. }
  20013. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  20014. if (!ctx || !pem) { return false; }
  20015. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20016. int ret = wolfSSL_CTX_load_verify_buffer(
  20017. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  20018. static_cast<long>(len), SSL_FILETYPE_PEM);
  20019. if (ret != SSL_SUCCESS) {
  20020. impl::wolfssl_last_error() =
  20021. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20022. return false;
  20023. }
  20024. wctx->ca_pem_data_.append(pem, len);
  20025. return true;
  20026. }
  20027. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  20028. if (!ctx || !file_path) { return false; }
  20029. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20030. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  20031. if (ret != SSL_SUCCESS) {
  20032. impl::wolfssl_last_error() =
  20033. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20034. return false;
  20035. }
  20036. return true;
  20037. }
  20038. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  20039. if (!ctx || !dir_path) { return false; }
  20040. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20041. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  20042. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  20043. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  20044. // immediately. Return true even on failure since the CA file may have
  20045. // already been loaded, matching OpenSSL's lenient behavior.
  20046. (void)ret;
  20047. return true;
  20048. }
  20049. inline bool load_system_certs(ctx_t ctx) {
  20050. if (!ctx) { return false; }
  20051. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20052. bool loaded = false;
  20053. #ifdef _WIN32
  20054. loaded = impl::enumerate_windows_system_certs(
  20055. [&](const unsigned char *data, size_t len) {
  20056. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  20057. static_cast<long>(len),
  20058. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  20059. });
  20060. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  20061. loaded = impl::enumerate_macos_keychain_certs(
  20062. [&](const unsigned char *data, size_t len) {
  20063. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  20064. static_cast<long>(len),
  20065. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  20066. });
  20067. #else
  20068. for (auto path = impl::system_ca_paths(); *path; ++path) {
  20069. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  20070. SSL_SUCCESS) {
  20071. loaded = true;
  20072. break;
  20073. }
  20074. }
  20075. if (!loaded) {
  20076. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  20077. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  20078. SSL_SUCCESS) {
  20079. loaded = true;
  20080. break;
  20081. }
  20082. }
  20083. }
  20084. #endif
  20085. return loaded;
  20086. }
  20087. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  20088. const char *password) {
  20089. if (!ctx || !cert || !key) { return false; }
  20090. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20091. // Load certificate
  20092. int ret = wolfSSL_CTX_use_certificate_buffer(
  20093. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  20094. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  20095. if (ret != SSL_SUCCESS) {
  20096. impl::wolfssl_last_error() =
  20097. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20098. return false;
  20099. }
  20100. // Set password callback if password is provided
  20101. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  20102. // Load private key
  20103. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  20104. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  20105. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  20106. if (ret != SSL_SUCCESS) {
  20107. impl::wolfssl_last_error() =
  20108. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20109. return false;
  20110. }
  20111. // Verify that the certificate and private key match
  20112. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  20113. }
  20114. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  20115. const char *key_path, const char *password) {
  20116. if (!ctx || !cert_path || !key_path) { return false; }
  20117. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20118. // Load certificate file
  20119. int ret =
  20120. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  20121. if (ret != SSL_SUCCESS) {
  20122. impl::wolfssl_last_error() =
  20123. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20124. return false;
  20125. }
  20126. // Set password callback if password is provided
  20127. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  20128. // Load private key file
  20129. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  20130. if (ret != SSL_SUCCESS) {
  20131. impl::wolfssl_last_error() =
  20132. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20133. return false;
  20134. }
  20135. // Verify that the certificate and private key match
  20136. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  20137. }
  20138. inline void set_verify_client(ctx_t ctx, bool require) {
  20139. if (!ctx) { return; }
  20140. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20141. wctx->verify_client = require;
  20142. impl::apply_verify_mode(*wctx);
  20143. }
  20144. inline session_t create_session(ctx_t ctx, socket_t sock) {
  20145. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  20146. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20147. auto session = new (std::nothrow) impl::WolfSSLSession();
  20148. if (!session) { return nullptr; }
  20149. session->sock = sock;
  20150. session->ssl = wolfSSL_new(wctx->ctx);
  20151. if (!session->ssl) {
  20152. impl::wolfssl_last_error() =
  20153. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20154. delete session;
  20155. return nullptr;
  20156. }
  20157. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  20158. session) != WOLFSSL_SUCCESS) {
  20159. delete session;
  20160. return nullptr;
  20161. }
  20162. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  20163. return static_cast<session_t>(session);
  20164. }
  20165. inline void free_session(session_t session) {
  20166. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  20167. }
  20168. inline bool set_sni(session_t session, const char *hostname,
  20169. bool verify_hostname) {
  20170. if (!session || !hostname) { return false; }
  20171. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20172. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  20173. static_cast<word16>(strlen(hostname)));
  20174. if (ret != WOLFSSL_SUCCESS) {
  20175. impl::wolfssl_last_error() =
  20176. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20177. return false;
  20178. }
  20179. // wolfSSL_check_domain_name binds identity checking to the handshake,
  20180. // separately from the SNI extension sent above; skip it when hostname
  20181. // verification is disabled so only the chain is checked, matching OpenSSL.
  20182. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  20183. wsession->hostname = hostname;
  20184. return true;
  20185. }
  20186. inline TlsError connect(session_t session) {
  20187. TlsError err;
  20188. if (!session) {
  20189. err.code = ErrorCode::Fatal;
  20190. return err;
  20191. }
  20192. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20193. int ret = wolfSSL_connect(wsession->ssl);
  20194. if (ret == SSL_SUCCESS) {
  20195. err.code = ErrorCode::Success;
  20196. } else {
  20197. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20198. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  20199. err.backend_code = static_cast<uint64_t>(ssl_error);
  20200. impl::wolfssl_last_error() = err.backend_code;
  20201. }
  20202. return err;
  20203. }
  20204. inline TlsError accept(session_t session) {
  20205. TlsError err;
  20206. if (!session) {
  20207. err.code = ErrorCode::Fatal;
  20208. return err;
  20209. }
  20210. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20211. int ret = wolfSSL_accept(wsession->ssl);
  20212. if (ret == SSL_SUCCESS) {
  20213. err.code = ErrorCode::Success;
  20214. // Capture SNI from thread-local storage after successful handshake
  20215. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  20216. impl::wolfssl_pending_sni().clear();
  20217. } else {
  20218. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20219. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  20220. err.backend_code = static_cast<uint64_t>(ssl_error);
  20221. impl::wolfssl_last_error() = err.backend_code;
  20222. }
  20223. return err;
  20224. }
  20225. inline bool connect_nonblocking(session_t session, socket_t sock,
  20226. time_t timeout_sec, time_t timeout_usec,
  20227. TlsError *err,
  20228. const std::function<bool()> &interrupted) {
  20229. if (!session) {
  20230. if (err) { err->code = ErrorCode::Fatal; }
  20231. return false;
  20232. }
  20233. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20234. // Set socket to non-blocking mode
  20235. detail::set_nonblocking(sock, true);
  20236. auto cleanup =
  20237. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  20238. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  20239. int ret;
  20240. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  20241. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20242. if (ssl_error == SSL_ERROR_WANT_READ) {
  20243. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  20244. continue;
  20245. }
  20246. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  20247. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  20248. continue;
  20249. }
  20250. }
  20251. // Error or timeout
  20252. if (err) {
  20253. err->code =
  20254. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  20255. err->backend_code = static_cast<uint64_t>(ssl_error);
  20256. }
  20257. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  20258. return false;
  20259. }
  20260. if (err) { err->code = ErrorCode::Success; }
  20261. return true;
  20262. }
  20263. inline bool accept_nonblocking(session_t session, socket_t sock,
  20264. time_t timeout_sec, time_t timeout_usec,
  20265. TlsError *err) {
  20266. if (!session) {
  20267. if (err) { err->code = ErrorCode::Fatal; }
  20268. return false;
  20269. }
  20270. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20271. // Set socket to non-blocking mode
  20272. detail::set_nonblocking(sock, true);
  20273. auto cleanup =
  20274. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  20275. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  20276. int ret;
  20277. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  20278. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20279. if (ssl_error == SSL_ERROR_WANT_READ) {
  20280. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  20281. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  20282. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  20283. }
  20284. // Error or timeout
  20285. if (err) {
  20286. err->code =
  20287. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  20288. err->backend_code = static_cast<uint64_t>(ssl_error);
  20289. }
  20290. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  20291. return false;
  20292. }
  20293. if (err) { err->code = ErrorCode::Success; }
  20294. // Capture SNI from thread-local storage after successful handshake
  20295. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  20296. impl::wolfssl_pending_sni().clear();
  20297. return true;
  20298. }
  20299. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  20300. if (!session || !buf) {
  20301. err.code = ErrorCode::Fatal;
  20302. return -1;
  20303. }
  20304. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20305. constexpr auto max_len =
  20306. static_cast<size_t>((std::numeric_limits<int>::max)());
  20307. if (len > max_len) { len = max_len; }
  20308. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  20309. if (ret > 0) {
  20310. err.code = ErrorCode::Success;
  20311. return static_cast<ssize_t>(ret);
  20312. }
  20313. // 0 is also returned for EOF without close_notify; get_error tells them apart
  20314. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20315. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  20316. if (err.code == ErrorCode::PeerClosed) { return 0; }
  20317. err.backend_code = static_cast<uint64_t>(ssl_error);
  20318. impl::wolfssl_last_error() = err.backend_code;
  20319. return -1;
  20320. }
  20321. inline ssize_t write(session_t session, const void *buf, size_t len,
  20322. TlsError &err) {
  20323. if (!session || !buf) {
  20324. err.code = ErrorCode::Fatal;
  20325. return -1;
  20326. }
  20327. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20328. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  20329. if (ret > 0) {
  20330. err.code = ErrorCode::Success;
  20331. return static_cast<ssize_t>(ret);
  20332. }
  20333. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  20334. // Treat this as an error (return -1) so callers don't spin in a
  20335. // write loop adding zero to the offset.
  20336. if (ret == 0) {
  20337. err.code = ErrorCode::PeerClosed;
  20338. return -1;
  20339. }
  20340. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20341. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  20342. err.backend_code = static_cast<uint64_t>(ssl_error);
  20343. impl::wolfssl_last_error() = err.backend_code;
  20344. return -1;
  20345. }
  20346. inline int pending(const_session_t session) {
  20347. if (!session) { return 0; }
  20348. auto wsession =
  20349. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20350. return wolfSSL_pending(wsession->ssl);
  20351. }
  20352. inline void shutdown(session_t session, bool graceful) {
  20353. if (!session) { return; }
  20354. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20355. if (graceful) {
  20356. int ret;
  20357. int attempts = 0;
  20358. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  20359. attempts < 3) {
  20360. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20361. if (ssl_error != SSL_ERROR_WANT_READ &&
  20362. ssl_error != SSL_ERROR_WANT_WRITE) {
  20363. break;
  20364. }
  20365. attempts++;
  20366. }
  20367. } else {
  20368. wolfSSL_shutdown(wsession->ssl);
  20369. }
  20370. }
  20371. inline bool is_peer_closed(session_t session, socket_t sock) {
  20372. if (!session || sock == INVALID_SOCKET) { return true; }
  20373. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20374. // Check if there's already decrypted data available
  20375. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  20376. // Set socket to non-blocking to avoid blocking on read
  20377. detail::set_nonblocking(sock, true);
  20378. auto cleanup =
  20379. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  20380. // Peek 1 byte to check connection status without consuming data
  20381. unsigned char buf;
  20382. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  20383. // If we got data or WANT_READ (would block), connection is alive
  20384. if (ret > 0) { return false; }
  20385. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20386. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  20387. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  20388. ret == 0;
  20389. }
  20390. inline cert_t get_peer_cert(const_session_t session) {
  20391. if (!session) { return nullptr; }
  20392. auto wsession =
  20393. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20394. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  20395. return static_cast<cert_t>(cert);
  20396. }
  20397. inline size_t get_peer_certs(const_session_t session,
  20398. std::vector<cert_t> &certs) {
  20399. certs.clear();
  20400. if (!session) { return 0; }
  20401. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  20402. #ifdef SESSION_CERTS
  20403. auto wsession =
  20404. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20405. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  20406. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  20407. for (int i = 0; i < count; i++) {
  20408. auto x509 = wolfSSL_get_chain_X509(chain, i);
  20409. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  20410. }
  20411. #endif
  20412. return certs.size();
  20413. }
  20414. inline void free_cert(cert_t cert) {
  20415. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  20416. }
  20417. inline bool verify_hostname(cert_t cert, const char *hostname) {
  20418. if (!cert || !hostname) { return false; }
  20419. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20420. std::string host_str(hostname);
  20421. // Check if hostname is an IP address (IPv4 or IPv6)
  20422. unsigned char ip_bytes[16];
  20423. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  20424. auto is_ip = ip_len > 0;
  20425. // Check Subject Alternative Names
  20426. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  20427. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  20428. if (san_names) {
  20429. int san_count = wolfSSL_sk_num(san_names);
  20430. for (int i = 0; i < san_count; i++) {
  20431. auto *names =
  20432. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  20433. if (!names) continue;
  20434. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  20435. // DNS name
  20436. unsigned char *dns_name = nullptr;
  20437. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  20438. if (dns_name && dns_len > 0) {
  20439. std::string san_name(reinterpret_cast<char *>(dns_name),
  20440. static_cast<size_t>(dns_len));
  20441. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  20442. if (detail::match_hostname(san_name, host_str)) {
  20443. wolfSSL_sk_free(san_names);
  20444. return true;
  20445. }
  20446. }
  20447. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  20448. // IP address: only an iPAddress SAN of the same family (4 bytes for
  20449. // IPv4, 16 bytes for IPv6) may authenticate the host.
  20450. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  20451. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  20452. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  20453. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  20454. wolfSSL_sk_free(san_names);
  20455. return true;
  20456. }
  20457. }
  20458. }
  20459. wolfSSL_sk_free(san_names);
  20460. }
  20461. return false;
  20462. }
  20463. inline uint64_t hostname_mismatch_code() {
  20464. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  20465. }
  20466. inline long get_verify_result(const_session_t session) {
  20467. if (!session) { return -1; }
  20468. auto wsession =
  20469. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20470. long result = wolfSSL_get_verify_result(wsession->ssl);
  20471. return result;
  20472. }
  20473. inline std::string get_cert_subject_cn(cert_t cert) {
  20474. if (!cert) return "";
  20475. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20476. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  20477. if (!subject) return "";
  20478. char cn[256] = {};
  20479. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  20480. sizeof(cn));
  20481. if (cn_len <= 0) return "";
  20482. return std::string(cn, static_cast<size_t>(cn_len));
  20483. }
  20484. inline std::string get_cert_issuer_name(cert_t cert) {
  20485. if (!cert) return "";
  20486. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20487. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  20488. if (!issuer) return "";
  20489. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  20490. if (!name_str) return "";
  20491. std::string result(name_str);
  20492. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  20493. return result;
  20494. }
  20495. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  20496. sans.clear();
  20497. if (!cert) return false;
  20498. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20499. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  20500. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  20501. if (!san_names) return true; // No SANs is not an error
  20502. int count = wolfSSL_sk_num(san_names);
  20503. for (int i = 0; i < count; i++) {
  20504. auto *name =
  20505. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  20506. if (!name) continue;
  20507. SanEntry entry;
  20508. switch (name->type) {
  20509. case WOLFSSL_GEN_DNS: {
  20510. entry.type = SanType::DNS;
  20511. unsigned char *dns_name = nullptr;
  20512. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  20513. if (dns_name && dns_len > 0) {
  20514. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  20515. static_cast<size_t>(dns_len));
  20516. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  20517. }
  20518. break;
  20519. }
  20520. case WOLFSSL_GEN_IPADD: {
  20521. entry.type = SanType::IP;
  20522. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  20523. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  20524. if (ip_data && ip_len == 4) {
  20525. char buf[16];
  20526. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  20527. ip_data[2], ip_data[3]);
  20528. entry.value = buf;
  20529. } else if (ip_data && ip_len == 16) {
  20530. char buf[64];
  20531. snprintf(buf, sizeof(buf),
  20532. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  20533. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  20534. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  20535. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  20536. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  20537. ip_data[14], ip_data[15]);
  20538. entry.value = buf;
  20539. }
  20540. break;
  20541. }
  20542. case WOLFSSL_GEN_EMAIL:
  20543. entry.type = SanType::EMAIL;
  20544. {
  20545. unsigned char *email = nullptr;
  20546. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  20547. if (email && email_len > 0) {
  20548. entry.value = std::string(reinterpret_cast<char *>(email),
  20549. static_cast<size_t>(email_len));
  20550. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  20551. }
  20552. }
  20553. break;
  20554. case WOLFSSL_GEN_URI:
  20555. entry.type = SanType::URI;
  20556. {
  20557. unsigned char *uri = nullptr;
  20558. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  20559. &uri, name->d.uniformResourceIdentifier);
  20560. if (uri && uri_len > 0) {
  20561. entry.value = std::string(reinterpret_cast<char *>(uri),
  20562. static_cast<size_t>(uri_len));
  20563. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  20564. }
  20565. }
  20566. break;
  20567. default: entry.type = SanType::OTHER; break;
  20568. }
  20569. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  20570. }
  20571. wolfSSL_sk_free(san_names);
  20572. return true;
  20573. }
  20574. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  20575. time_t &not_after) {
  20576. if (!cert) return false;
  20577. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20578. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  20579. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  20580. if (!nb || !na) return false;
  20581. // wolfSSL_ASN1_TIME_to_tm is available
  20582. struct tm tm_nb = {}, tm_na = {};
  20583. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  20584. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  20585. #ifdef _WIN32
  20586. not_before = _mkgmtime(&tm_nb);
  20587. not_after = _mkgmtime(&tm_na);
  20588. #else
  20589. not_before = timegm(&tm_nb);
  20590. not_after = timegm(&tm_na);
  20591. #endif
  20592. return true;
  20593. }
  20594. inline std::string get_cert_serial(cert_t cert) {
  20595. if (!cert) return "";
  20596. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20597. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  20598. if (!serial_asn1) return "";
  20599. // Get the serial number data
  20600. int len = serial_asn1->length;
  20601. unsigned char *data = serial_asn1->data;
  20602. if (!data || len <= 0) return "";
  20603. std::string result;
  20604. result.reserve(static_cast<size_t>(len) * 2);
  20605. for (int i = 0; i < len; i++) {
  20606. char hex[3];
  20607. snprintf(hex, sizeof(hex), "%02X", data[i]);
  20608. result += hex;
  20609. }
  20610. return result;
  20611. }
  20612. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  20613. if (!cert) return false;
  20614. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20615. int der_len = 0;
  20616. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  20617. if (!der_data || der_len <= 0) return false;
  20618. der.assign(der_data, der_data + der_len);
  20619. return true;
  20620. }
  20621. inline const char *get_sni(const_session_t session) {
  20622. if (!session) return nullptr;
  20623. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  20624. // For server: return SNI received from client during handshake
  20625. if (!wsession->sni_hostname.empty()) {
  20626. return wsession->sni_hostname.c_str();
  20627. }
  20628. // For client: return the hostname set via set_sni
  20629. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  20630. return nullptr;
  20631. }
  20632. inline uint64_t peek_error() {
  20633. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20634. }
  20635. inline uint64_t get_error() {
  20636. uint64_t err = impl::wolfssl_last_error();
  20637. impl::wolfssl_last_error() = 0;
  20638. return err;
  20639. }
  20640. inline std::string error_string(uint64_t code) {
  20641. char buf[256];
  20642. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  20643. return std::string(buf);
  20644. }
  20645. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  20646. if (!pem || len == 0) { return nullptr; }
  20647. // Validate by attempting to load into a temporary ctx
  20648. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  20649. if (!tmp_ctx) { return nullptr; }
  20650. int ret = wolfSSL_CTX_load_verify_buffer(
  20651. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  20652. static_cast<long>(len), SSL_FILETYPE_PEM);
  20653. wolfSSL_CTX_free(tmp_ctx);
  20654. if (ret != SSL_SUCCESS) { return nullptr; }
  20655. return static_cast<ca_store_t>(
  20656. new impl::WolfSSLCAStore{std::string(pem, len)});
  20657. }
  20658. inline void free_ca_store(ca_store_t store) {
  20659. delete static_cast<impl::WolfSSLCAStore *>(store);
  20660. }
  20661. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  20662. if (!ctx || !store) { return false; }
  20663. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20664. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  20665. int ret = wolfSSL_CTX_load_verify_buffer(
  20666. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  20667. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  20668. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  20669. // This function takes ownership of the store; the PEM data was copied into
  20670. // the context, so release the source
  20671. free_ca_store(store);
  20672. return ret == SSL_SUCCESS;
  20673. }
  20674. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  20675. certs.clear();
  20676. if (!ctx) { return 0; }
  20677. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20678. if (wctx->ca_pem_data_.empty()) { return 0; }
  20679. const std::string &pem = wctx->ca_pem_data_;
  20680. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20681. const std::string end_marker = "-----END CERTIFICATE-----";
  20682. size_t pos = 0;
  20683. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20684. size_t end_pos = pem.find(end_marker, pos);
  20685. if (end_pos == std::string::npos) { break; }
  20686. end_pos += end_marker.size();
  20687. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20688. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20689. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20690. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20691. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  20692. pos = end_pos;
  20693. }
  20694. return certs.size();
  20695. }
  20696. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  20697. std::vector<std::string> names;
  20698. if (!ctx) { return names; }
  20699. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20700. if (wctx->ca_pem_data_.empty()) { return names; }
  20701. const std::string &pem = wctx->ca_pem_data_;
  20702. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20703. const std::string end_marker = "-----END CERTIFICATE-----";
  20704. size_t pos = 0;
  20705. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20706. size_t end_pos = pem.find(end_marker, pos);
  20707. if (end_pos == std::string::npos) { break; }
  20708. end_pos += end_marker.size();
  20709. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20710. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20711. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20712. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20713. if (x509) {
  20714. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  20715. if (subject) {
  20716. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  20717. if (name_str) {
  20718. names.push_back(name_str);
  20719. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  20720. }
  20721. }
  20722. wolfSSL_X509_free(x509);
  20723. }
  20724. pos = end_pos;
  20725. }
  20726. return names;
  20727. }
  20728. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  20729. const char *key_pem, const char *password) {
  20730. if (!ctx || !cert_pem || !key_pem) { return false; }
  20731. // Try the pair on a scratch context first, so that a bad one leaves the
  20732. // server's certificate and key as they were
  20733. auto tmp = create_server_context();
  20734. if (!tmp) { return false; }
  20735. auto se = detail::scope_exit([&] { free_context(tmp); });
  20736. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  20737. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  20738. }
  20739. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  20740. if (!ctx || !ca_pem) { return false; }
  20741. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20742. // Replace the CAs rather than add to them, as the other backends do, once
  20743. // the new ones are known to load
  20744. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  20745. if (!store) { return false; }
  20746. free_ca_store(store);
  20747. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  20748. wctx->ca_pem_data_.clear();
  20749. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  20750. }
  20751. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  20752. if (!ctx) { return false; }
  20753. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20754. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  20755. : nullptr;
  20756. {
  20757. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  20758. // A handshake running the previous callback keeps it until it returns.
  20759. wctx->verify_callback.swap(stored);
  20760. }
  20761. impl::apply_verify_mode(*wctx);
  20762. return true;
  20763. }
  20764. inline long get_verify_error(const_session_t session) {
  20765. if (!session) { return -1; }
  20766. auto *wsession =
  20767. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20768. return wolfSSL_get_verify_result(wsession->ssl);
  20769. }
  20770. inline std::string verify_error_string(long error_code) {
  20771. if (error_code == 0) { return ""; }
  20772. const char *str =
  20773. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  20774. return str ? std::string(str) : std::string();
  20775. }
  20776. } // namespace tls
  20777. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  20778. // WebSocket implementation
  20779. namespace ws {
  20780. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  20781. bool fin) {
  20782. std::lock_guard<std::mutex> lock(write_mutex_);
  20783. if (closed_) { return false; }
  20784. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  20785. }
  20786. inline ReadResult WebSocket::read(std::string &msg) {
  20787. // Answers a control frame; any other opcode here is a protocol error.
  20788. // Returns false when the connection is done.
  20789. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  20790. switch (op) {
  20791. case Opcode::Ping: {
  20792. std::lock_guard<std::mutex> lock(write_mutex_);
  20793. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  20794. payload.size(), true, !is_server_);
  20795. return true;
  20796. }
  20797. case Opcode::Pong: {
  20798. std::lock_guard<std::mutex> lock(ping_mutex_);
  20799. unacked_pings_ = 0;
  20800. return true;
  20801. }
  20802. case Opcode::Close: {
  20803. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  20804. // malformed, which is answered with a protocol error instead.
  20805. if (closed_.exchange(true)) { return false; }
  20806. auto reply = payload;
  20807. if (!impl::is_valid_close_payload(payload)) {
  20808. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  20809. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  20810. }
  20811. std::lock_guard<std::mutex> lock(write_mutex_);
  20812. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  20813. reply.size(), true, !is_server_);
  20814. return false;
  20815. }
  20816. default: closed_ = true; return false;
  20817. }
  20818. };
  20819. std::unique_lock<std::mutex> read_lock(read_mutex_);
  20820. // A server going down closes the connection rather than wait on it: its
  20821. // listen() waits for this handler to return.
  20822. auto going_away = [&]() -> ReadResult {
  20823. read_lock.unlock();
  20824. close(CloseStatus::GoingAway, "server stopping");
  20825. return Fail;
  20826. };
  20827. // close() ends the read, even while the peer keeps sending fragments
  20828. while (!closed_) {
  20829. Opcode opcode;
  20830. std::string payload;
  20831. bool fin;
  20832. // While a message is assembled, only what is left of the limit, but room
  20833. // for a control frame, which may come between its fragments.
  20834. auto max_len =
  20835. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0 || message_kind_ == Fail
  20836. ? size_t(CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH)
  20837. : (std::max)(size_t(125), CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  20838. message_.size());
  20839. auto r = frames_.read(strm_, opcode, payload, fin, is_server_, max_len);
  20840. if (r != impl::FrameRead::Ok && server_stopping()) { return going_away(); }
  20841. // A timeout leaves what was read of the frame and of the message for the
  20842. // next read(), so the connection is still usable wherever it landed: hand
  20843. // control back without closing it. That is only useful to a caller who
  20844. // asked for the timeout; the compile-time default is a backstop against a
  20845. // peer gone quiet, and elapsing it closes the connection so a plain
  20846. // `while (ws.read(msg))` loop ends. A wait that a pong timeout cut short
  20847. // finds the connection closed.
  20848. if (r == impl::FrameRead::Timeout && read_timeout_set_ && !closed_) {
  20849. return Timeout;
  20850. }
  20851. if (r != impl::FrameRead::Ok) {
  20852. closed_ = true;
  20853. return Fail;
  20854. }
  20855. auto continues = opcode == Opcode::Continuation;
  20856. if (opcode != Opcode::Text && opcode != Opcode::Binary && !continues) {
  20857. if (handle_control(opcode, payload)) { continue; }
  20858. return Fail;
  20859. }
  20860. // RFC 6455 5.4: a message is a Text or Binary frame and the continuation
  20861. // frames after it, with only control frames between them.
  20862. if (continues == (message_kind_ == Fail)) {
  20863. closed_ = true;
  20864. return Fail;
  20865. }
  20866. if (continues) {
  20867. message_ += payload;
  20868. } else {
  20869. message_ = std::move(payload);
  20870. message_kind_ = opcode == Opcode::Text ? Text : Binary;
  20871. }
  20872. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  20873. message_.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  20874. closed_ = true;
  20875. return Fail;
  20876. }
  20877. if (!fin) { continue; }
  20878. auto result = message_kind_;
  20879. msg = std::move(message_);
  20880. message_.clear();
  20881. message_kind_ = Fail;
  20882. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  20883. if (result == Text && !impl::is_valid_utf8(msg)) {
  20884. // close() takes the read lock to wait for the peer's Close reply, so
  20885. // it must not run while this thread still holds it.
  20886. read_lock.unlock();
  20887. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  20888. return Fail;
  20889. }
  20890. return result;
  20891. }
  20892. return Fail;
  20893. }
  20894. inline bool WebSocket::send(const std::string &data) {
  20895. return send_frame(Opcode::Text, data.data(), data.size());
  20896. }
  20897. inline bool WebSocket::send(const char *data, size_t len) {
  20898. return send_frame(Opcode::Binary, data, len);
  20899. }
  20900. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  20901. if (closed_.exchange(true)) { return; }
  20902. ping_cv_.notify_all();
  20903. std::string payload;
  20904. auto code = static_cast<uint16_t>(status);
  20905. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  20906. payload.push_back(static_cast<char>(code & 0xFF));
  20907. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  20908. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  20909. // cut back to a whole UTF-8 character
  20910. auto short_reason = reason.substr(0, 123);
  20911. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  20912. short_reason.pop_back();
  20913. }
  20914. payload += short_reason;
  20915. // A code that may not be sent, such as NoStatus, goes without a payload
  20916. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  20917. {
  20918. std::lock_guard<std::mutex> lock(write_mutex_);
  20919. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  20920. payload.size(), true, !is_server_);
  20921. }
  20922. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  20923. // Close response before closing the TCP connection.
  20924. //
  20925. // Wait only when no other thread is parsing frames. When one is, it is the
  20926. // thread positioned to see the peer's reply, and reading here would take
  20927. // bytes out of the message it is assembling. Bailing out also leaves the
  20928. // stream, including its read timeout, entirely to that thread.
  20929. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  20930. if (!read_lock.owns_lock()) { return; }
  20931. // A max timeout turns a negative (unbounded) read timeout into 0
  20932. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20933. strm_.set_max_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND * 1000);
  20934. // The max timeout cuts a trickled frame short, the deadline a frame flood
  20935. auto deadline =
  20936. detail::deadline_after(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20937. // From where the last read() left the stream, inside a frame as it may be
  20938. Opcode op;
  20939. std::string resp;
  20940. bool fin;
  20941. while (std::chrono::steady_clock::now() < deadline &&
  20942. frames_.read(strm_, op, resp, fin, is_server_, 125) ==
  20943. impl::FrameRead::Ok) {
  20944. if (op == Opcode::Close) { break; }
  20945. }
  20946. }
  20947. inline WebSocket::~WebSocket() {
  20948. {
  20949. std::lock_guard<std::mutex> lock(ping_mutex_);
  20950. closed_ = true;
  20951. }
  20952. ping_cv_.notify_all();
  20953. if (ping_thread_.joinable()) { ping_thread_.join(); }
  20954. // A server's stream outlives this object
  20955. strm_.set_read_interrupt(nullptr);
  20956. }
  20957. // A pong timeout ends a read() blocked on the silent peer, and so does the
  20958. // server stopping: its listen() waits for every handler to return.
  20959. inline void WebSocket::interrupt_reads() {
  20960. auto watches_pongs = ping_interval_sec_ > 0 && max_missed_pongs_ > 0;
  20961. if (!watches_pongs && !server_stopping_) { return; }
  20962. strm_.set_read_interrupt(
  20963. [this] { return pong_timed_out_.load() || server_stopping(); });
  20964. }
  20965. inline void WebSocket::start_heartbeat() {
  20966. if (ping_interval_sec_ <= 0) { return; }
  20967. ping_thread_ = std::thread([this]() {
  20968. std::unique_lock<std::mutex> lock(ping_mutex_);
  20969. // The predicate keeps a spurious wakeup from sending a ping early
  20970. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  20971. [this]() { return closed_.load(); })) {
  20972. // If the peer has failed to respond to the previous pings, give up.
  20973. // RFC 6455 does not define a pong-timeout mechanism; this is an
  20974. // opt-in liveness check controlled by max_missed_pongs_.
  20975. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  20976. lock.unlock();
  20977. close(CloseStatus::GoingAway, "pong timeout");
  20978. pong_timed_out_ = true;
  20979. return;
  20980. }
  20981. lock.unlock();
  20982. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  20983. lock.lock();
  20984. closed_ = true;
  20985. break;
  20986. }
  20987. lock.lock();
  20988. unacked_pings_++;
  20989. }
  20990. });
  20991. }
  20992. inline const Request &WebSocket::request() const { return req_; }
  20993. inline bool WebSocket::is_open() const { return !closed_; }
  20994. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  20995. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  20996. // poll(), where 0 would instead mean "return immediately", so hand it the
  20997. // negative poll uses for an unbounded wait.
  20998. if (sec == 0 && usec == 0) { sec = -1; }
  20999. strm_.set_read_timeout(sec, usec);
  21000. read_timeout_set_ = true;
  21001. }
  21002. // WebSocketClient implementation
  21003. inline WebSocketClient::WebSocketClient(
  21004. const std::string &scheme_host_port_path, const Headers &headers)
  21005. : headers_(headers) {
  21006. detail::UrlComponents uc;
  21007. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  21008. !uc.host.empty() && !uc.path.empty()) {
  21009. auto &scheme = uc.scheme;
  21010. #ifdef CPPHTTPLIB_SSL_ENABLED
  21011. if (scheme != "ws" && scheme != "wss") {
  21012. #else
  21013. if (scheme != "ws") {
  21014. #endif
  21015. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  21016. std::string msg = "'" + scheme + "' scheme is not supported.";
  21017. throw std::invalid_argument(msg);
  21018. #endif
  21019. return;
  21020. }
  21021. auto is_ssl = scheme == "wss";
  21022. host_ = std::move(uc.host);
  21023. port_ = is_ssl ? 443 : 80;
  21024. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  21025. path_ = std::move(uc.path);
  21026. if (!uc.query.empty()) { path_ += uc.query; }
  21027. #ifdef CPPHTTPLIB_SSL_ENABLED
  21028. is_ssl_ = is_ssl;
  21029. if (is_ssl_) {
  21030. // The context lives as long as the client so that CA configuration
  21031. // survives reconnects; sessions are created per connection.
  21032. tls_ctx_ = tls::create_client_context();
  21033. if (!tls_ctx_) { return; }
  21034. }
  21035. #else
  21036. if (is_ssl) { return; }
  21037. #endif
  21038. is_valid_ = true;
  21039. }
  21040. }
  21041. #ifdef CPPHTTPLIB_SSL_ENABLED
  21042. inline WebSocketClient::WebSocketClient(
  21043. const std::string &scheme_host_port_path, const PemMemory &pem,
  21044. const Headers &headers)
  21045. : WebSocketClient(scheme_host_port_path, headers) {
  21046. // For ws:// URLs the client certificate is silently ignored, consistent
  21047. // with the TLS-only setters such as set_ca_cert_path().
  21048. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  21049. std::string cert_buf, key_buf;
  21050. if (!tls::set_client_cert_pem(
  21051. tls_ctx_,
  21052. detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  21053. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  21054. pem.private_key_password)) {
  21055. tls::free_context(tls_ctx_);
  21056. tls_ctx_ = nullptr;
  21057. is_valid_ = false;
  21058. }
  21059. }
  21060. }
  21061. #endif
  21062. inline WebSocketClient::~WebSocketClient() {
  21063. shutdown_and_close();
  21064. #ifdef CPPHTTPLIB_SSL_ENABLED
  21065. if (tls_ctx_) {
  21066. tls::free_context(tls_ctx_);
  21067. tls_ctx_ = nullptr;
  21068. }
  21069. #endif
  21070. }
  21071. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  21072. inline void WebSocketClient::shutdown_and_close() {
  21073. // Send the close frame while the TLS session is still alive: ws_ holds an
  21074. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  21075. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  21076. if (ws_ && ws_->is_open()) { ws_->close(); }
  21077. ws_.reset();
  21078. #ifdef CPPHTTPLIB_SSL_ENABLED
  21079. if (is_ssl_) {
  21080. if (tls_session_) {
  21081. tls::shutdown(tls_session_, true);
  21082. tls::free_session(tls_session_);
  21083. tls_session_ = nullptr;
  21084. }
  21085. }
  21086. #endif
  21087. if (sock_ != INVALID_SOCKET) {
  21088. detail::shutdown_socket(sock_);
  21089. detail::close_socket(sock_);
  21090. sock_ = INVALID_SOCKET;
  21091. }
  21092. }
  21093. // The handshakes belong to establishing the connection, so an unset read
  21094. // timeout leaves them bounded by the connection timeout instead of forever.
  21095. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  21096. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  21097. return {connection_timeout_sec_, connection_timeout_usec_};
  21098. }
  21099. return {read_timeout_sec_, read_timeout_usec_};
  21100. }
  21101. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  21102. Error &error, int &ssl_error,
  21103. uint64_t &ssl_backend_error) {
  21104. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  21105. // The streams wait with poll(), where 0 instead means "return immediately",
  21106. // so they are given the negative poll uses for an unbounded wait.
  21107. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  21108. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  21109. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  21110. #ifdef CPPHTTPLIB_SSL_ENABLED
  21111. if (is_ssl_) {
  21112. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  21113. // is not safe to call concurrently on one client to begin with, since
  21114. // nothing else here is guarded either.
  21115. if (server_certificate_verification_ && !certs_loaded_) {
  21116. uint64_t backend_error = 0;
  21117. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  21118. ca_cert_dir_path_, custom_ca_loaded_,
  21119. system_ca_mode_, backend_error);
  21120. certs_loaded_ = true;
  21121. }
  21122. detail::ClientTlsSessionOptions options;
  21123. options.server_hostname_verification = server_hostname_verification_;
  21124. options.session_verifier = session_verifier_;
  21125. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  21126. options.windows_cert_verification = detail::use_windows_cert_verification(
  21127. enable_windows_cert_verification_, ca_cert_file_path_,
  21128. ca_cert_dir_path_, custom_ca_loaded_, system_ca_mode_);
  21129. options.server_certificate_verifier_set = server_certificate_verifier_set_;
  21130. #endif
  21131. auto timeout = handshake_timeout();
  21132. detail::ClientTlsSessionError tls_error;
  21133. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  21134. server_certificate_verification_,
  21135. timeout.first, timeout.second,
  21136. &tls_error, options)) {
  21137. error = tls_error.error;
  21138. ssl_error = tls_error.ssl_error;
  21139. ssl_backend_error = tls_error.backend_error;
  21140. return false;
  21141. }
  21142. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  21143. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  21144. write_timeout_usec_));
  21145. return true;
  21146. }
  21147. #else
  21148. (void)error;
  21149. (void)ssl_error;
  21150. (void)ssl_backend_error;
  21151. #endif
  21152. strm = std::unique_ptr<Stream>(
  21153. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  21154. write_timeout_sec_, write_timeout_usec_));
  21155. return true;
  21156. }
  21157. inline void WebSocketClient::prepare_default_headers(Request &req) {
  21158. #ifdef CPPHTTPLIB_SSL_ENABLED
  21159. auto is_ssl = is_ssl_;
  21160. #else
  21161. auto is_ssl = false;
  21162. #endif
  21163. if (!req.has_header("Host")) {
  21164. req.headers.emplace("Host", detail::make_default_host_header_value(
  21165. host_, port_, is_ssl, address_family_));
  21166. }
  21167. detail::add_default_user_agent_header(req);
  21168. detail::add_authorization_header(req, basic_auth_username_,
  21169. basic_auth_password_,
  21170. bearer_token_auth_token_, false);
  21171. }
  21172. inline Result WebSocketClient::connect() {
  21173. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  21174. shutdown_and_close();
  21175. auto error = Error::Success;
  21176. if (!create_and_connect_socket(error)) {
  21177. return Result{error, -1, Headers{}};
  21178. }
  21179. if (is_proxy_enabled()) {
  21180. Response proxy_res;
  21181. if (!connect_with_proxy(proxy_res, error)) {
  21182. shutdown_and_close();
  21183. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  21184. }
  21185. }
  21186. std::unique_ptr<Stream> strm;
  21187. auto stream_error = Error::SSLConnection;
  21188. int ssl_error = 0;
  21189. uint64_t ssl_backend_error = 0;
  21190. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  21191. shutdown_and_close();
  21192. #ifdef CPPHTTPLIB_SSL_ENABLED
  21193. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  21194. #else
  21195. return Result{stream_error, -1, Headers{}};
  21196. #endif
  21197. }
  21198. Request req;
  21199. req.method = "GET";
  21200. req.path = path_;
  21201. req.headers = headers_;
  21202. prepare_default_headers(req);
  21203. detail::WebSocketUpgradeResponse upgrade;
  21204. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  21205. shutdown_and_close();
  21206. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  21207. }
  21208. subprotocol_ = std::move(upgrade.selected_subprotocol);
  21209. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  21210. websocket_ping_interval_sec_,
  21211. websocket_max_missed_pongs_));
  21212. // The stream was created with the timeout already; tell the WebSocket
  21213. // whether it came from the caller, so read() knows to report it as Timeout.
  21214. ws_->read_timeout_set_ = read_timeout_set_;
  21215. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  21216. }
  21217. inline ReadResult WebSocketClient::read(std::string &msg) {
  21218. if (!ws_) { return Fail; }
  21219. return ws_->read(msg);
  21220. }
  21221. inline bool WebSocketClient::send(const std::string &data) {
  21222. if (!ws_) { return false; }
  21223. return ws_->send(data);
  21224. }
  21225. inline bool WebSocketClient::send(const char *data, size_t len) {
  21226. if (!ws_) { return false; }
  21227. return ws_->send(data, len);
  21228. }
  21229. inline void WebSocketClient::close(CloseStatus status,
  21230. const std::string &reason) {
  21231. if (ws_) { ws_->close(status, reason); }
  21232. }
  21233. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  21234. inline const std::string &WebSocketClient::subprotocol() const {
  21235. return subprotocol_;
  21236. }
  21237. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  21238. read_timeout_sec_ = sec;
  21239. read_timeout_usec_ = usec;
  21240. read_timeout_set_ = true;
  21241. // The members above only seed the next connect(); read() consults the
  21242. // stream, so an already-open connection has to be told directly.
  21243. if (ws_) { ws_->set_read_timeout(sec, usec); }
  21244. }
  21245. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  21246. write_timeout_sec_ = sec;
  21247. write_timeout_usec_ = usec;
  21248. }
  21249. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  21250. websocket_ping_interval_sec_ = sec;
  21251. }
  21252. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  21253. websocket_max_missed_pongs_ = count;
  21254. }
  21255. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  21256. inline void WebSocketClient::set_address_family(int family) {
  21257. address_family_ = family;
  21258. }
  21259. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  21260. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  21261. socket_options_ = std::move(socket_options);
  21262. }
  21263. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  21264. connection_timeout_sec_ = sec;
  21265. connection_timeout_usec_ = usec;
  21266. }
  21267. inline void WebSocketClient::set_interface(const std::string &intf) {
  21268. interface_ = intf;
  21269. }
  21270. inline void WebSocketClient::set_hostname_addr_map(
  21271. std::map<std::string, std::string> addr_map) {
  21272. set_direct_hostname_addr_map(std::move(addr_map));
  21273. }
  21274. inline void WebSocketClient::set_direct_hostname_addr_map(
  21275. std::map<std::string, std::string> addr_map) {
  21276. addr_map_ = std::move(addr_map);
  21277. }
  21278. inline void WebSocketClient::set_tunnel_hostname_addr_map(
  21279. std::map<std::string, std::string> addr_map) {
  21280. tunnel_addr_map_ = std::move(addr_map);
  21281. }
  21282. inline bool WebSocketClient::is_proxy_enabled() const {
  21283. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  21284. if (no_proxy_entries_.empty()) { return true; }
  21285. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  21286. no_proxy_entries_);
  21287. }
  21288. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  21289. std::string connect_host;
  21290. std::string ip;
  21291. auto port = port_;
  21292. if (is_proxy_enabled()) {
  21293. connect_host = proxy_host_;
  21294. port = proxy_port_;
  21295. } else {
  21296. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  21297. }
  21298. sock_ = detail::create_client_socket(
  21299. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  21300. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  21301. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  21302. write_timeout_usec_, interface_, error);
  21303. if (sock_ != INVALID_SOCKET) { return true; }
  21304. if (error == Error::Success) { error = Error::Connection; }
  21305. return false;
  21306. }
  21307. inline bool WebSocketClient::send_proxy_connect(Request &req,
  21308. Response &proxy_res,
  21309. Error &error) {
  21310. auto timeout = handshake_timeout();
  21311. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  21312. write_timeout_sec_, write_timeout_usec_);
  21313. if (!detail::write_request_head(strm, req, error)) { return false; }
  21314. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  21315. error = Error::Read;
  21316. return false;
  21317. }
  21318. return true;
  21319. }
  21320. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  21321. // forward an Upgrade request.
  21322. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  21323. Error &error) {
  21324. Request req;
  21325. req.method = "CONNECT";
  21326. req.path =
  21327. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  21328. req.headers.emplace("Host", req.path);
  21329. detail::add_default_user_agent_header(req);
  21330. detail::add_authorization_header(req, proxy_basic_auth_username_,
  21331. proxy_basic_auth_password_,
  21332. proxy_bearer_token_auth_token_, true);
  21333. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  21334. #ifdef CPPHTTPLIB_SSL_ENABLED
  21335. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  21336. std::map<std::string, std::string> auth;
  21337. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  21338. !proxy_digest_auth_username_.empty() &&
  21339. !proxy_digest_auth_password_.empty() &&
  21340. detail::parse_www_authenticate(proxy_res, auth, true)) {
  21341. proxy_res = Response();
  21342. shutdown_and_close();
  21343. if (!create_and_connect_socket(error)) { return false; }
  21344. req.headers.erase("Proxy-Authorization");
  21345. req.headers.insert(detail::make_digest_authentication_header(
  21346. req, req.path, auth, 1, detail::random_string(10),
  21347. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  21348. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  21349. }
  21350. #endif
  21351. if (proxy_res.status != StatusCode::OK_200) {
  21352. error = Error::ProxyConnection;
  21353. return false;
  21354. }
  21355. return true;
  21356. }
  21357. inline void WebSocketClient::set_basic_auth(const std::string &username,
  21358. const std::string &password) {
  21359. basic_auth_username_ = username;
  21360. basic_auth_password_ = password;
  21361. }
  21362. inline void WebSocketClient::set_bearer_token_auth(const std::string &token) {
  21363. bearer_token_auth_token_ = token;
  21364. }
  21365. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  21366. proxy_host_ = host;
  21367. proxy_port_ = port;
  21368. }
  21369. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  21370. const std::string &password) {
  21371. proxy_basic_auth_username_ = username;
  21372. proxy_basic_auth_password_ = password;
  21373. }
  21374. inline void
  21375. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  21376. proxy_bearer_token_auth_token_ = token;
  21377. }
  21378. inline void
  21379. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  21380. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  21381. }
  21382. #ifdef CPPHTTPLIB_SSL_ENABLED
  21383. inline void
  21384. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  21385. const std::string &ca_cert_dir_path) {
  21386. ca_cert_file_path_ = ca_cert_file_path;
  21387. ca_cert_dir_path_ = ca_cert_dir_path;
  21388. }
  21389. inline void
  21390. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  21391. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  21392. server_certificate_verifier_set_ = static_cast<bool>(verifier);
  21393. #endif
  21394. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  21395. }
  21396. inline void WebSocketClient::set_session_verifier(
  21397. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  21398. session_verifier_ = std::move(verifier);
  21399. }
  21400. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  21401. if (store && tls_ctx_) {
  21402. // set_ca_store takes ownership of store
  21403. tls::set_ca_store(tls_ctx_, store);
  21404. } else if (store) {
  21405. tls::free_ca_store(store);
  21406. }
  21407. custom_ca_loaded_ = true;
  21408. }
  21409. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  21410. std::size_t size) {
  21411. if (tls_ctx_ && ca_cert && size > 0) {
  21412. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  21413. }
  21414. custom_ca_loaded_ = true;
  21415. }
  21416. inline void
  21417. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  21418. server_certificate_verification_ = enabled;
  21419. }
  21420. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  21421. server_hostname_verification_ = enabled;
  21422. }
  21423. inline void WebSocketClient::enable_system_ca(bool enabled) {
  21424. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  21425. }
  21426. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  21427. inline void
  21428. WebSocketClient::enable_windows_certificate_verification(bool enabled) {
  21429. enable_windows_cert_verification_ = enabled;
  21430. }
  21431. #endif
  21432. inline void
  21433. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  21434. const std::string &password) {
  21435. proxy_digest_auth_username_ = username;
  21436. proxy_digest_auth_password_ = password;
  21437. }
  21438. #endif // CPPHTTPLIB_SSL_ENABLED
  21439. } // namespace ws
  21440. // ----------------------------------------------------------------------------
  21441. } // namespace httplib
  21442. #endif // CPPHTTPLIB_HTTPLIB_H