httplib.h 849 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005240062400724008240092401024011240122401324014240152401624017240182401924020240212402224023240242402524026240272402824029240302403124032240332403424035240362403724038240392404024041240422404324044240452404624047240482404924050240512405224053240542405524056240572405824059240602406124062240632406424065240662406724068240692407024071240722407324074240752407624077240782407924080240812408224083240842408524086240872408824089240902409124092240932409424095240962409724098240992410024101241022410324104241052410624107241082410924110241112411224113241142411524116241172411824119241202412124122241232412424125241262412724128241292413024131241322413324134241352413624137241382413924140241412414224143241442414524146241472414824149241502415124152241532415424155241562415724158241592416024161241622416324164241652416624167241682416924170241712417224173241742417524176241772417824179241802418124182241832418424185241862418724188241892419024191241922419324194241952419624197241982419924200242012420224203242042420524206242072420824209242102421124212242132421424215242162421724218242192422024221242222422324224242252422624227242282422924230242312423224233242342423524236242372423824239242402424124242242432424424245242462424724248242492425024251242522425324254242552425624257242582425924260242612426224263242642426524266242672426824269242702427124272242732427424275242762427724278242792428024281242822428324284242852428624287242882428924290242912429224293242942429524296242972429824299243002430124302243032430424305243062430724308243092431024311243122431324314243152431624317243182431924320243212432224323243242432524326243272432824329243302433124332243332433424335243362433724338243392434024341243422434324344243452434624347243482434924350243512435224353243542435524356243572435824359243602436124362243632436424365243662436724368243692437024371243722437324374243752437624377243782437924380243812438224383243842438524386243872438824389243902439124392243932439424395243962439724398243992440024401244022440324404244052440624407244082440924410244112441224413244142441524416244172441824419244202442124422244232442424425244262442724428244292443024431244322443324434244352443624437244382443924440244412444224443244442444524446244472444824449244502445124452244532445424455244562445724458244592446024461244622446324464244652446624467244682446924470244712447224473244742447524476244772447824479244802448124482244832448424485244862448724488244892449024491244922449324494244952449624497244982449924500245012450224503245042450524506245072450824509245102451124512245132451424515245162451724518245192452024521245222452324524245252452624527245282452924530245312453224533245342453524536245372453824539245402454124542245432454424545245462454724548245492455024551245522455324554245552455624557245582455924560245612456224563
  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. /*
  235. * Headers
  236. */
  237. #ifdef _WIN32
  238. #ifndef _CRT_SECURE_NO_WARNINGS
  239. #define _CRT_SECURE_NO_WARNINGS
  240. #endif //_CRT_SECURE_NO_WARNINGS
  241. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  242. #define _CRT_NONSTDC_NO_DEPRECATE
  243. #endif //_CRT_NONSTDC_NO_DEPRECATE
  244. #if defined(_MSC_VER)
  245. #if _MSC_VER < 1900
  246. #error Sorry, Visual Studio versions prior to 2015 are not supported
  247. #endif
  248. #pragma comment(lib, "ws2_32.lib")
  249. #ifndef _SSIZE_T_DEFINED
  250. using ssize_t = __int64;
  251. #define _SSIZE_T_DEFINED
  252. #endif
  253. #endif // _MSC_VER
  254. #ifndef S_ISREG
  255. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  256. #endif // S_ISREG
  257. #ifndef S_ISDIR
  258. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  259. #endif // S_ISDIR
  260. #ifndef NOMINMAX
  261. #define NOMINMAX
  262. #endif // NOMINMAX
  263. #include <io.h>
  264. #include <winsock2.h>
  265. #include <ws2tcpip.h>
  266. #if defined(__has_include)
  267. #if __has_include(<afunix.h>)
  268. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  269. #include <afunix.h>
  270. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  271. #endif
  272. #endif
  273. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  274. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  275. #endif
  276. using nfds_t = unsigned long;
  277. using socket_t = SOCKET;
  278. using socklen_t = int;
  279. #else // not _WIN32
  280. #include <arpa/inet.h>
  281. #if !defined(_AIX) && !defined(__MVS__)
  282. #include <ifaddrs.h>
  283. #endif
  284. #ifdef __MVS__
  285. #include <strings.h>
  286. #ifndef NI_MAXHOST
  287. #define NI_MAXHOST 1025
  288. #endif
  289. #endif
  290. #include <net/if.h>
  291. #include <netdb.h>
  292. #include <netinet/in.h>
  293. #ifdef __linux__
  294. #include <resolv.h>
  295. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  296. #endif
  297. #include <csignal>
  298. #include <netinet/tcp.h>
  299. #include <poll.h>
  300. #include <pthread.h>
  301. #include <sys/socket.h>
  302. #include <sys/un.h>
  303. #include <unistd.h>
  304. using socket_t = int;
  305. #ifndef INVALID_SOCKET
  306. #define INVALID_SOCKET (-1)
  307. #endif
  308. #endif //_WIN32
  309. #if defined(__APPLE__)
  310. #include <TargetConditionals.h>
  311. #endif
  312. #include <algorithm>
  313. #include <array>
  314. #include <atomic>
  315. #include <cassert>
  316. #include <chrono>
  317. #include <climits>
  318. #include <condition_variable>
  319. #include <cstdlib>
  320. #include <cstring>
  321. #include <errno.h>
  322. #include <exception>
  323. #include <fcntl.h>
  324. #include <fstream>
  325. #include <functional>
  326. #include <iomanip>
  327. #include <iostream>
  328. #include <iterator>
  329. #include <list>
  330. #include <map>
  331. #include <memory>
  332. #include <mutex>
  333. #include <random>
  334. #include <regex>
  335. #include <set>
  336. #include <sstream>
  337. #include <string>
  338. #include <sys/stat.h>
  339. #include <system_error>
  340. #include <thread>
  341. #include <type_traits>
  342. #include <unordered_map>
  343. #include <unordered_set>
  344. #include <utility>
  345. #include <vector>
  346. // On macOS with a TLS backend, enable Keychain root certificates by default
  347. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  348. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  349. // only; on those platforms the user must provide a CA bundle explicitly.
  350. #if defined(__APPLE__) && defined(__clang__) && \
  351. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  352. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  353. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  354. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  355. #if TARGET_OS_OSX
  356. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  357. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  358. #endif
  359. #endif
  360. #endif
  361. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  362. defined(__APPLE__) && !TARGET_OS_OSX
  363. #error \
  364. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  365. #endif
  366. // On Windows, enable Schannel certificate verification by default
  367. // unless the user explicitly opts out.
  368. #if defined(_WIN32) && \
  369. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  370. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  371. #endif
  372. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  373. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  374. #if TARGET_OS_MAC && defined(__clang__)
  375. #include <CFNetwork/CFHost.h>
  376. #include <CoreFoundation/CoreFoundation.h>
  377. #endif
  378. #endif
  379. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  380. #ifdef _WIN32
  381. #include <wincrypt.h>
  382. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  383. // used
  384. #undef X509_NAME
  385. #undef X509_CERT_PAIR
  386. #undef X509_EXTENSIONS
  387. #undef PKCS7_SIGNER_INFO
  388. #ifdef _MSC_VER
  389. #pragma comment(lib, "crypt32.lib")
  390. #endif
  391. #endif // _WIN32
  392. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  393. #if TARGET_OS_OSX
  394. #include <Security/Security.h>
  395. #endif
  396. #endif
  397. #include <openssl/err.h>
  398. #include <openssl/evp.h>
  399. #include <openssl/rand.h>
  400. #include <openssl/ssl.h>
  401. #include <openssl/x509v3.h>
  402. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  403. #include <openssl/applink.c>
  404. #endif
  405. #include <iostream>
  406. #include <sstream>
  407. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  408. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  409. #error Please use OpenSSL or a current version of BoringSSL
  410. #endif
  411. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  412. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  413. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  414. #endif
  415. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  416. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  417. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  418. // in with this first include group so the version gating below can use it.
  419. #include <mbedtls/error.h>
  420. #include <mbedtls/net_sockets.h>
  421. #include <mbedtls/oid.h>
  422. #include <mbedtls/pk.h>
  423. #include <mbedtls/ssl.h>
  424. #include <mbedtls/version.h>
  425. #include <mbedtls/x509_crt.h>
  426. #if MBEDTLS_VERSION_MAJOR >= 4
  427. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  428. #include <psa/crypto.h>
  429. #else
  430. #include <mbedtls/ctr_drbg.h>
  431. #include <mbedtls/entropy.h>
  432. #include <mbedtls/md5.h>
  433. #include <mbedtls/sha1.h>
  434. #include <mbedtls/sha256.h>
  435. #include <mbedtls/sha512.h>
  436. #endif
  437. #ifdef _WIN32
  438. #include <wincrypt.h>
  439. #ifdef _MSC_VER
  440. #pragma comment(lib, "crypt32.lib")
  441. #endif
  442. #endif // _WIN32
  443. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  444. #if TARGET_OS_OSX
  445. #include <Security/Security.h>
  446. #endif
  447. #endif
  448. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  449. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  450. #if MBEDTLS_VERSION_MAJOR >= 4
  451. #define CPPHTTPLIB_MBEDTLS_V4
  452. #endif
  453. #if MBEDTLS_VERSION_MAJOR >= 3
  454. #define CPPHTTPLIB_MBEDTLS_V3
  455. #endif
  456. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  457. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  458. #include <wolfssl/options.h>
  459. #include <wolfssl/openssl/x509v3.h>
  460. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  461. #ifndef WOLFSSL_GEN_EMAIL
  462. #define WOLFSSL_GEN_EMAIL 1
  463. #endif
  464. #ifndef WOLFSSL_GEN_DNS
  465. #define WOLFSSL_GEN_DNS 2
  466. #endif
  467. #ifndef WOLFSSL_GEN_URI
  468. #define WOLFSSL_GEN_URI 6
  469. #endif
  470. #ifndef WOLFSSL_GEN_IPADD
  471. #define WOLFSSL_GEN_IPADD 7
  472. #endif
  473. #include <wolfssl/ssl.h>
  474. #include <wolfssl/wolfcrypt/hash.h>
  475. #include <wolfssl/wolfcrypt/md5.h>
  476. #include <wolfssl/wolfcrypt/sha256.h>
  477. #include <wolfssl/wolfcrypt/sha512.h>
  478. #ifdef _WIN32
  479. #include <wincrypt.h>
  480. #ifdef _MSC_VER
  481. #pragma comment(lib, "crypt32.lib")
  482. #endif
  483. #endif // _WIN32
  484. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  485. #if TARGET_OS_OSX
  486. #include <Security/Security.h>
  487. #endif
  488. #endif
  489. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  490. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  491. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  492. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  493. #define CPPHTTPLIB_SSL_ENABLED
  494. #endif
  495. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  496. #include <zlib.h>
  497. #endif
  498. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  499. #include <brotli/decode.h>
  500. #include <brotli/encode.h>
  501. #endif
  502. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  503. #include <zstd.h>
  504. #endif
  505. /*
  506. * Declaration
  507. */
  508. namespace httplib {
  509. namespace ws {
  510. class WebSocket;
  511. } // namespace ws
  512. namespace sse {
  513. class SSEClient;
  514. } // namespace sse
  515. namespace detail {
  516. /*
  517. * Backport std::make_unique from C++14.
  518. *
  519. * NOTE: This code came up with the following stackoverflow post:
  520. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  521. *
  522. */
  523. template <class T, class... Args>
  524. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  525. make_unique(Args &&...args) {
  526. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  527. }
  528. template <class T>
  529. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  530. make_unique(std::size_t n) {
  531. typedef typename std::remove_extent<T>::type RT;
  532. return std::unique_ptr<T>(new RT[n]);
  533. }
  534. // Locale-independent ASCII character classification. The <cctype>
  535. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  536. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  537. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  538. // classified without regard to the locale.
  539. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  540. inline bool is_ascii_alpha(char c) {
  541. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  542. }
  543. inline bool is_ascii_alnum(char c) {
  544. return is_ascii_digit(c) || is_ascii_alpha(c);
  545. }
  546. namespace case_ignore {
  547. inline unsigned char to_lower(int c) {
  548. const static unsigned char table[256] = {
  549. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  550. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  551. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  552. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  553. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  554. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  555. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  556. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  557. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  558. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  559. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  560. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  561. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  562. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  563. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  564. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  565. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  566. 255,
  567. };
  568. return table[(unsigned char)(char)c];
  569. }
  570. inline std::string to_lower(const std::string &s) {
  571. std::string result = s;
  572. std::transform(
  573. result.begin(), result.end(), result.begin(),
  574. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  575. return result;
  576. }
  577. inline bool equal(const std::string &a, const std::string &b) {
  578. return a.size() == b.size() &&
  579. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  580. return to_lower(ca) == to_lower(cb);
  581. });
  582. }
  583. // For a literal, without building a std::string from it.
  584. template <size_t N>
  585. inline bool equal(const std::string &a, const char (&b)[N]) {
  586. return a.size() == N - 1 &&
  587. std::equal(a.begin(), a.end(), b, [](char ca, char cb) {
  588. return to_lower(ca) == to_lower(cb);
  589. });
  590. }
  591. struct equal_to {
  592. bool operator()(const std::string &a, const std::string &b) const {
  593. return equal(a, b);
  594. }
  595. };
  596. struct hash {
  597. size_t operator()(const std::string &key) const {
  598. size_t h = 0;
  599. for (auto c : key) {
  600. // Unsets the 6 high bits of h, therefore no overflow happens
  601. h = (((std::numeric_limits<size_t>::max)() >> 6) & h * 33) ^
  602. static_cast<unsigned char>(to_lower(c));
  603. }
  604. return h;
  605. }
  606. };
  607. template <typename T>
  608. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  609. detail::case_ignore::equal_to>;
  610. } // namespace case_ignore
  611. // This is based on
  612. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  613. struct scope_exit {
  614. explicit scope_exit(std::function<void(void)> &&f)
  615. : exit_function(std::move(f)), execute_on_destruction{true} {}
  616. scope_exit(scope_exit &&rhs) noexcept
  617. : exit_function(std::move(rhs.exit_function)),
  618. execute_on_destruction{rhs.execute_on_destruction} {
  619. rhs.release();
  620. }
  621. ~scope_exit() {
  622. if (execute_on_destruction) { this->exit_function(); }
  623. }
  624. void release() { this->execute_on_destruction = false; }
  625. private:
  626. scope_exit(const scope_exit &) = delete;
  627. void operator=(const scope_exit &) = delete;
  628. scope_exit &operator=(scope_exit &&) = delete;
  629. std::function<void(void)> exit_function;
  630. bool execute_on_destruction;
  631. };
  632. // Simple from_chars implementation for integer and double types (C++17
  633. // substitute)
  634. template <typename T> struct from_chars_result {
  635. const char *ptr;
  636. std::errc ec;
  637. };
  638. template <typename T>
  639. inline from_chars_result<T> from_chars(const char *first, const char *last,
  640. T &value, int base = 10) {
  641. value = 0;
  642. const char *p = first;
  643. bool negative = false;
  644. if (p != last && *p == '-') {
  645. negative = true;
  646. ++p;
  647. }
  648. if (p == last) { return {first, std::errc::invalid_argument}; }
  649. auto radix = static_cast<T>(base);
  650. T result = 0;
  651. for (; p != last; ++p) {
  652. char c = *p;
  653. int digit = -1;
  654. if (is_ascii_digit(c)) {
  655. digit = c - '0';
  656. } else if ('a' <= c && c <= 'z') {
  657. digit = c - 'a' + 10;
  658. } else if ('A' <= c && c <= 'Z') {
  659. digit = c - 'A' + 10;
  660. } else {
  661. break;
  662. }
  663. if (digit < 0 || digit >= base) { break; }
  664. auto d = static_cast<T>(digit);
  665. if (result > ((std::numeric_limits<T>::max)() - d) / radix) {
  666. return {p, std::errc::result_out_of_range};
  667. }
  668. result = result * radix + d;
  669. }
  670. if (p == first || (negative && p == first + 1)) {
  671. return {first, std::errc::invalid_argument};
  672. }
  673. value = negative ? T(0) - result : result;
  674. return {p, std::errc{}};
  675. }
  676. // from_chars for double (hand-written, locale-independent)
  677. //
  678. // The only double consumed by this library is the HTTP quality value, whose
  679. // grammar is (RFC 9110 12.4.2):
  680. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  681. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  682. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  683. // '.' always the decimal separator (std::strtod would instead read it from the
  684. // global C locale, mis-parsing q-values once an embedder calls
  685. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  686. // the result to [0, 1], so inputs outside that range need not be distinguished
  687. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  688. // cases that exponent and wide-range handling would introduce.
  689. inline from_chars_result<double> from_chars(const char *first, const char *last,
  690. double &value) {
  691. value = 0.0;
  692. const char *p = first;
  693. // Each 1eN is exactly representable, so a single final division by the
  694. // matching entry yields a correctly-rounded result.
  695. static const double powers_of_ten[] = {
  696. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  697. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  698. const int max_frac_digits =
  699. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  700. // Accumulate digits into a 64-bit integer and remember how many were
  701. // fractional. Two independent caps keep this bounded and safe:
  702. // * accumulation saturates before mantissa could overflow uint64_t, and
  703. // * frac_digits is capped at max_frac_digits so it is always a valid index
  704. // into powers_of_ten (without this an input like "0.000...0" would never
  705. // grow mantissa, so the saturation cap alone would not bound it).
  706. // Both caps only drop digits far beyond the precision a q-value needs; any
  707. // value they would change is well outside [0, 1] and rejected by the caller.
  708. uint64_t mantissa = 0;
  709. int frac_digits = 0;
  710. bool seen_digit = false;
  711. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  712. auto accumulate = [&](char c) {
  713. if (mantissa <= limit) {
  714. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  715. return true;
  716. }
  717. return false;
  718. };
  719. for (; p != last && is_ascii_digit(*p); ++p) {
  720. seen_digit = true;
  721. accumulate(*p);
  722. }
  723. if (p != last && *p == '.') {
  724. ++p;
  725. for (; p != last && is_ascii_digit(*p); ++p) {
  726. seen_digit = true;
  727. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  728. }
  729. }
  730. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  731. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  732. return {p, std::errc{}};
  733. }
  734. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  735. int &out) {
  736. int val = 0;
  737. auto r = from_chars(s, s + len, val);
  738. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  739. return false;
  740. }
  741. out = val;
  742. return true;
  743. }
  744. inline bool parse_port(const char *s, size_t len, int &port) {
  745. return parse_int_in_range(s, len, 1, 65535, port);
  746. }
  747. inline bool parse_port(const std::string &s, int &port) {
  748. return parse_port(s.data(), s.size(), port);
  749. }
  750. struct UrlComponents {
  751. std::string scheme;
  752. std::string host;
  753. std::string port;
  754. std::string path;
  755. std::string query;
  756. };
  757. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  758. uc = {};
  759. size_t pos = 0;
  760. auto sep = url.find("://");
  761. if (sep != std::string::npos) {
  762. uc.scheme = url.substr(0, sep);
  763. // Scheme must be [a-z]+ only
  764. if (uc.scheme.empty()) { return false; }
  765. for (auto c : uc.scheme) {
  766. if (c < 'a' || c > 'z') { return false; }
  767. }
  768. pos = sep + 3;
  769. } else if (url.compare(0, 2, "//") == 0) {
  770. pos = 2;
  771. }
  772. auto has_authority_prefix = pos > 0;
  773. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  774. url[0] != '?' && url[0] != '#');
  775. if (has_authority) {
  776. // userinfo is not supported, and a backslash that some parsers take for
  777. // '/' would leave them seeing another host than this one.
  778. if (url.find_first_of("@\\", pos) < url.find_first_of("/?#", pos)) {
  779. return false;
  780. }
  781. if (pos < url.size() && url[pos] == '[') {
  782. auto close = url.find(']', pos);
  783. if (close == std::string::npos) { return false; }
  784. uc.host = url.substr(pos + 1, close - pos - 1);
  785. // IPv6 host must be [a-fA-F0-9:]+ only
  786. if (uc.host.empty()) { return false; }
  787. for (auto c : uc.host) {
  788. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  789. (c >= 'A' && c <= 'F') || c == ':')) {
  790. return false;
  791. }
  792. }
  793. pos = close + 1;
  794. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  795. // path, query or fragment delimiter (or the end of input). Otherwise the
  796. // trailing bytes would be folded into the path while the connection
  797. // still targets the bracketed address.
  798. if (pos < url.size()) {
  799. auto c = url[pos];
  800. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  801. }
  802. } else {
  803. auto end = url.find_first_of(":/?#", pos);
  804. if (end == std::string::npos) { end = url.size(); }
  805. uc.host = url.substr(pos, end - pos);
  806. pos = end;
  807. }
  808. if (pos < url.size() && url[pos] == ':') {
  809. ++pos;
  810. auto end = url.find_first_of("/?#", pos);
  811. if (end == std::string::npos) { end = url.size(); }
  812. uc.port = url.substr(pos, end - pos);
  813. pos = end;
  814. }
  815. // Without :// or //, the entire input must be consumed as host[:port].
  816. // If there is leftover (path, query, etc.), this is not a valid
  817. // host[:port] string — clear and reparse as a plain path.
  818. if (!has_authority_prefix && pos < url.size()) {
  819. uc.host.clear();
  820. uc.port.clear();
  821. pos = 0;
  822. }
  823. }
  824. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  825. auto end = url.find_first_of("?#", pos);
  826. if (end == std::string::npos) { end = url.size(); }
  827. uc.path = url.substr(pos, end - pos);
  828. pos = end;
  829. }
  830. if (pos < url.size() && url[pos] == '?') {
  831. auto end = url.find('#', pos);
  832. if (end == std::string::npos) { end = url.size(); }
  833. uc.query = url.substr(pos, end - pos);
  834. }
  835. return true;
  836. }
  837. // Removes "." and ".." segments from a path that starts with '/' (RFC 3986
  838. // section 5.2.4).
  839. inline std::string remove_dot_segments(const std::string &path) {
  840. std::string out;
  841. size_t i = 0;
  842. while (i < path.size()) {
  843. auto next = (std::min)(path.find('/', i + 1), path.size());
  844. auto segment = path.substr(i + 1, next - i - 1);
  845. auto is_last = next == path.size();
  846. if (segment == "." || segment == "..") {
  847. if (segment == "..") {
  848. out.erase((std::min)(out.rfind('/'), out.size()));
  849. }
  850. if (is_last) { out += '/'; }
  851. } else {
  852. out += '/';
  853. out += segment;
  854. }
  855. i = next;
  856. }
  857. if (out.empty()) { out = "/"; }
  858. return out;
  859. }
  860. // Resolves a relative-path or query-only Location value against the path of
  861. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  862. // references starting with '/' are returned unchanged.
  863. inline std::string resolve_relative_location(const std::string &location,
  864. const std::string &base) {
  865. if (location.empty() || location[0] == '/') { return location; }
  866. // A ':' in the first segment means the value has a scheme.
  867. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  868. // A path starting with "//" would be re-parsed as an authority. Prefix "/."
  869. // (as the URL Standard does); remove_dot_segments strips it later.
  870. auto on_this_host = [](std::string path) -> std::string {
  871. if (path.compare(0, 2, "//") == 0) { path.insert(0, "/."); }
  872. return path;
  873. };
  874. if (location[0] == '#') {
  875. return on_this_host(base.substr(0, base.find('#')) + location);
  876. }
  877. auto base_path = base.substr(0, base.find_first_of("?#"));
  878. if (location[0] == '?') { return on_this_host(base_path + location); }
  879. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  880. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  881. // Remove "." and ".." segments from the merged path.
  882. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  883. return on_this_host(remove_dot_segments(merged.substr(0, path_end)) +
  884. merged.substr(path_end));
  885. }
  886. } // namespace detail
  887. enum class SSLVerifierResponse {
  888. // no decision has been made, use the built-in certificate verifier
  889. NoDecisionMade,
  890. // connection certificate is verified and accepted
  891. CertificateAccepted,
  892. // connection certificate was processed but is rejected
  893. CertificateRejected
  894. };
  895. // System CA loading policy for SSL clients. Auto (the default) loads system
  896. // CA certs only when no custom CA is configured; enable_system_ca() switches
  897. // to an explicit policy.
  898. enum class SystemCAMode { Auto, Enabled, Disabled };
  899. enum StatusCode {
  900. // Information responses
  901. Continue_100 = 100,
  902. SwitchingProtocol_101 = 101,
  903. Processing_102 = 102,
  904. EarlyHints_103 = 103,
  905. // Successful responses
  906. OK_200 = 200,
  907. Created_201 = 201,
  908. Accepted_202 = 202,
  909. NonAuthoritativeInformation_203 = 203,
  910. NoContent_204 = 204,
  911. ResetContent_205 = 205,
  912. PartialContent_206 = 206,
  913. MultiStatus_207 = 207,
  914. AlreadyReported_208 = 208,
  915. IMUsed_226 = 226,
  916. // Redirection messages
  917. MultipleChoices_300 = 300,
  918. MovedPermanently_301 = 301,
  919. Found_302 = 302,
  920. SeeOther_303 = 303,
  921. NotModified_304 = 304,
  922. UseProxy_305 = 305,
  923. unused_306 = 306,
  924. TemporaryRedirect_307 = 307,
  925. PermanentRedirect_308 = 308,
  926. // Client error responses
  927. BadRequest_400 = 400,
  928. Unauthorized_401 = 401,
  929. PaymentRequired_402 = 402,
  930. Forbidden_403 = 403,
  931. NotFound_404 = 404,
  932. MethodNotAllowed_405 = 405,
  933. NotAcceptable_406 = 406,
  934. ProxyAuthenticationRequired_407 = 407,
  935. RequestTimeout_408 = 408,
  936. Conflict_409 = 409,
  937. Gone_410 = 410,
  938. LengthRequired_411 = 411,
  939. PreconditionFailed_412 = 412,
  940. PayloadTooLarge_413 = 413,
  941. UriTooLong_414 = 414,
  942. UnsupportedMediaType_415 = 415,
  943. RangeNotSatisfiable_416 = 416,
  944. ExpectationFailed_417 = 417,
  945. ImATeapot_418 = 418,
  946. MisdirectedRequest_421 = 421,
  947. UnprocessableContent_422 = 422,
  948. Locked_423 = 423,
  949. FailedDependency_424 = 424,
  950. TooEarly_425 = 425,
  951. UpgradeRequired_426 = 426,
  952. PreconditionRequired_428 = 428,
  953. TooManyRequests_429 = 429,
  954. RequestHeaderFieldsTooLarge_431 = 431,
  955. UnavailableForLegalReasons_451 = 451,
  956. // Server error responses
  957. InternalServerError_500 = 500,
  958. NotImplemented_501 = 501,
  959. BadGateway_502 = 502,
  960. ServiceUnavailable_503 = 503,
  961. GatewayTimeout_504 = 504,
  962. HttpVersionNotSupported_505 = 505,
  963. VariantAlsoNegotiates_506 = 506,
  964. InsufficientStorage_507 = 507,
  965. LoopDetected_508 = 508,
  966. NotExtended_510 = 510,
  967. NetworkAuthenticationRequired_511 = 511,
  968. };
  969. namespace detail {
  970. // A multimap that keeps its entries in the order they were inserted.
  971. //
  972. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  973. // fields sharing a field name significant and forbids a proxy from reordering
  974. // them, and a query string's parameters are meaningful in the order the caller
  975. // wrote them. Neither standard container expresses it: std::unordered_multimap
  976. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  977. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  978. // key, which would drop control data such as Host behind whatever else the
  979. // message carries and alphabetise a query string.
  980. //
  981. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  982. // scan, which beats hashing for the handful of entries a message carries
  983. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  984. //
  985. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  986. // Params, whose parameter names are case-sensitive, not.
  987. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  988. public:
  989. using key_type = std::string;
  990. using mapped_type = Mapped;
  991. using value_type = std::pair<std::string, Mapped>;
  992. using size_type = std::size_t;
  993. using difference_type = std::ptrdiff_t;
  994. using reference = value_type &;
  995. using const_reference = const value_type &;
  996. private:
  997. static size_type npos() { return static_cast<size_type>(-1); }
  998. static bool keys_equal(const std::string &a, const std::string &b) {
  999. return KeyEqual()(a, b);
  1000. }
  1001. // Iterating yields every entry in insertion order, but equal_range() and
  1002. // find() have to walk only the entries sharing one key, which are not
  1003. // adjacent. Both are the same iterator type: key_idx_ selects between the
  1004. // two traversals, and since equality compares only the position, an iterator
  1005. // restricted to one key still compares equal to end().
  1006. template <typename V> class iterator_t {
  1007. public:
  1008. using iterator_category = std::bidirectional_iterator_tag;
  1009. using value_type = insertion_ordered_multimap::value_type;
  1010. using difference_type = insertion_ordered_multimap::difference_type;
  1011. using pointer = V *;
  1012. using reference = V &;
  1013. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  1014. template <typename U,
  1015. typename std::enable_if<std::is_convertible<U *, V *>::value,
  1016. int>::type = 0>
  1017. iterator_t(const iterator_t<U> &rhs)
  1018. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  1019. key_idx_(rhs.key_idx_) {}
  1020. reference operator*() const { return data_[idx_]; }
  1021. pointer operator->() const { return data_ + idx_; }
  1022. iterator_t &operator++() {
  1023. // Saturating, so that advancing past the last entry of a key stays at
  1024. // end() instead of running off the container.
  1025. if (idx_ >= size_) { return *this; }
  1026. ++idx_;
  1027. if (key_idx_ != npos()) {
  1028. while (idx_ < size_ && !matches(idx_)) {
  1029. ++idx_;
  1030. }
  1031. }
  1032. return *this;
  1033. }
  1034. iterator_t operator++(int) {
  1035. auto tmp = *this;
  1036. ++*this;
  1037. return tmp;
  1038. }
  1039. iterator_t &operator--() {
  1040. if (idx_ == 0) { return *this; }
  1041. --idx_;
  1042. if (key_idx_ != npos()) {
  1043. while (idx_ > 0 && !matches(idx_)) {
  1044. --idx_;
  1045. }
  1046. }
  1047. return *this;
  1048. }
  1049. iterator_t operator--(int) {
  1050. auto tmp = *this;
  1051. --*this;
  1052. return tmp;
  1053. }
  1054. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1055. return idx_ == rhs.idx_;
  1056. }
  1057. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1058. return idx_ != rhs.idx_;
  1059. }
  1060. private:
  1061. friend class insertion_ordered_multimap;
  1062. template <typename> friend class iterator_t;
  1063. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1064. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1065. bool matches(size_type i) const {
  1066. return keys_equal(data_[i].first, data_[key_idx_].first);
  1067. }
  1068. V *data_;
  1069. size_type idx_;
  1070. size_type size_;
  1071. size_type key_idx_;
  1072. };
  1073. public:
  1074. using iterator = iterator_t<value_type>;
  1075. using const_iterator = iterator_t<const value_type>;
  1076. insertion_ordered_multimap() = default;
  1077. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1078. : entries_(il) {}
  1079. template <typename InputIt>
  1080. insertion_ordered_multimap(InputIt first, InputIt last)
  1081. : entries_(first, last) {}
  1082. iterator begin() { return make_iter(0, npos()); }
  1083. iterator end() { return make_iter(entries_.size(), npos()); }
  1084. const_iterator begin() const { return make_citer(0, npos()); }
  1085. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1086. const_iterator cbegin() const { return begin(); }
  1087. const_iterator cend() const { return end(); }
  1088. bool empty() const { return entries_.empty(); }
  1089. size_type size() const { return entries_.size(); }
  1090. void clear() { entries_.clear(); }
  1091. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1092. iterator insert(const value_type &val) {
  1093. entries_.push_back(val);
  1094. return make_iter(entries_.size() - 1, npos());
  1095. }
  1096. iterator insert(value_type &&val) {
  1097. entries_.push_back(std::move(val));
  1098. return make_iter(entries_.size() - 1, npos());
  1099. }
  1100. template <typename... Args> iterator emplace(Args &&...args) {
  1101. entries_.emplace_back(std::forward<Args>(args)...);
  1102. return make_iter(entries_.size() - 1, npos());
  1103. }
  1104. // For entries that have to lead the message, such as the Host header field
  1105. // (RFC 9110 5.3 recommends sending control data first).
  1106. template <typename... Args> iterator emplace_front(Args &&...args) {
  1107. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1108. return make_iter(0, npos());
  1109. }
  1110. iterator find(const std::string &key) {
  1111. auto i = index_of(key);
  1112. return i == npos() ? end() : make_iter(i, i);
  1113. }
  1114. const_iterator find(const std::string &key) const {
  1115. auto i = index_of(key);
  1116. return i == npos() ? end() : make_citer(i, i);
  1117. }
  1118. size_type count(const std::string &key) const {
  1119. size_type n = 0;
  1120. for (const auto &entry : entries_) {
  1121. if (keys_equal(entry.first, key)) { n++; }
  1122. }
  1123. return n;
  1124. }
  1125. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1126. auto i = index_of(key);
  1127. return i == npos() ? std::make_pair(end(), end())
  1128. : std::make_pair(make_iter(i, i), end());
  1129. }
  1130. std::pair<const_iterator, const_iterator>
  1131. equal_range(const std::string &key) const {
  1132. auto i = index_of(key);
  1133. return i == npos() ? std::make_pair(end(), end())
  1134. : std::make_pair(make_citer(i, i), end());
  1135. }
  1136. size_type erase(const std::string &key) {
  1137. auto before = entries_.size();
  1138. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1139. [key](const value_type &entry) {
  1140. return keys_equal(entry.first, key);
  1141. }),
  1142. entries_.end());
  1143. return before - entries_.size();
  1144. }
  1145. iterator erase(const_iterator pos) {
  1146. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1147. return make_iter(pos.idx_, npos());
  1148. }
  1149. // Erases what iterating [first, last) would actually visit, so erasing an
  1150. // equal_range() removes only the entries with that key, not everything
  1151. // positioned between them.
  1152. iterator erase(const_iterator first, const_iterator last) {
  1153. auto from = first.idx_;
  1154. auto to = last.idx_;
  1155. if (from >= to) { return make_iter(from, npos()); }
  1156. auto begin_it = entries_.begin();
  1157. auto from_it = begin_it + static_cast<difference_type>(from);
  1158. auto to_it = begin_it + static_cast<difference_type>(to);
  1159. if (first.key_idx_ == npos()) {
  1160. entries_.erase(from_it, to_it);
  1161. } else {
  1162. auto key = entries_[first.key_idx_].first;
  1163. auto keep = from_it;
  1164. for (auto it = from_it; it != to_it; ++it) {
  1165. if (!keys_equal(it->first, key)) {
  1166. if (keep != it) { *keep = std::move(*it); }
  1167. ++keep;
  1168. }
  1169. }
  1170. if (keep != to_it) {
  1171. keep = std::move(to_it, entries_.end(), keep);
  1172. } else {
  1173. keep = entries_.end();
  1174. }
  1175. entries_.erase(keep, entries_.end());
  1176. }
  1177. return make_iter(from, npos());
  1178. }
  1179. friend bool operator==(const insertion_ordered_multimap &lhs,
  1180. const insertion_ordered_multimap &rhs) {
  1181. return lhs.entries_ == rhs.entries_;
  1182. }
  1183. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1184. const insertion_ordered_multimap &rhs) {
  1185. return !(lhs == rhs);
  1186. }
  1187. private:
  1188. size_type index_of(const std::string &key) const {
  1189. for (size_type i = 0; i < entries_.size(); i++) {
  1190. if (keys_equal(entries_[i].first, key)) { return i; }
  1191. }
  1192. return npos();
  1193. }
  1194. iterator make_iter(size_type idx, size_type key_idx) {
  1195. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1196. }
  1197. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1198. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1199. }
  1200. std::vector<value_type> entries_;
  1201. };
  1202. } // namespace detail
  1203. using Headers =
  1204. detail::insertion_ordered_multimap<std::string,
  1205. detail::case_ignore::equal_to>;
  1206. // Query parameter names are case-sensitive, unlike header field names.
  1207. using Params =
  1208. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1209. using Match = std::smatch;
  1210. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1211. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1212. /*
  1213. * detail: type-erased storage used by UserData.
  1214. * ABI-stable regardless of C++ standard — always uses this custom
  1215. * implementation instead of std::any.
  1216. */
  1217. namespace detail {
  1218. using any_type_id = const void *;
  1219. template <typename T> any_type_id any_typeid() noexcept {
  1220. static const char id = 0;
  1221. return &id;
  1222. }
  1223. struct any_storage {
  1224. virtual ~any_storage() = default;
  1225. virtual std::unique_ptr<any_storage> clone() const = 0;
  1226. virtual any_type_id type_id() const noexcept = 0;
  1227. };
  1228. template <typename T> struct any_value final : any_storage {
  1229. T value;
  1230. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1231. std::unique_ptr<any_storage> clone() const override {
  1232. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1233. }
  1234. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1235. };
  1236. } // namespace detail
  1237. class UserData {
  1238. public:
  1239. UserData() = default;
  1240. UserData(UserData &&) noexcept = default;
  1241. UserData &operator=(UserData &&) noexcept = default;
  1242. UserData(const UserData &o) {
  1243. for (const auto &e : o.entries_) {
  1244. if (e.second) { entries_[e.first] = e.second->clone(); }
  1245. }
  1246. }
  1247. UserData &operator=(const UserData &o) {
  1248. if (this != &o) {
  1249. entries_.clear();
  1250. for (const auto &e : o.entries_) {
  1251. if (e.second) { entries_[e.first] = e.second->clone(); }
  1252. }
  1253. }
  1254. return *this;
  1255. }
  1256. template <typename T> void set(const std::string &key, T &&value) {
  1257. using D = typename std::decay<T>::type;
  1258. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1259. }
  1260. template <typename T> T *get(const std::string &key) noexcept {
  1261. auto it = entries_.find(key);
  1262. if (it == entries_.end() || !it->second) { return nullptr; }
  1263. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1264. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1265. }
  1266. template <typename T> const T *get(const std::string &key) const noexcept {
  1267. auto it = entries_.find(key);
  1268. if (it == entries_.end() || !it->second) { return nullptr; }
  1269. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1270. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1271. }
  1272. bool has(const std::string &key) const noexcept {
  1273. return entries_.find(key) != entries_.end();
  1274. }
  1275. void erase(const std::string &key) { entries_.erase(key); }
  1276. void clear() noexcept { entries_.clear(); }
  1277. private:
  1278. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1279. entries_;
  1280. };
  1281. struct Response;
  1282. using ResponseHandler = std::function<bool(const Response &response)>;
  1283. struct FormData {
  1284. std::string name;
  1285. std::string content;
  1286. std::string filename;
  1287. std::string content_type;
  1288. Headers headers;
  1289. };
  1290. struct FormField {
  1291. std::string name;
  1292. std::string content;
  1293. Headers headers;
  1294. };
  1295. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1296. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1297. // should see the parts as they were sent. A std::multimap sorts by field name
  1298. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1299. // than the case-insensitive predicate Headers uses.
  1300. using FormFields =
  1301. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1302. using FormFiles =
  1303. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1304. struct MultipartFormData {
  1305. FormFields fields; // Text fields from multipart
  1306. FormFiles files; // Files from multipart
  1307. // Text field access
  1308. std::string get_field(const std::string &key, size_t id = 0) const;
  1309. std::vector<std::string> get_fields(const std::string &key) const;
  1310. bool has_field(const std::string &key) const;
  1311. size_t get_field_count(const std::string &key) const;
  1312. // File access
  1313. FormData get_file(const std::string &key, size_t id = 0) const;
  1314. std::vector<FormData> get_files(const std::string &key) const;
  1315. bool has_file(const std::string &key) const;
  1316. size_t get_file_count(const std::string &key) const;
  1317. };
  1318. struct UploadFormData {
  1319. std::string name;
  1320. std::string content;
  1321. std::string filename;
  1322. std::string content_type;
  1323. };
  1324. using UploadFormDataItems = std::vector<UploadFormData>;
  1325. class DataSink {
  1326. public:
  1327. DataSink() : os(&sb_), sb_(*this) {}
  1328. DataSink(const DataSink &) = delete;
  1329. DataSink &operator=(const DataSink &) = delete;
  1330. DataSink(DataSink &&) = delete;
  1331. DataSink &operator=(DataSink &&) = delete;
  1332. std::function<bool(const char *data, size_t data_len)> write;
  1333. // Only `write` is mandatory. The rest are defaulted so that a provider
  1334. // calling one on a writer that does not set it gets sensible behaviour
  1335. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1336. // `this` is safe: DataSink is neither copyable nor movable.
  1337. std::function<bool()> is_writable = []() { return true; };
  1338. std::function<void()> done = []() {};
  1339. std::function<void(const Headers &trailer)> done_with_trailer =
  1340. [this](const Headers & /*trailer*/) { done(); };
  1341. std::ostream os;
  1342. private:
  1343. class data_sink_streambuf final : public std::streambuf {
  1344. public:
  1345. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1346. protected:
  1347. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1348. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1349. return 0;
  1350. }
  1351. private:
  1352. DataSink &sink_;
  1353. };
  1354. data_sink_streambuf sb_;
  1355. };
  1356. using ContentProvider =
  1357. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1358. using ContentProviderWithoutLength =
  1359. std::function<bool(size_t offset, DataSink &sink)>;
  1360. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1361. struct FormDataProvider {
  1362. std::string name;
  1363. ContentProviderWithoutLength provider;
  1364. std::string filename;
  1365. std::string content_type;
  1366. };
  1367. using FormDataProviderItems = std::vector<FormDataProvider>;
  1368. inline FormDataProvider
  1369. make_file_provider(const std::string &name, const std::string &filepath,
  1370. const std::string &filename = std::string(),
  1371. const std::string &content_type = std::string()) {
  1372. FormDataProvider fdp;
  1373. fdp.name = name;
  1374. fdp.filename = filename.empty() ? filepath : filename;
  1375. fdp.content_type = content_type;
  1376. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1377. std::ifstream f(filepath, std::ios::binary);
  1378. if (!f) { return false; }
  1379. if (offset > 0) {
  1380. f.seekg(static_cast<std::streamoff>(offset));
  1381. if (!f.good()) {
  1382. sink.done();
  1383. return true;
  1384. }
  1385. }
  1386. char buf[8192];
  1387. f.read(buf, sizeof(buf));
  1388. auto n = static_cast<size_t>(f.gcount());
  1389. if (n > 0) { return sink.write(buf, n); }
  1390. sink.done(); // EOF
  1391. return true;
  1392. };
  1393. return fdp;
  1394. }
  1395. inline std::pair<size_t, ContentProvider>
  1396. make_file_body(const std::string &filepath) {
  1397. size_t size = 0;
  1398. {
  1399. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1400. if (!f) { return {0, ContentProvider{}}; }
  1401. size = static_cast<size_t>(f.tellg());
  1402. }
  1403. ContentProvider provider = [filepath](size_t offset, size_t length,
  1404. DataSink &sink) -> bool {
  1405. std::ifstream f(filepath, std::ios::binary);
  1406. if (!f) { return false; }
  1407. f.seekg(static_cast<std::streamoff>(offset));
  1408. if (!f.good()) { return false; }
  1409. char buf[8192];
  1410. while (length > 0) {
  1411. auto to_read = (std::min)(sizeof(buf), length);
  1412. f.read(buf, static_cast<std::streamsize>(to_read));
  1413. auto n = static_cast<size_t>(f.gcount());
  1414. // The file is shorter than the size make_file_body() measured, which the
  1415. // caller has already committed to as Content-Length. The body cannot be
  1416. // completed, so fail as every other error here does.
  1417. if (n == 0) { return false; }
  1418. if (!sink.write(buf, n)) { return false; }
  1419. length -= n;
  1420. }
  1421. return true;
  1422. };
  1423. return {size, std::move(provider)};
  1424. }
  1425. using ContentReceiverWithProgress = std::function<bool(
  1426. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1427. using ContentReceiver =
  1428. std::function<bool(const char *data, size_t data_length)>;
  1429. using FormDataHeader = std::function<bool(const FormData &file)>;
  1430. class ContentReader {
  1431. public:
  1432. using Reader = std::function<bool(ContentReceiver receiver)>;
  1433. using FormDataReader =
  1434. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1435. ContentReader(Reader reader, FormDataReader multipart_reader)
  1436. : reader_(std::move(reader)),
  1437. formdata_reader_(std::move(multipart_reader)) {}
  1438. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1439. return formdata_reader_(std::move(header), std::move(receiver));
  1440. }
  1441. bool operator()(ContentReceiver receiver) const {
  1442. return reader_(std::move(receiver));
  1443. }
  1444. Reader reader_;
  1445. FormDataReader formdata_reader_;
  1446. };
  1447. using Range = std::pair<ssize_t, ssize_t>;
  1448. using Ranges = std::vector<Range>;
  1449. #ifdef CPPHTTPLIB_SSL_ENABLED
  1450. // TLS abstraction layer - public type definitions and API
  1451. namespace tls {
  1452. // Opaque handles (defined as void* for abstraction)
  1453. using ctx_t = void *;
  1454. using session_t = void *;
  1455. using const_session_t = const void *; // For read-only session access
  1456. using cert_t = void *;
  1457. using ca_store_t = void *;
  1458. // TLS versions
  1459. enum class Version {
  1460. TLS1_2 = 0x0303,
  1461. TLS1_3 = 0x0304,
  1462. };
  1463. // Subject Alternative Names (SAN) entry types
  1464. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1465. // SAN entry structure
  1466. struct SanEntry {
  1467. SanType type;
  1468. std::string value;
  1469. };
  1470. // Verification context for certificate verification callback
  1471. struct VerifyContext {
  1472. session_t session; // TLS session handle
  1473. cert_t cert; // Current certificate being verified
  1474. int depth; // Certificate chain depth (0 = leaf)
  1475. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1476. long error_code; // Backend-specific error code (0 = no error)
  1477. const char *error_string; // Human-readable error description
  1478. // Certificate introspection methods
  1479. std::string subject_cn() const;
  1480. std::string issuer_name() const;
  1481. bool check_hostname(const char *hostname) const;
  1482. std::vector<SanEntry> sans() const;
  1483. bool validity(time_t &not_before, time_t &not_after) const;
  1484. std::string serial() const;
  1485. };
  1486. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1487. // TlsError codes for TLS operations (backend-independent)
  1488. enum class ErrorCode : int {
  1489. Success = 0,
  1490. WantRead, // Non-blocking: need to wait for read
  1491. WantWrite, // Non-blocking: need to wait for write
  1492. PeerClosed, // Peer closed the connection
  1493. Fatal, // Unrecoverable error
  1494. SyscallError, // System call error (check sys_errno)
  1495. CertVerifyFailed, // Certificate verification failed
  1496. HostnameMismatch, // Hostname verification failed
  1497. };
  1498. // TLS error information
  1499. struct TlsError {
  1500. ErrorCode code = ErrorCode::Fatal;
  1501. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1502. int sys_errno = 0; // errno when SyscallError
  1503. // Convert verification error code to human-readable string
  1504. static std::string verify_error_to_string(long error_code);
  1505. };
  1506. // RAII wrapper for peer certificate
  1507. class PeerCert {
  1508. public:
  1509. PeerCert();
  1510. PeerCert(PeerCert &&other) noexcept;
  1511. PeerCert &operator=(PeerCert &&other) noexcept;
  1512. ~PeerCert();
  1513. PeerCert(const PeerCert &) = delete;
  1514. PeerCert &operator=(const PeerCert &) = delete;
  1515. explicit operator bool() const;
  1516. std::string subject_cn() const;
  1517. std::string issuer_name() const;
  1518. bool check_hostname(const char *hostname) const;
  1519. std::vector<SanEntry> sans() const;
  1520. bool validity(time_t &not_before, time_t &not_after) const;
  1521. std::string serial() const;
  1522. private:
  1523. explicit PeerCert(cert_t cert);
  1524. cert_t cert_ = nullptr;
  1525. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1526. };
  1527. // Callback for TLS context setup (used by SSLServer constructor)
  1528. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1529. } // namespace tls
  1530. #endif
  1531. struct Request {
  1532. std::string method;
  1533. std::string path;
  1534. std::string matched_route;
  1535. Params params;
  1536. Headers headers;
  1537. Headers trailers;
  1538. std::string body;
  1539. std::string remote_addr;
  1540. int remote_port = -1;
  1541. std::string local_addr;
  1542. int local_port = -1;
  1543. // for server
  1544. std::string version;
  1545. std::string target;
  1546. MultipartFormData form;
  1547. Ranges ranges;
  1548. Match matches;
  1549. std::unordered_map<std::string, std::string> path_params;
  1550. std::function<bool()> is_connection_closed = []() { return true; };
  1551. // for client
  1552. std::vector<std::string> accept_content_types;
  1553. ResponseHandler response_handler;
  1554. ContentReceiverWithProgress content_receiver;
  1555. DownloadProgress download_progress;
  1556. UploadProgress upload_progress;
  1557. bool has_header(const std::string &key) const;
  1558. std::string get_header_value(const std::string &key, const char *def = "",
  1559. size_t id = 0) const;
  1560. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1561. size_t id = 0) const;
  1562. size_t get_header_value_count(const std::string &key) const;
  1563. void set_header(const std::string &key, const std::string &val);
  1564. bool has_trailer(const std::string &key) const;
  1565. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1566. size_t get_trailer_value_count(const std::string &key) const;
  1567. bool has_param(const std::string &key) const;
  1568. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1569. std::vector<std::string> get_param_values(const std::string &key) const;
  1570. size_t get_param_value_count(const std::string &key) const;
  1571. bool is_multipart_form_data() const;
  1572. // private members...
  1573. bool body_read_started_ = false;
  1574. bool body_consumed_ = false;
  1575. bool expect_100_continue_pending_ = false;
  1576. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1577. size_t content_length_ = 0;
  1578. ContentProvider content_provider_;
  1579. bool is_chunked_content_provider_ = false;
  1580. size_t authorization_count_ = 0;
  1581. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1582. (std::chrono::steady_clock::time_point::min)();
  1583. #ifdef CPPHTTPLIB_SSL_ENABLED
  1584. tls::const_session_t ssl = nullptr;
  1585. tls::PeerCert peer_cert() const;
  1586. std::string sni() const;
  1587. #endif
  1588. };
  1589. namespace detail {
  1590. // Declared up here, away from the rest of the compression helpers, because
  1591. // `Response` stores one.
  1592. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1593. } // namespace detail
  1594. struct Response {
  1595. std::string version;
  1596. int status = -1;
  1597. std::string reason;
  1598. Headers headers;
  1599. Headers trailers;
  1600. std::string body;
  1601. std::string location; // Redirect location
  1602. // User-defined context — set by pre-routing/pre-request handlers and read
  1603. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1604. UserData user_data;
  1605. bool has_header(const std::string &key) const;
  1606. std::string get_header_value(const std::string &key, const char *def = "",
  1607. size_t id = 0) const;
  1608. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1609. size_t id = 0) const;
  1610. size_t get_header_value_count(const std::string &key) const;
  1611. void set_header(const std::string &key, const std::string &val);
  1612. bool has_trailer(const std::string &key) const;
  1613. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1614. size_t get_trailer_value_count(const std::string &key) const;
  1615. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1616. void set_content(const char *s, size_t n, const std::string &content_type);
  1617. void set_content(const std::string &s, const std::string &content_type);
  1618. void set_content(std::string &&s, const std::string &content_type);
  1619. void set_content_provider(
  1620. size_t length, const std::string &content_type, ContentProvider provider,
  1621. ContentProviderResourceReleaser resource_releaser = nullptr);
  1622. void set_content_provider(
  1623. const std::string &content_type, ContentProviderWithoutLength provider,
  1624. ContentProviderResourceReleaser resource_releaser = nullptr);
  1625. void set_chunked_content_provider(
  1626. const std::string &content_type, ContentProviderWithoutLength provider,
  1627. ContentProviderResourceReleaser resource_releaser = nullptr);
  1628. void set_file_content(const std::string &path,
  1629. const std::string &content_type);
  1630. void set_file_content(const std::string &path);
  1631. Response() = default;
  1632. Response(const Response &) = default;
  1633. Response &operator=(const Response &) = default;
  1634. Response(Response &&) = default;
  1635. Response &operator=(Response &&) = default;
  1636. ~Response() {
  1637. if (content_provider_resource_releaser_) {
  1638. content_provider_resource_releaser_(content_provider_success_);
  1639. }
  1640. }
  1641. // private members...
  1642. size_t content_length_ = 0;
  1643. ContentProvider content_provider_;
  1644. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1645. bool is_chunked_content_provider_ = false;
  1646. bool is_file_content_provider_ = false;
  1647. bool content_provider_success_ = false;
  1648. std::string file_content_path_;
  1649. std::string file_content_content_type_;
  1650. // Content coding chosen for the response body, decided once so that the
  1651. // headers and the body cannot disagree: where the file is opened for a
  1652. // file-backed content provider (keeping the ETag honest), and in
  1653. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1654. // for every other kind of response.
  1655. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1656. };
  1657. enum class Error {
  1658. Success = 0,
  1659. Unknown,
  1660. Connection,
  1661. BindIPAddress,
  1662. Read,
  1663. Write,
  1664. ExceedRedirectCount,
  1665. Canceled,
  1666. SSLConnection,
  1667. SSLLoadingCerts,
  1668. SSLServerVerification,
  1669. SSLServerHostnameVerification,
  1670. UnsupportedMultipartBoundaryChars,
  1671. Compression,
  1672. ConnectionTimeout,
  1673. ProxyConnection,
  1674. ConnectionClosed,
  1675. Timeout,
  1676. ResourceExhaustion,
  1677. TooManyFormDataFiles,
  1678. ExceedMaxPayloadSize,
  1679. ExceedUriMaxLength,
  1680. ExceedMaxSocketDescriptorCount,
  1681. InvalidRequestLine,
  1682. InvalidHTTPMethod,
  1683. InvalidHTTPVersion,
  1684. InvalidHeaders,
  1685. MultipartParsing,
  1686. OpenFile,
  1687. Listen,
  1688. GetSockName,
  1689. UnsupportedAddressFamily,
  1690. HTTPParsing,
  1691. InvalidRangeHeader,
  1692. UnsupportedContentEncoding,
  1693. WebSocketHandshake,
  1694. UserCallbackException,
  1695. // For internal use only
  1696. SSLPeerCouldBeClosed_,
  1697. };
  1698. std::string to_string(Error error);
  1699. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1700. class Stream {
  1701. public:
  1702. virtual ~Stream() = default;
  1703. virtual bool is_readable() const = 0;
  1704. virtual bool wait_readable() const = 0;
  1705. virtual bool wait_writable() const = 0;
  1706. virtual bool is_peer_alive() const { return wait_writable(); }
  1707. virtual ssize_t read(char *ptr, size_t size) = 0;
  1708. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1709. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1710. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1711. virtual socket_t socket() const = 0;
  1712. virtual time_t duration() const = 0;
  1713. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1714. (void)sec;
  1715. (void)usec;
  1716. }
  1717. // Bounds the reads from now on to `msec` in total, on top of the timeout of
  1718. // each one. 0 lifts the bound.
  1719. virtual void set_max_timeout(time_t msec) { (void)msec; }
  1720. // Lets a wait for data end early once `interrupted` returns true, so that
  1721. // another thread can stop a blocked read on every platform.
  1722. virtual void set_read_interrupt(std::function<bool()> interrupted) {
  1723. (void)interrupted;
  1724. }
  1725. // Bytes already pulled off the socket and sitting in this stream's own
  1726. // buffer. Exposing them lets a line reader scan for a terminator in one
  1727. // pass instead of asking for a byte at a time. A stream that does no
  1728. // buffering of its own reports none, and readers fall back to read().
  1729. virtual const char *buffered_data(size_t &size) const {
  1730. size = 0;
  1731. return nullptr;
  1732. }
  1733. // Discards `size` bytes previously returned by buffered_data().
  1734. virtual void consume_buffered(size_t size) { (void)size; }
  1735. ssize_t write(const char *ptr);
  1736. ssize_t write(const std::string &s);
  1737. Error get_error() const { return error_; }
  1738. protected:
  1739. Error error_ = Error::Success;
  1740. };
  1741. class TaskQueue {
  1742. public:
  1743. TaskQueue() = default;
  1744. virtual ~TaskQueue() = default;
  1745. virtual bool enqueue(std::function<void()> fn) = 0;
  1746. virtual void shutdown() = 0;
  1747. virtual void on_idle() {}
  1748. };
  1749. class ThreadPool final : public TaskQueue {
  1750. public:
  1751. explicit ThreadPool(
  1752. size_t n, size_t max_n = 0, size_t mqr = 0,
  1753. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1754. ThreadPool(const ThreadPool &) = delete;
  1755. ~ThreadPool() override = default;
  1756. bool enqueue(std::function<void()> fn) override;
  1757. void shutdown() override;
  1758. private:
  1759. void worker(bool is_dynamic);
  1760. void move_to_finished(std::thread::id id);
  1761. void cleanup_finished_threads();
  1762. size_t base_thread_count_;
  1763. size_t max_thread_count_;
  1764. size_t max_queued_requests_;
  1765. time_t idle_timeout_sec_;
  1766. size_t idle_thread_count_;
  1767. bool shutdown_;
  1768. std::list<std::function<void()>> jobs_;
  1769. std::vector<std::thread> threads_; // base threads
  1770. std::list<std::thread> dynamic_threads_; // dynamic threads
  1771. std::vector<std::thread>
  1772. finished_threads_; // exited dynamic threads awaiting join
  1773. std::condition_variable cond_;
  1774. std::mutex mutex_;
  1775. };
  1776. using Logger = std::function<void(const Request &, const Response &)>;
  1777. // Forward declaration for Error type
  1778. enum class Error;
  1779. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1780. using SocketOptions = std::function<void(socket_t sock)>;
  1781. void default_socket_options(socket_t sock);
  1782. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1783. const char *status_message(int status);
  1784. std::string to_string(Error error);
  1785. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1786. std::string get_bearer_token_auth(const Request &req);
  1787. namespace detail {
  1788. class MatcherBase {
  1789. public:
  1790. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1791. virtual ~MatcherBase() = default;
  1792. const std::string &pattern() const { return pattern_; }
  1793. // Match request path and populate its matches and
  1794. virtual bool match(Request &request) const = 0;
  1795. private:
  1796. std::string pattern_;
  1797. };
  1798. /**
  1799. * Captures parameters in request path and stores them in Request::path_params
  1800. *
  1801. * Capture name is a substring of a pattern from : to /.
  1802. * The rest of the pattern is matched against the request path directly
  1803. * Parameters are captured starting from the next character after
  1804. * the end of the last matched static pattern fragment until the next /.
  1805. *
  1806. * Example pattern:
  1807. * "/path/fragments/:capture/more/fragments/:second_capture"
  1808. * Static fragments:
  1809. * "/path/fragments/", "more/fragments/"
  1810. *
  1811. * Given the following request path:
  1812. * "/path/fragments/:1/more/fragments/:2"
  1813. * the resulting capture will be
  1814. * {{"capture", "1"}, {"second_capture", "2"}}
  1815. */
  1816. class PathParamsMatcher final : public MatcherBase {
  1817. public:
  1818. PathParamsMatcher(const std::string &pattern);
  1819. bool match(Request &request) const override;
  1820. private:
  1821. // Treat segment separators as the end of path parameter capture
  1822. // Does not need to handle query parameters as they are parsed before path
  1823. // matching
  1824. static constexpr char separator = '/';
  1825. // Contains static path fragments to match against, excluding the '/' after
  1826. // path params
  1827. // Fragments are separated by path params
  1828. std::vector<std::string> static_fragments_;
  1829. // Stores the names of the path parameters to be used as keys in the
  1830. // Request::path_params map
  1831. std::vector<std::string> param_names_;
  1832. };
  1833. /**
  1834. * Performs std::regex_match on request path
  1835. * and stores the result in Request::matches
  1836. *
  1837. * Note that regex match is performed directly on the whole request.
  1838. * This means that wildcard patterns may match multiple path segments with /:
  1839. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1840. */
  1841. class RegexMatcher final : public MatcherBase {
  1842. public:
  1843. RegexMatcher(const std::string &pattern)
  1844. : MatcherBase(pattern), regex_(pattern) {}
  1845. bool match(Request &request) const override;
  1846. private:
  1847. std::regex regex_;
  1848. };
  1849. int close_socket(socket_t sock) noexcept;
  1850. bool is_accept_resource_error();
  1851. bool is_accept_transient_error();
  1852. ssize_t write_headers(Stream &strm, const Headers &headers);
  1853. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1854. time_t usec);
  1855. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1856. const std::string &boundary);
  1857. ContentProvider
  1858. make_multipart_content_provider(const UploadFormDataItems &items,
  1859. const std::string &boundary);
  1860. } // namespace detail
  1861. bool is_valid_multipart_boundary(const std::string &boundary);
  1862. // Serializer for multipart/form-data request bodies. The boundary is owned
  1863. // by the writer so that per-part framing and the final terminator always
  1864. // agree. Field names and filenames are escaped following the WHATWG HTML
  1865. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1866. // in content types.
  1867. class MultipartFormDataWriter {
  1868. public:
  1869. MultipartFormDataWriter();
  1870. // precondition: is_valid_multipart_boundary(boundary)
  1871. explicit MultipartFormDataWriter(std::string boundary);
  1872. const std::string &boundary() const;
  1873. std::string content_type() const;
  1874. // In-memory items -> whole body (known length)
  1875. std::string serialize(const UploadFormDataItems &items) const;
  1876. size_t content_length(const UploadFormDataItems &items) const;
  1877. // Per-part framing for streaming via a content provider
  1878. std::string item_begin(const UploadFormData &item) const;
  1879. static std::string item_end();
  1880. std::string finish() const;
  1881. private:
  1882. std::string boundary_;
  1883. };
  1884. class Server {
  1885. public:
  1886. using Handler = std::function<void(const Request &, Response &)>;
  1887. using ExceptionHandler =
  1888. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1889. enum class HandlerResponse {
  1890. Handled,
  1891. Unhandled,
  1892. };
  1893. using HandlerWithResponse =
  1894. std::function<HandlerResponse(const Request &, Response &)>;
  1895. using HandlerWithContentReader = std::function<void(
  1896. const Request &, Response &, const ContentReader &content_reader)>;
  1897. using Expect100ContinueHandler =
  1898. std::function<int(const Request &, Response &)>;
  1899. using StartHandler = std::function<void()>;
  1900. using WebSocketHandler =
  1901. std::function<void(const Request &, ws::WebSocket &)>;
  1902. using SubProtocolSelector =
  1903. std::function<std::string(const std::vector<std::string> &protocols)>;
  1904. Server();
  1905. virtual ~Server();
  1906. virtual bool is_valid() const;
  1907. Server &Get(const std::string &pattern, Handler handler);
  1908. Server &Post(const std::string &pattern, Handler handler);
  1909. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1910. Server &Put(const std::string &pattern, Handler handler);
  1911. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1912. Server &Patch(const std::string &pattern, Handler handler);
  1913. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1914. Server &Delete(const std::string &pattern, Handler handler);
  1915. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1916. Server &Options(const std::string &pattern, Handler handler);
  1917. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1918. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1919. // server accept it; an unregistered method is still rejected with 400.
  1920. // `method` must be a valid HTTP method token and must not be one of the
  1921. // built-in methods, which have their own registration functions above. A
  1922. // rejected registration makes is_valid() return false, so listen() fails.
  1923. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1924. Handler handler);
  1925. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1926. HandlerWithContentReader handler);
  1927. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1928. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1929. SubProtocolSelector sub_protocol_selector);
  1930. bool set_base_dir(const std::string &dir,
  1931. const std::string &mount_point = std::string());
  1932. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1933. Headers headers = Headers());
  1934. bool remove_mount_point(const std::string &mount_point);
  1935. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1936. const std::string &mime);
  1937. Server &set_default_file_mimetype(const std::string &mime);
  1938. Server &set_file_request_handler(Handler handler);
  1939. template <class ErrorHandlerFunc>
  1940. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1941. return set_error_handler_core(
  1942. std::forward<ErrorHandlerFunc>(handler),
  1943. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1944. }
  1945. Server &set_exception_handler(ExceptionHandler handler);
  1946. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1947. Server &set_post_routing_handler(Handler handler);
  1948. Server &set_pre_request_handler(HandlerWithResponse handler);
  1949. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1950. Server &set_start_handler(StartHandler handler);
  1951. Server &set_logger(Logger logger);
  1952. Server &set_pre_compression_logger(Logger logger);
  1953. Server &set_error_logger(ErrorLogger error_logger);
  1954. Server &set_address_family(int family);
  1955. Server &set_tcp_nodelay(bool on);
  1956. Server &set_ipv6_v6only(bool on);
  1957. Server &set_socket_options(SocketOptions socket_options);
  1958. Server &set_default_headers(Headers headers);
  1959. Server &
  1960. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1961. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1962. Server &set_keep_alive_max_count(size_t count);
  1963. Server &set_keep_alive_timeout(time_t sec);
  1964. template <class Rep, class Period>
  1965. Server &
  1966. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1967. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1968. template <class Rep, class Period>
  1969. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1970. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1971. template <class Rep, class Period>
  1972. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1973. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1974. template <class Rep, class Period>
  1975. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1976. Server &set_payload_max_length(size_t length);
  1977. Server &set_compress(bool on);
  1978. Server &set_static_file_compression(bool on);
  1979. Server &set_static_file_compression_min_length(size_t length);
  1980. Server &set_static_file_compression_max_length(size_t length);
  1981. Server &set_websocket_ping_interval(time_t sec);
  1982. template <class Rep, class Period>
  1983. Server &set_websocket_ping_interval(
  1984. const std::chrono::duration<Rep, Period> &duration);
  1985. Server &set_websocket_max_missed_pongs(int count);
  1986. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1987. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1988. bool listen_after_bind();
  1989. bool listen(const std::string &host, int port, int socket_flags = 0);
  1990. bool is_running() const;
  1991. void wait_until_ready() const;
  1992. void stop() noexcept;
  1993. void decommission();
  1994. std::function<TaskQueue *(void)> new_task_queue;
  1995. protected:
  1996. bool process_request(Stream &strm, const std::string &remote_addr,
  1997. int remote_port, const std::string &local_addr,
  1998. int local_port, bool close_connection,
  1999. bool &connection_closed,
  2000. const std::function<void(Request &)> &setup_request,
  2001. bool *websocket_upgraded = nullptr);
  2002. // Runs the per-connection serving loop and stops an exception thrown by a
  2003. // user callback from escaping the worker thread.
  2004. //
  2005. // process_request() wraps only routing() and the hooks before a WebSocket
  2006. // upgrade in a try/catch. Content providers, the post-routing, error,
  2007. // logging and expect-100 handlers and WebSocket handlers all run outside
  2008. // it, and the task queue calls the job without a catch, so an exception
  2009. // from any of those would terminate the process.
  2010. //
  2011. // No 500 is possible here: by the time a content provider runs, the status
  2012. // line and headers are already on the wire. Report it through the error
  2013. // logger and drop the connection, which is what the peer observes either
  2014. // way. Other connections are unaffected.
  2015. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  2016. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  2017. return serve();
  2018. #else
  2019. try {
  2020. return serve();
  2021. } catch (...) {
  2022. // The error logger is a user callback too, so it must not be able to
  2023. // throw the guard back open.
  2024. try {
  2025. output_error_log(Error::UserCallbackException, nullptr);
  2026. } catch (...) {}
  2027. return false;
  2028. }
  2029. #endif
  2030. }
  2031. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  2032. // stop() takes the listening socket away; listen() then waits for handlers
  2033. bool is_stopping() const { return svr_sock_ == INVALID_SOCKET; }
  2034. std::vector<std::string> trusted_proxies_;
  2035. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  2036. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  2037. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  2038. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  2039. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  2040. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  2041. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  2042. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  2043. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2044. bool compress_ = true;
  2045. bool static_file_compression_ = false;
  2046. size_t static_file_compression_min_length_ =
  2047. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  2048. size_t static_file_compression_max_length_ =
  2049. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  2050. time_t websocket_ping_interval_sec_ =
  2051. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  2052. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  2053. private:
  2054. using Handlers =
  2055. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2056. using HandlersForContentReader =
  2057. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2058. HandlerWithContentReader>>;
  2059. // Both handler tables for one custom method live in a single entry, so that
  2060. // routing() needs only one map lookup per request to reach either of them.
  2061. struct CustomHandlerEntry {
  2062. Handlers handlers;
  2063. HandlersForContentReader handlers_for_content_reader;
  2064. };
  2065. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2066. static std::unique_ptr<detail::MatcherBase>
  2067. make_matcher(const std::string &pattern);
  2068. static const std::set<std::string> &builtin_methods();
  2069. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2070. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2071. template <typename H>
  2072. Server &add_handler(
  2073. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2074. const std::string &pattern, H handler) {
  2075. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2076. return *this;
  2077. }
  2078. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2079. Server &set_error_handler_core(Handler handler, std::false_type);
  2080. socket_t create_server_socket(const std::string &host, int port,
  2081. int socket_flags,
  2082. SocketOptions socket_options) const;
  2083. int bind_internal(const std::string &host, int port, int socket_flags);
  2084. bool listen_internal();
  2085. bool routing(Request &req, Response &res, Stream &strm,
  2086. bool skip_pre_routing);
  2087. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  2088. bool handle_exception(Request &req, Response &res);
  2089. #endif
  2090. bool handle_file_request(Request &req, Response &res);
  2091. bool check_if_not_modified(const Request &req, Response &res,
  2092. const std::string &etag, time_t mtime) const;
  2093. bool check_if_range(Request &req, const std::string &etag,
  2094. time_t mtime) const;
  2095. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2096. Stream &strm);
  2097. bool dispatch_request_for_content_reader(
  2098. Request &req, Response &res, ContentReader content_reader,
  2099. const HandlersForContentReader &handlers) const;
  2100. bool parse_request_line(const char *s, Request &req) const;
  2101. detail::EncodingType static_file_encoding(const Request &req,
  2102. const Response &res,
  2103. const std::string &content_type,
  2104. size_t length) const;
  2105. bool apply_static_file_compression(const Request &req, Response &res) const;
  2106. void apply_ranges(const Request &req, Response &res,
  2107. std::string &content_type, std::string &boundary) const;
  2108. bool write_response(Stream &strm, bool close_connection, Request &req,
  2109. Response &res);
  2110. bool write_response_with_content(Stream &strm, bool close_connection,
  2111. const Request &req, Response &res);
  2112. bool write_response_core(Stream &strm, bool close_connection,
  2113. const Request &req, Response &res,
  2114. bool need_apply_ranges);
  2115. bool write_content_with_provider(Stream &strm, const Request &req,
  2116. Response &res, const std::string &boundary,
  2117. const std::string &content_type);
  2118. bool read_content(Stream &strm, Request &req, Response &res);
  2119. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2120. Response &res,
  2121. ContentReceiver receiver,
  2122. FormDataHeader multipart_header,
  2123. ContentReceiver multipart_receiver);
  2124. bool read_content_core(Stream &strm, Request &req, Response &res,
  2125. ContentReceiver receiver,
  2126. FormDataHeader multipart_header,
  2127. ContentReceiver multipart_receiver) const;
  2128. virtual bool process_and_close_socket(socket_t sock);
  2129. void output_log(const Request &req, const Response &res) const;
  2130. void output_pre_compression_log(const Request &req,
  2131. const Response &res) const;
  2132. void output_error_log(const Error &err, const Request *req) const;
  2133. std::atomic<bool> is_running_{false};
  2134. std::atomic<bool> is_decommissioned{false};
  2135. // Set when CustomRoute() refuses a registration. Written before listen(),
  2136. // read by is_valid() on the same thread, so it needs no synchronization.
  2137. bool has_invalid_registration_ = false;
  2138. struct MountPointEntry {
  2139. std::string mount_point;
  2140. std::string base_dir;
  2141. std::string resolved_base_dir;
  2142. Headers headers;
  2143. };
  2144. std::vector<MountPointEntry> base_dirs_;
  2145. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2146. std::string default_file_mimetype_ = "application/octet-stream";
  2147. Handler file_request_handler_;
  2148. Handlers get_handlers_;
  2149. Handlers post_handlers_;
  2150. HandlersForContentReader post_handlers_for_content_reader_;
  2151. Handlers put_handlers_;
  2152. HandlersForContentReader put_handlers_for_content_reader_;
  2153. Handlers patch_handlers_;
  2154. HandlersForContentReader patch_handlers_for_content_reader_;
  2155. Handlers delete_handlers_;
  2156. HandlersForContentReader delete_handlers_for_content_reader_;
  2157. Handlers options_handlers_;
  2158. CustomHandlers custom_handlers_;
  2159. struct WebSocketHandlerEntry {
  2160. std::unique_ptr<detail::MatcherBase> matcher;
  2161. WebSocketHandler handler;
  2162. SubProtocolSelector sub_protocol_selector;
  2163. };
  2164. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2165. WebSocketHandlers websocket_handlers_;
  2166. HandlerWithResponse error_handler_;
  2167. ExceptionHandler exception_handler_;
  2168. HandlerWithResponse pre_routing_handler_;
  2169. Handler post_routing_handler_;
  2170. HandlerWithResponse pre_request_handler_;
  2171. Expect100ContinueHandler expect_100_continue_handler_;
  2172. StartHandler start_handler_;
  2173. mutable std::mutex logger_mutex_;
  2174. Logger logger_;
  2175. Logger pre_compression_logger_;
  2176. ErrorLogger error_logger_;
  2177. int address_family_ = AF_UNSPEC;
  2178. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2179. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2180. SocketOptions socket_options_ = default_socket_options;
  2181. Headers default_headers_;
  2182. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2183. detail::write_headers;
  2184. };
  2185. class Result {
  2186. public:
  2187. Result() = default;
  2188. Result(std::unique_ptr<Response> &&res, Error err,
  2189. Headers &&request_headers = Headers{})
  2190. : res_(std::move(res)), err_(err),
  2191. request_headers_(std::move(request_headers)) {}
  2192. // Response
  2193. operator bool() const { return res_ != nullptr; }
  2194. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2195. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2196. const Response &value() const { return *res_; }
  2197. Response &value() { return *res_; }
  2198. const Response &operator*() const { return *res_; }
  2199. Response &operator*() { return *res_; }
  2200. const Response *operator->() const { return res_.get(); }
  2201. Response *operator->() { return res_.get(); }
  2202. // Error
  2203. Error error() const { return err_; }
  2204. // Request Headers
  2205. bool has_request_header(const std::string &key) const;
  2206. std::string get_request_header_value(const std::string &key,
  2207. const char *def = "",
  2208. size_t id = 0) const;
  2209. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2210. size_t id = 0) const;
  2211. size_t get_request_header_value_count(const std::string &key) const;
  2212. private:
  2213. std::unique_ptr<Response> res_;
  2214. Error err_ = Error::Unknown;
  2215. Headers request_headers_;
  2216. #ifdef CPPHTTPLIB_SSL_ENABLED
  2217. public:
  2218. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2219. int ssl_error)
  2220. : res_(std::move(res)), err_(err),
  2221. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2222. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2223. int ssl_error, uint64_t ssl_backend_error)
  2224. : res_(std::move(res)), err_(err),
  2225. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2226. ssl_backend_error_(ssl_backend_error) {}
  2227. int ssl_error() const { return ssl_error_; }
  2228. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2229. private:
  2230. int ssl_error_ = 0;
  2231. uint64_t ssl_backend_error_ = 0;
  2232. #endif
  2233. };
  2234. struct ClientConnection {
  2235. socket_t sock = INVALID_SOCKET;
  2236. bool is_open() const { return sock != INVALID_SOCKET; }
  2237. ClientConnection() = default;
  2238. ~ClientConnection();
  2239. ClientConnection(const ClientConnection &) = delete;
  2240. ClientConnection &operator=(const ClientConnection &) = delete;
  2241. ClientConnection(ClientConnection &&other) noexcept
  2242. : sock(other.sock)
  2243. #ifdef CPPHTTPLIB_SSL_ENABLED
  2244. ,
  2245. session(other.session)
  2246. #endif
  2247. {
  2248. other.sock = INVALID_SOCKET;
  2249. #ifdef CPPHTTPLIB_SSL_ENABLED
  2250. other.session = nullptr;
  2251. #endif
  2252. }
  2253. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2254. if (this != &other) {
  2255. sock = other.sock;
  2256. other.sock = INVALID_SOCKET;
  2257. #ifdef CPPHTTPLIB_SSL_ENABLED
  2258. session = other.session;
  2259. other.session = nullptr;
  2260. #endif
  2261. }
  2262. return *this;
  2263. }
  2264. #ifdef CPPHTTPLIB_SSL_ENABLED
  2265. tls::session_t session = nullptr;
  2266. #endif
  2267. };
  2268. namespace detail {
  2269. struct ChunkedDecoder;
  2270. struct BodyReader {
  2271. Stream *stream = nullptr;
  2272. bool has_content_length = false;
  2273. size_t content_length = 0;
  2274. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2275. size_t bytes_read = 0;
  2276. bool chunked = false;
  2277. bool eof = false;
  2278. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2279. Error last_error = Error::Success;
  2280. ssize_t read(char *buf, size_t len);
  2281. bool has_error() const { return last_error != Error::Success; }
  2282. };
  2283. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2284. size_t len) {
  2285. (void)stream;
  2286. return br.read(buf, len);
  2287. }
  2288. class decompressor;
  2289. enum class NoProxyKind {
  2290. Wildcard, // "*"
  2291. HostnameSuffix, // "example.com" or ".example.com"
  2292. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2293. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2294. };
  2295. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2296. // Lets one CIDR matcher cover both families.
  2297. using IPBytes = std::array<uint8_t, 16>;
  2298. struct NoProxyEntry {
  2299. NoProxyKind kind = NoProxyKind::Wildcard;
  2300. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2301. IPBytes net{};
  2302. int prefix_bits = 0;
  2303. };
  2304. struct NormalizedTarget {
  2305. std::string hostname; // lowercase; brackets and trailing dot removed
  2306. bool is_ipv4 = false;
  2307. bool is_ipv6 = false;
  2308. IPBytes ip{};
  2309. };
  2310. } // namespace detail
  2311. class ClientImpl {
  2312. public:
  2313. explicit ClientImpl(const std::string &host);
  2314. explicit ClientImpl(const std::string &host, int port);
  2315. explicit ClientImpl(const std::string &host, int port,
  2316. const std::string &client_cert_path,
  2317. const std::string &client_key_path);
  2318. virtual ~ClientImpl();
  2319. virtual bool is_valid() const;
  2320. struct StreamHandle {
  2321. std::unique_ptr<Response> response;
  2322. Error error = Error::Success;
  2323. StreamHandle() = default;
  2324. StreamHandle(const StreamHandle &) = delete;
  2325. StreamHandle &operator=(const StreamHandle &) = delete;
  2326. StreamHandle(StreamHandle &&) = default;
  2327. StreamHandle &operator=(StreamHandle &&) = default;
  2328. ~StreamHandle() = default;
  2329. bool is_valid() const {
  2330. return response != nullptr && error == Error::Success;
  2331. }
  2332. ssize_t read(char *buf, size_t len);
  2333. void parse_trailers_if_needed();
  2334. Error get_read_error() const { return body_reader_.last_error; }
  2335. bool has_read_error() const { return body_reader_.has_error(); }
  2336. bool trailers_parsed_ = false;
  2337. private:
  2338. friend class ClientImpl;
  2339. friend class sse::SSEClient;
  2340. ssize_t read_with_decompression(char *buf, size_t len);
  2341. std::unique_ptr<ClientConnection> connection_;
  2342. std::unique_ptr<Stream> socket_stream_;
  2343. Stream *stream_ = nullptr;
  2344. detail::BodyReader body_reader_;
  2345. std::unique_ptr<detail::decompressor> decompressor_;
  2346. std::string decompress_buffer_;
  2347. size_t decompress_offset_ = 0;
  2348. size_t decompressed_bytes_read_ = 0;
  2349. };
  2350. // clang-format off
  2351. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2352. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2353. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2354. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2355. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2356. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2357. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2358. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2359. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2360. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2361. Result Head(const std::string &path);
  2362. Result Head(const std::string &path, const Headers &headers);
  2363. Result Post(const std::string &path);
  2364. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2365. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2366. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2367. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2368. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2369. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2370. Result Post(const std::string &path, const Params &params);
  2371. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2372. Result Post(const std::string &path, const Headers &headers);
  2373. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2374. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2375. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2376. 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);
  2377. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2378. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2379. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2380. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2381. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2382. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2383. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2384. Result Put(const std::string &path);
  2385. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2386. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2387. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2388. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2389. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2390. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2391. Result Put(const std::string &path, const Params &params);
  2392. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2393. Result Put(const std::string &path, const Headers &headers);
  2394. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2395. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2396. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2397. 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);
  2398. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2399. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2400. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2401. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2402. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2403. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2404. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2405. Result Patch(const std::string &path);
  2406. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2407. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2408. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2409. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2410. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2411. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2412. Result Patch(const std::string &path, const Params &params);
  2413. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2414. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2415. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2416. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2417. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2418. 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);
  2419. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2420. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2421. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2422. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2423. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2424. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2425. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2426. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2427. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2428. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2429. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2430. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2431. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2432. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2433. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2434. Result Options(const std::string &path);
  2435. Result Options(const std::string &path, const Headers &headers);
  2436. // clang-format on
  2437. // Streaming API: Open a stream for reading response body incrementally
  2438. // Socket ownership is transferred to StreamHandle for true streaming
  2439. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2440. StreamHandle open_stream(const std::string &method, const std::string &path,
  2441. const Params &params = {},
  2442. const Headers &headers = {},
  2443. const std::string &body = {},
  2444. const std::string &content_type = {});
  2445. bool send(Request &req, Response &res, Error &error);
  2446. Result send(const Request &req);
  2447. void stop();
  2448. std::string host() const;
  2449. int port() const;
  2450. size_t is_socket_open() const;
  2451. socket_t socket() const;
  2452. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  2453. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2454. void
  2455. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2456. void
  2457. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2458. void set_default_headers(Headers headers);
  2459. void
  2460. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2461. void set_address_family(int family);
  2462. void set_tcp_nodelay(bool on);
  2463. void set_ipv6_v6only(bool on);
  2464. void set_socket_options(SocketOptions socket_options);
  2465. void set_connection_timeout(time_t sec, time_t usec = 0);
  2466. template <class Rep, class Period>
  2467. void
  2468. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2469. void set_read_timeout(time_t sec, time_t usec = 0);
  2470. template <class Rep, class Period>
  2471. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2472. void set_write_timeout(time_t sec, time_t usec = 0);
  2473. template <class Rep, class Period>
  2474. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2475. void set_max_timeout(time_t msec);
  2476. template <class Rep, class Period>
  2477. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2478. void set_basic_auth(const std::string &username, const std::string &password);
  2479. void set_bearer_token_auth(const std::string &token);
  2480. void set_keep_alive(bool on);
  2481. void set_follow_location(bool on);
  2482. void set_path_encode(bool on);
  2483. void set_compress(bool on);
  2484. void set_decompress(bool on);
  2485. void set_payload_max_length(size_t length);
  2486. void set_interface(const std::string &intf);
  2487. void set_proxy(const std::string &host, int port);
  2488. void set_proxy_basic_auth(const std::string &username,
  2489. const std::string &password);
  2490. void set_proxy_bearer_token_auth(const std::string &token);
  2491. void set_no_proxy(const std::vector<std::string> &patterns);
  2492. void set_logger(Logger logger);
  2493. void set_error_logger(ErrorLogger error_logger);
  2494. protected:
  2495. struct Socket {
  2496. socket_t sock = INVALID_SOCKET;
  2497. // For Mbed TLS compatibility: start_time for request timeout tracking
  2498. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2499. bool is_open() const { return sock != INVALID_SOCKET; }
  2500. #ifdef CPPHTTPLIB_SSL_ENABLED
  2501. tls::session_t ssl = nullptr;
  2502. #endif
  2503. };
  2504. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2505. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2506. virtual bool setup_proxy_connection(
  2507. Socket &socket,
  2508. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2509. Response &res, bool &success, Error &error);
  2510. bool is_proxy_enabled_for_host(const std::string &host) const;
  2511. // All of:
  2512. // shutdown_ssl
  2513. // shutdown_socket
  2514. // close_socket
  2515. // disconnect
  2516. // should ONLY be called on socket_ with socket_mutex_ locked, or on a
  2517. // connection being opened, and only when no other thread is using it.
  2518. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2519. void shutdown_socket(Socket &socket) const;
  2520. void close_socket(Socket &socket);
  2521. void disconnect(bool gracefully);
  2522. // Under socket_mutex_: whether the connection kept alive can take another
  2523. // request. One with anything to read, or one set up under TLS settings
  2524. // changed since, is closed instead.
  2525. bool socket_reusable();
  2526. // Makes socket_ ready for a request, with socket_mutex_ held by guard. A new
  2527. // connection is opened without the lock, so that stop() can end it.
  2528. bool
  2529. prepare_socket(std::unique_lock<std::mutex> &guard,
  2530. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2531. Response &res, bool &success, Error &error);
  2532. // TLS settings apply as a connection is set up, so a change makes the
  2533. // connection kept alive unfit for the next request.
  2534. void tls_settings_changed() { tls_settings_version_++; }
  2535. std::string make_request_target(const Request &req) const;
  2536. bool process_request(Stream &strm, Request &req, Response &res,
  2537. bool close_connection, Error &error);
  2538. bool write_content_with_provider(Stream &strm, const Request &req,
  2539. Error &error) const;
  2540. void output_log(const Request &req, const Response &res) const;
  2541. void output_error_log(const Error &err, const Request *req) const;
  2542. // Socket endpoint information
  2543. const std::string host_;
  2544. const int port_;
  2545. // Current open socket
  2546. Socket socket_;
  2547. mutable std::mutex socket_mutex_;
  2548. std::recursive_mutex request_mutex_;
  2549. // How many send() calls are running on this client, guarded by
  2550. // request_mutex_
  2551. size_t send_depth_ = 0;
  2552. // Also guarded by request_mutex_
  2553. size_t socket_tls_settings_version_ = 0;
  2554. // These are all protected under socket_mutex
  2555. size_t socket_requests_in_flight_ = 0;
  2556. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2557. bool socket_should_be_closed_when_request_is_done_ = false;
  2558. // Set by stop(), cleared as a send() or an open_stream() starts. Its waits
  2559. // poll it: shutdown() does not reach a connection being opened, nor wake a
  2560. // read on Windows.
  2561. std::atomic<bool> stop_requested_{false};
  2562. std::function<bool()> stop_interrupt() const {
  2563. return [this] { return stop_requested_.load(); };
  2564. }
  2565. std::atomic<size_t> tls_settings_version_{0};
  2566. // Hostname to connection target map. The value is an IP literal or another
  2567. // hostname; only the connection target changes, never the identity.
  2568. std::map<std::string, std::string> addr_map_;
  2569. // Hostname to CONNECT target map, used only through a proxy.
  2570. std::map<std::string, std::string> tunnel_addr_map_;
  2571. // Default headers
  2572. Headers default_headers_;
  2573. // Header writer
  2574. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2575. detail::write_headers;
  2576. // Settings
  2577. std::string client_cert_path_;
  2578. std::string client_key_path_;
  2579. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2580. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2581. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2582. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2583. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2584. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2585. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2586. std::string basic_auth_username_;
  2587. std::string basic_auth_password_;
  2588. std::string bearer_token_auth_token_;
  2589. bool keep_alive_ = false;
  2590. bool follow_location_ = false;
  2591. bool path_encode_ = true;
  2592. int address_family_ = AF_UNSPEC;
  2593. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2594. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2595. SocketOptions socket_options_ = nullptr;
  2596. bool compress_ = false;
  2597. bool decompress_ = true;
  2598. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2599. bool has_payload_max_length_ = false;
  2600. std::string interface_;
  2601. std::string proxy_host_;
  2602. int proxy_port_ = -1;
  2603. std::string proxy_basic_auth_username_;
  2604. std::string proxy_basic_auth_password_;
  2605. std::string proxy_bearer_token_auth_token_;
  2606. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2607. mutable detail::NormalizedTarget host_normalized_;
  2608. mutable bool host_normalized_valid_ = false;
  2609. mutable std::mutex logger_mutex_;
  2610. Logger logger_;
  2611. ErrorLogger error_logger_;
  2612. private:
  2613. bool send_(Request &req, Response &res, Error &error);
  2614. Result send_(Request &&req);
  2615. socket_t create_client_socket(Error &error) const;
  2616. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2617. bool skip_100_continue = true) const;
  2618. bool write_request(Stream &strm, Request &req, bool close_connection,
  2619. Error &error, bool skip_body, bool &rejected_locally);
  2620. bool write_request_body(Stream &strm, Request &req, Error &error);
  2621. void prepare_default_headers(Request &r, bool for_stream,
  2622. const std::string &ct);
  2623. bool redirect(Request &req, Response &res, Error &error);
  2624. bool create_redirect_client(const std::string &scheme,
  2625. const std::string &host, int port, Request &req,
  2626. Response &res, const std::string &path,
  2627. const std::string &location, Error &error);
  2628. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2629. bool handle_request(Stream &strm, Request &req, Response &res,
  2630. bool close_connection, Error &error);
  2631. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2632. Request &req, const char *body, size_t content_length,
  2633. ContentProvider content_provider,
  2634. ContentProviderWithoutLength content_provider_without_length,
  2635. const std::string &content_type, ContentReceiver content_receiver,
  2636. Error &error);
  2637. Result send_with_content_provider_and_receiver(
  2638. const std::string &method, const std::string &path,
  2639. const Headers &headers, const char *body, size_t content_length,
  2640. ContentProvider content_provider,
  2641. ContentProviderWithoutLength content_provider_without_length,
  2642. const std::string &content_type, ContentReceiver content_receiver,
  2643. UploadProgress progress);
  2644. ContentProviderWithoutLength get_multipart_content_provider(
  2645. const std::string &boundary, const UploadFormDataItems &items,
  2646. const FormDataProviderItems &provider_items) const;
  2647. virtual bool
  2648. process_socket(const Socket &socket,
  2649. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2650. std::function<bool(Stream &strm)> callback);
  2651. virtual bool is_ssl() const;
  2652. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2653. StreamHandle open_stream_(Request &req);
  2654. void add_credential_headers(Request &req);
  2655. std::string proxy_target_prefix() const;
  2656. #ifdef CPPHTTPLIB_SSL_ENABLED
  2657. public:
  2658. void set_digest_auth(const std::string &username,
  2659. const std::string &password);
  2660. void set_proxy_digest_auth(const std::string &username,
  2661. const std::string &password);
  2662. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2663. const std::string &ca_cert_dir_path = std::string());
  2664. void enable_server_certificate_verification(bool enabled);
  2665. void enable_server_hostname_verification(bool enabled);
  2666. void enable_system_ca(bool enabled);
  2667. protected:
  2668. std::string digest_auth_username_;
  2669. std::string digest_auth_password_;
  2670. std::string proxy_digest_auth_username_;
  2671. std::string proxy_digest_auth_password_;
  2672. std::string ca_cert_file_path_;
  2673. std::string ca_cert_dir_path_;
  2674. bool server_certificate_verification_ = true;
  2675. bool server_hostname_verification_ = true;
  2676. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2677. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2678. int last_ssl_error_ = 0;
  2679. uint64_t last_backend_error_ = 0;
  2680. #endif
  2681. };
  2682. namespace detail {
  2683. // Stands in for a client that Client could not make from its arguments, so a
  2684. // request fails rather than going through a null pointer.
  2685. class InvalidClientImpl final : public ClientImpl {
  2686. public:
  2687. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2688. bool is_valid() const override { return false; }
  2689. private:
  2690. bool create_and_connect_socket(Socket &, Error &error) override {
  2691. error = Error::Connection;
  2692. return false;
  2693. }
  2694. };
  2695. } // namespace detail
  2696. class Client {
  2697. public:
  2698. // Universal interface
  2699. explicit Client(const std::string &scheme_host_port);
  2700. explicit Client(const std::string &scheme_host_port,
  2701. const std::string &client_cert_path,
  2702. const std::string &client_key_path);
  2703. // HTTP only interface
  2704. explicit Client(const std::string &host, int port);
  2705. explicit Client(const std::string &host, int port,
  2706. const std::string &client_cert_path,
  2707. const std::string &client_key_path);
  2708. Client(Client &&) = default;
  2709. Client &operator=(Client &&) = default;
  2710. ~Client();
  2711. bool is_valid() const;
  2712. // clang-format off
  2713. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2714. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2715. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2716. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2717. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2718. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2719. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2720. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2721. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2722. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2723. Result Head(const std::string &path);
  2724. Result Head(const std::string &path, const Headers &headers);
  2725. Result Post(const std::string &path);
  2726. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2727. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2728. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2729. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2730. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2731. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2732. Result Post(const std::string &path, const Params &params);
  2733. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2734. Result Post(const std::string &path, const Headers &headers);
  2735. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2736. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2737. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2738. 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);
  2739. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2740. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2741. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2742. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2743. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2744. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2745. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2746. Result Put(const std::string &path);
  2747. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2748. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2749. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2750. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2751. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2752. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2753. Result Put(const std::string &path, const Params &params);
  2754. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2755. Result Put(const std::string &path, const Headers &headers);
  2756. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2757. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2758. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2759. 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);
  2760. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2761. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2762. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2763. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2764. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2765. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2766. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2767. Result Patch(const std::string &path);
  2768. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2769. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2770. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2771. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2772. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2773. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2774. Result Patch(const std::string &path, const Params &params);
  2775. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2776. Result Patch(const std::string &path, const Headers &headers);
  2777. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2778. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2779. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2780. 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);
  2781. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2782. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2783. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2784. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2785. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2786. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2787. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2788. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2789. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2790. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2791. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2792. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2793. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2794. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2795. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2796. Result Options(const std::string &path);
  2797. Result Options(const std::string &path, const Headers &headers);
  2798. // clang-format on
  2799. // Streaming API: Open a stream for reading response body incrementally
  2800. // Socket ownership is transferred to StreamHandle for true streaming
  2801. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2802. ClientImpl::StreamHandle open_stream(const std::string &method,
  2803. const std::string &path,
  2804. const Params &params = {},
  2805. const Headers &headers = {},
  2806. const std::string &body = {},
  2807. const std::string &content_type = {});
  2808. bool send(Request &req, Response &res, Error &error);
  2809. Result send(const Request &req);
  2810. void stop();
  2811. std::string host() const;
  2812. int port() const;
  2813. size_t is_socket_open() const;
  2814. socket_t socket() const;
  2815. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  2816. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2817. void
  2818. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2819. void
  2820. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2821. void set_default_headers(Headers headers);
  2822. void
  2823. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2824. void set_address_family(int family);
  2825. void set_tcp_nodelay(bool on);
  2826. void set_socket_options(SocketOptions socket_options);
  2827. void set_connection_timeout(time_t sec, time_t usec = 0);
  2828. template <class Rep, class Period>
  2829. void
  2830. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2831. void set_read_timeout(time_t sec, time_t usec = 0);
  2832. template <class Rep, class Period>
  2833. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2834. void set_write_timeout(time_t sec, time_t usec = 0);
  2835. template <class Rep, class Period>
  2836. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2837. void set_max_timeout(time_t msec);
  2838. template <class Rep, class Period>
  2839. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2840. void set_basic_auth(const std::string &username, const std::string &password);
  2841. void set_bearer_token_auth(const std::string &token);
  2842. void set_keep_alive(bool on);
  2843. void set_follow_location(bool on);
  2844. void set_path_encode(bool on);
  2845. void set_compress(bool on);
  2846. void set_decompress(bool on);
  2847. void set_payload_max_length(size_t length);
  2848. void set_interface(const std::string &intf);
  2849. void set_proxy(const std::string &host, int port);
  2850. void set_proxy_basic_auth(const std::string &username,
  2851. const std::string &password);
  2852. void set_proxy_bearer_token_auth(const std::string &token);
  2853. void set_no_proxy(const std::vector<std::string> &patterns);
  2854. void set_logger(Logger logger);
  2855. void set_error_logger(ErrorLogger error_logger);
  2856. private:
  2857. std::unique_ptr<ClientImpl> cli_;
  2858. #ifdef CPPHTTPLIB_SSL_ENABLED
  2859. public:
  2860. void set_digest_auth(const std::string &username,
  2861. const std::string &password);
  2862. void set_proxy_digest_auth(const std::string &username,
  2863. const std::string &password);
  2864. void enable_server_certificate_verification(bool enabled);
  2865. void enable_server_hostname_verification(bool enabled);
  2866. void enable_system_ca(bool enabled);
  2867. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2868. const std::string &ca_cert_dir_path = std::string());
  2869. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2870. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2871. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2872. void set_session_verifier(
  2873. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2874. tls::ctx_t tls_context() const;
  2875. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2876. void enable_windows_certificate_verification(bool enabled);
  2877. #endif
  2878. private:
  2879. bool is_ssl_ = false;
  2880. #endif
  2881. };
  2882. #ifdef CPPHTTPLIB_SSL_ENABLED
  2883. class SSLServer : public Server {
  2884. public:
  2885. SSLServer(const char *cert_path, const char *private_key_path,
  2886. const char *client_ca_cert_file_path = nullptr,
  2887. const char *client_ca_cert_dir_path = nullptr,
  2888. const char *private_key_password = nullptr);
  2889. struct PemMemory {
  2890. const char *cert_pem;
  2891. size_t cert_pem_len;
  2892. const char *key_pem;
  2893. size_t key_pem_len;
  2894. const char *client_ca_pem;
  2895. size_t client_ca_pem_len;
  2896. const char *private_key_password;
  2897. };
  2898. explicit SSLServer(const PemMemory &pem);
  2899. // The callback receives the ctx_t handle which can be cast to the
  2900. // appropriate backend type (SSL_CTX* for OpenSSL,
  2901. // tls::impl::MbedTlsContext* for Mbed TLS)
  2902. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2903. ~SSLServer() override;
  2904. bool is_valid() const override;
  2905. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2906. const char *client_ca_pem = nullptr,
  2907. const char *password = nullptr);
  2908. tls::ctx_t tls_context() const { return ctx_; }
  2909. int ssl_last_error() const { return last_ssl_error_; }
  2910. private:
  2911. bool process_and_close_socket(socket_t sock) override;
  2912. tls::ctx_t ctx_ = nullptr;
  2913. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2914. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2915. // bounds, and new ones wait while it is pending so that they cannot keep it
  2916. // waiting.
  2917. std::mutex ctx_mutex_;
  2918. std::condition_variable ctx_cv_;
  2919. size_t handshakes_in_progress_ = 0;
  2920. size_t updates_pending_ = 0;
  2921. int last_ssl_error_ = 0;
  2922. };
  2923. class SSLClient final : public ClientImpl {
  2924. public:
  2925. explicit SSLClient(const std::string &host);
  2926. explicit SSLClient(const std::string &host, int port);
  2927. explicit SSLClient(const std::string &host, int port,
  2928. const std::string &client_cert_path,
  2929. const std::string &client_key_path,
  2930. const std::string &private_key_password = std::string());
  2931. struct PemMemory {
  2932. const char *cert_pem;
  2933. size_t cert_pem_len;
  2934. const char *key_pem;
  2935. size_t key_pem_len;
  2936. const char *private_key_password;
  2937. };
  2938. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2939. ~SSLClient() override;
  2940. bool is_valid() const override;
  2941. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2942. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2943. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2944. // Post-handshake session verifier (backend-independent)
  2945. void set_session_verifier(
  2946. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2947. tls::ctx_t tls_context() const { return ctx_; }
  2948. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2949. void enable_windows_certificate_verification(bool enabled);
  2950. #endif
  2951. private:
  2952. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2953. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2954. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2955. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2956. bool
  2957. process_socket(const Socket &socket,
  2958. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2959. std::function<bool(Stream &strm)> callback) override;
  2960. bool is_ssl() const override;
  2961. bool setup_proxy_connection(
  2962. Socket &socket,
  2963. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2964. Response &res, bool &success, Error &error) override;
  2965. bool connect_with_proxy(
  2966. Socket &sock,
  2967. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2968. Response &res, bool &success, Error &error);
  2969. bool initialize_ssl(Socket &socket, Error &error);
  2970. void init_ctx();
  2971. void reset_ctx_on_error();
  2972. bool load_certs();
  2973. tls::ctx_t ctx_ = nullptr;
  2974. std::mutex ctx_mutex_;
  2975. std::once_flag initialize_cert_;
  2976. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2977. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2978. bool ca_cert_store_set_ = false;
  2979. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  2980. // no certificate, so that a CA that failed to come through fails
  2981. // verification instead of letting the system CAs in.
  2982. bool custom_ca_loaded_ = false;
  2983. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2984. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2985. // set_server_certificate_verifier() installed there.
  2986. tls::VerifyCallback server_certificate_verifier_;
  2987. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2988. bool enable_windows_cert_verification_ = true;
  2989. #endif
  2990. friend class ClientImpl;
  2991. };
  2992. #endif // CPPHTTPLIB_SSL_ENABLED
  2993. namespace detail {
  2994. template <typename T, typename U>
  2995. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2996. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2997. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2998. duration - std::chrono::seconds(sec))
  2999. .count();
  3000. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  3001. }
  3002. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  3003. return N - 1;
  3004. }
  3005. inline bool is_numeric(const std::string &str) {
  3006. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  3007. }
  3008. // std::ranges::next(first, n, last) for C++11
  3009. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  3010. for (; n > 0 && first != last; --n) {
  3011. ++first;
  3012. }
  3013. return first;
  3014. }
  3015. inline size_t get_header_value_u64(const Headers &headers,
  3016. const std::string &key, size_t def,
  3017. size_t id, bool &is_invalid_value) {
  3018. is_invalid_value = false;
  3019. auto rng = headers.equal_range(key);
  3020. auto it = bounded_next(rng.first, id, rng.second);
  3021. if (it != rng.second) {
  3022. if (is_numeric(it->second)) {
  3023. // Parse at size_t width so an out-of-range Content-Length is reported
  3024. // rather than silently saturated/truncated (a value above 2^32 would
  3025. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  3026. // and return SIZE_MAX so the existing oversized-value guards reject it.
  3027. size_t val = 0;
  3028. const auto &s = it->second;
  3029. auto r = from_chars(s.data(), s.data() + s.size(), val);
  3030. if (r.ec == std::errc::result_out_of_range) {
  3031. is_invalid_value = true;
  3032. return (std::numeric_limits<size_t>::max)();
  3033. }
  3034. return val;
  3035. } else {
  3036. is_invalid_value = true;
  3037. }
  3038. }
  3039. return def;
  3040. }
  3041. inline size_t get_header_value_u64(const Headers &headers,
  3042. const std::string &key, size_t def,
  3043. size_t id) {
  3044. auto dummy = false;
  3045. return get_header_value_u64(headers, key, def, id, dummy);
  3046. }
  3047. } // namespace detail
  3048. template <class Rep, class Period>
  3049. inline Server &
  3050. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3051. detail::duration_to_sec_and_usec(
  3052. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3053. return *this;
  3054. }
  3055. template <class Rep, class Period>
  3056. inline Server &
  3057. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3058. detail::duration_to_sec_and_usec(
  3059. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3060. return *this;
  3061. }
  3062. template <class Rep, class Period>
  3063. inline Server &
  3064. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  3065. detail::duration_to_sec_and_usec(
  3066. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  3067. return *this;
  3068. }
  3069. template <class Rep, class Period>
  3070. inline void ClientImpl::set_connection_timeout(
  3071. const std::chrono::duration<Rep, Period> &duration) {
  3072. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3073. set_connection_timeout(sec, usec);
  3074. });
  3075. }
  3076. template <class Rep, class Period>
  3077. inline void ClientImpl::set_read_timeout(
  3078. const std::chrono::duration<Rep, Period> &duration) {
  3079. detail::duration_to_sec_and_usec(
  3080. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3081. }
  3082. template <class Rep, class Period>
  3083. inline void ClientImpl::set_write_timeout(
  3084. const std::chrono::duration<Rep, Period> &duration) {
  3085. detail::duration_to_sec_and_usec(
  3086. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3087. }
  3088. template <class Rep, class Period>
  3089. inline void ClientImpl::set_max_timeout(
  3090. const std::chrono::duration<Rep, Period> &duration) {
  3091. auto msec =
  3092. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  3093. set_max_timeout(static_cast<time_t>(msec));
  3094. }
  3095. template <class Rep, class Period>
  3096. inline void Client::set_connection_timeout(
  3097. const std::chrono::duration<Rep, Period> &duration) {
  3098. cli_->set_connection_timeout(duration);
  3099. }
  3100. template <class Rep, class Period>
  3101. inline void
  3102. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3103. cli_->set_read_timeout(duration);
  3104. }
  3105. template <class Rep, class Period>
  3106. inline void
  3107. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3108. cli_->set_write_timeout(duration);
  3109. }
  3110. inline void Client::set_max_timeout(time_t msec) {
  3111. cli_->set_max_timeout(msec);
  3112. }
  3113. template <class Rep, class Period>
  3114. inline void
  3115. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3116. cli_->set_max_timeout(duration);
  3117. }
  3118. /*
  3119. * Forward declarations and types that will be part of the .h file if split into
  3120. * .h + .cc.
  3121. */
  3122. std::string hosted_at(const std::string &hostname);
  3123. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3124. // JavaScript-style URL encoding/decoding functions
  3125. std::string encode_uri_component(const std::string &value);
  3126. std::string encode_uri(const std::string &value);
  3127. std::string decode_uri_component(const std::string &value);
  3128. std::string decode_uri(const std::string &value);
  3129. // RFC 3986 compliant URL component encoding/decoding functions
  3130. std::string encode_path_component(const std::string &component);
  3131. std::string decode_path_component(const std::string &component);
  3132. std::string encode_query_component(const std::string &component,
  3133. bool space_as_plus = true);
  3134. std::string decode_query_component(const std::string &component,
  3135. bool plus_as_space = true);
  3136. std::string sanitize_filename(const std::string &filename);
  3137. std::string append_query_params(const std::string &path, const Params &params);
  3138. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3139. std::pair<std::string, std::string>
  3140. make_basic_authentication_header(const std::string &username,
  3141. const std::string &password,
  3142. bool is_proxy = false);
  3143. namespace detail {
  3144. #if defined(_WIN32)
  3145. inline std::wstring u8string_to_wstring(const char *s) {
  3146. if (!s) { return std::wstring(); }
  3147. auto len = static_cast<int>(strlen(s));
  3148. if (!len) { return std::wstring(); }
  3149. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3150. if (!wlen) { return std::wstring(); }
  3151. std::wstring ws;
  3152. ws.resize(wlen);
  3153. wlen = ::MultiByteToWideChar(
  3154. CP_UTF8, 0, s, len,
  3155. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3156. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3157. return ws;
  3158. }
  3159. #endif
  3160. struct FileStat {
  3161. FileStat(const std::string &path);
  3162. bool is_file() const;
  3163. bool is_dir() const;
  3164. time_t mtime() const;
  3165. size_t size() const;
  3166. private:
  3167. #if defined(_WIN32)
  3168. struct _stat st_;
  3169. #else
  3170. struct stat st_;
  3171. #endif
  3172. int ret_ = -1;
  3173. };
  3174. std::string make_host_and_port_string(const std::string &host, int port,
  3175. bool is_ssl);
  3176. template <typename T>
  3177. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3178. Error &error);
  3179. bool write_data(Stream &strm, const char *d, size_t l);
  3180. std::string trim_copy(const std::string &s);
  3181. void divide(
  3182. const char *data, std::size_t size, char d,
  3183. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3184. fn);
  3185. void divide(
  3186. const std::string &str, char d,
  3187. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3188. fn);
  3189. void split(const char *b, const char *e, char d,
  3190. std::function<void(const char *, const char *)> fn);
  3191. void split(const char *b, const char *e, char d, size_t m,
  3192. std::function<void(const char *, const char *)> fn);
  3193. bool split_find(const char *b, const char *e, char d,
  3194. std::function<bool(const char *, const char *)> fn);
  3195. bool has_header_token(const Headers &headers, const std::string &key,
  3196. const std::string &token);
  3197. std::string websocket_accept_key(const std::string &client_key);
  3198. bool is_websocket_upgrade(const Request &req);
  3199. bool process_client_socket(
  3200. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3201. time_t write_timeout_sec, time_t write_timeout_usec,
  3202. time_t max_timeout_msec,
  3203. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3204. std::function<bool(Stream &)> callback);
  3205. socket_t create_client_socket(
  3206. const std::string &host, const std::string &ip, int port,
  3207. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  3208. SocketOptions socket_options, time_t connection_timeout_sec,
  3209. time_t connection_timeout_usec, time_t read_timeout_sec,
  3210. time_t read_timeout_usec, time_t write_timeout_sec,
  3211. time_t write_timeout_usec, const std::string &intf, Error &error,
  3212. const std::function<bool()> &interrupted = nullptr);
  3213. const char *get_header_value(const Headers &headers, const std::string &key,
  3214. const char *def, size_t id);
  3215. std::string get_combined_header_value(const Headers &headers,
  3216. const std::string &key);
  3217. std::string params_to_query_str(const Params &params);
  3218. void parse_query_text(const char *data, std::size_t size, Params &params);
  3219. void parse_query_text(const std::string &s, Params &params);
  3220. bool parse_multipart_boundary(const std::string &content_type,
  3221. std::string &boundary);
  3222. bool parse_range_header(const std::string &s, Ranges &ranges);
  3223. bool parse_accept_header(const std::string &s,
  3224. std::vector<std::string> &content_types);
  3225. void parse_disposition_params(const std::string &s, Params &params);
  3226. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3227. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3228. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3229. EncodingType encoding_type(const Request &req, const Response &res,
  3230. const std::string &content_type);
  3231. EncodingType encoding_type(const Request &req, const Response &res);
  3232. class BufferStream final : public Stream {
  3233. public:
  3234. BufferStream() = default;
  3235. ~BufferStream() override = default;
  3236. bool is_readable() const override;
  3237. bool wait_readable() const override;
  3238. bool wait_writable() const override;
  3239. ssize_t read(char *ptr, size_t size) override;
  3240. ssize_t write(const char *ptr, size_t size) override;
  3241. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3242. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3243. socket_t socket() const override;
  3244. time_t duration() const override;
  3245. const std::string &get_buffer() const;
  3246. private:
  3247. std::string buffer;
  3248. size_t position = 0;
  3249. };
  3250. class compressor {
  3251. public:
  3252. virtual ~compressor() = default;
  3253. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3254. virtual bool compress(const char *data, size_t data_length, bool last,
  3255. Callback callback) = 0;
  3256. };
  3257. class decompressor {
  3258. public:
  3259. virtual ~decompressor() = default;
  3260. virtual bool is_valid() const = 0;
  3261. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3262. virtual bool decompress(const char *data, size_t data_length,
  3263. Callback callback) = 0;
  3264. };
  3265. class nocompressor final : public compressor {
  3266. public:
  3267. ~nocompressor() override = default;
  3268. bool compress(const char *data, size_t data_length, bool /*last*/,
  3269. Callback callback) override;
  3270. };
  3271. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3272. class gzip_compressor final : public compressor {
  3273. public:
  3274. gzip_compressor();
  3275. ~gzip_compressor() override;
  3276. bool compress(const char *data, size_t data_length, bool last,
  3277. Callback callback) override;
  3278. private:
  3279. bool is_valid_ = false;
  3280. z_stream strm_;
  3281. };
  3282. class gzip_decompressor final : public decompressor {
  3283. public:
  3284. gzip_decompressor();
  3285. ~gzip_decompressor() override;
  3286. bool is_valid() const override;
  3287. bool decompress(const char *data, size_t data_length,
  3288. Callback callback) override;
  3289. private:
  3290. bool is_valid_ = false;
  3291. z_stream strm_;
  3292. };
  3293. #endif
  3294. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3295. class brotli_compressor final : public compressor {
  3296. public:
  3297. brotli_compressor();
  3298. ~brotli_compressor();
  3299. bool compress(const char *data, size_t data_length, bool last,
  3300. Callback callback) override;
  3301. private:
  3302. BrotliEncoderState *state_ = nullptr;
  3303. };
  3304. class brotli_decompressor final : public decompressor {
  3305. public:
  3306. brotli_decompressor();
  3307. ~brotli_decompressor();
  3308. bool is_valid() const override;
  3309. bool decompress(const char *data, size_t data_length,
  3310. Callback callback) override;
  3311. private:
  3312. BrotliDecoderResult decoder_r;
  3313. BrotliDecoderState *decoder_s = nullptr;
  3314. };
  3315. #endif
  3316. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3317. class zstd_compressor : public compressor {
  3318. public:
  3319. zstd_compressor();
  3320. ~zstd_compressor();
  3321. bool compress(const char *data, size_t data_length, bool last,
  3322. Callback callback) override;
  3323. private:
  3324. ZSTD_CCtx *ctx_ = nullptr;
  3325. };
  3326. class zstd_decompressor : public decompressor {
  3327. public:
  3328. zstd_decompressor();
  3329. ~zstd_decompressor();
  3330. bool is_valid() const override;
  3331. bool decompress(const char *data, size_t data_length,
  3332. Callback callback) override;
  3333. private:
  3334. ZSTD_DCtx *ctx_ = nullptr;
  3335. };
  3336. #endif
  3337. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3338. // to store data. The call can set memory on stack for performance.
  3339. class stream_line_reader {
  3340. public:
  3341. stream_line_reader(Stream &strm, char *fixed_buffer,
  3342. size_t fixed_buffer_size);
  3343. const char *ptr() const;
  3344. size_t size() const;
  3345. bool end_with_crlf() const;
  3346. bool getline();
  3347. private:
  3348. void append(char c);
  3349. void append(const char *data, size_t size);
  3350. Stream &strm_;
  3351. char *fixed_buffer_;
  3352. const size_t fixed_buffer_size_;
  3353. size_t fixed_buffer_used_size_ = 0;
  3354. std::string growable_buffer_;
  3355. };
  3356. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3357. const Headers &src_headers);
  3358. struct ChunkedDecoder {
  3359. Stream &strm;
  3360. size_t chunk_remaining = 0;
  3361. bool finished = false;
  3362. char line_buf[64];
  3363. size_t last_chunk_total = 0;
  3364. size_t last_chunk_offset = 0;
  3365. size_t overhead = 0;
  3366. explicit ChunkedDecoder(Stream &s);
  3367. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3368. size_t &out_chunk_total);
  3369. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3370. };
  3371. // A regular file opened to be served: mapped on Windows, read with pread()
  3372. // elsewhere.
  3373. class mmap {
  3374. public:
  3375. mmap(const char *path);
  3376. ~mmap();
  3377. bool open(const char *path);
  3378. void close();
  3379. bool is_open() const;
  3380. size_t size() const;
  3381. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3382. // down to 0, if the file has shrunk since it was opened.
  3383. size_t read(size_t offset, char *buf, size_t len) const;
  3384. private:
  3385. #if defined(_WIN32)
  3386. HANDLE hFile_ = NULL;
  3387. HANDLE hMapping_ = NULL;
  3388. void *addr_ = nullptr;
  3389. bool is_open_empty_file = false;
  3390. #else
  3391. int fd_ = -1;
  3392. #endif
  3393. size_t size_ = 0;
  3394. };
  3395. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3396. namespace fields {
  3397. bool is_token_char(char c);
  3398. bool is_token(const std::string &s);
  3399. bool is_field_name(const std::string &s);
  3400. bool is_vchar(char c);
  3401. bool is_obs_text(char c);
  3402. bool is_field_vchar(char c);
  3403. bool is_field_content(const std::string &s);
  3404. bool is_field_value(const std::string &s);
  3405. bool is_field_valid(const std::string &name, const std::string &value);
  3406. bool is_request_target(const std::string &s);
  3407. bool is_host(const std::string &s);
  3408. } // namespace fields
  3409. } // namespace detail
  3410. /*
  3411. * TLS Abstraction Layer Declarations
  3412. */
  3413. #ifdef CPPHTTPLIB_SSL_ENABLED
  3414. // TLS abstraction layer - backend-specific type declarations
  3415. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3416. namespace tls {
  3417. namespace impl {
  3418. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3419. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3420. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3421. struct MbedTlsContext {
  3422. mbedtls_ssl_config conf;
  3423. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3424. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3425. mbedtls_entropy_context entropy;
  3426. mbedtls_ctr_drbg_context ctr_drbg;
  3427. #endif
  3428. mbedtls_x509_crt ca_chain;
  3429. mbedtls_x509_crt own_cert;
  3430. mbedtls_pk_context own_key;
  3431. bool is_server = false;
  3432. // Peer certificate required (set_verify_client()); a client defaults to true
  3433. bool verify_client = false;
  3434. // Set by tls::set_verify_callback().
  3435. VerifyCallback verify_callback;
  3436. MbedTlsContext();
  3437. ~MbedTlsContext();
  3438. MbedTlsContext(const MbedTlsContext &) = delete;
  3439. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3440. };
  3441. } // namespace impl
  3442. } // namespace tls
  3443. #endif
  3444. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3445. namespace tls {
  3446. namespace impl {
  3447. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3448. // This struct is accessible via tls::impl for use in SSL context
  3449. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3450. struct WolfSSLContext {
  3451. WOLFSSL_CTX *ctx = nullptr;
  3452. bool is_server = false;
  3453. // Peer certificate required (set_verify_client()); a client defaults to true
  3454. bool verify_client = false;
  3455. // Replaced under verify_callback_mutex()
  3456. std::shared_ptr<VerifyCallback> verify_callback;
  3457. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3458. WolfSSLContext();
  3459. ~WolfSSLContext();
  3460. WolfSSLContext(const WolfSSLContext &) = delete;
  3461. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3462. };
  3463. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3464. struct WolfSSLCAStore {
  3465. std::string pem_data;
  3466. };
  3467. } // namespace impl
  3468. } // namespace tls
  3469. #endif
  3470. #endif // CPPHTTPLIB_SSL_ENABLED
  3471. namespace stream {
  3472. class Result {
  3473. public:
  3474. Result();
  3475. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3476. Result(Result &&other) noexcept;
  3477. Result &operator=(Result &&other) noexcept;
  3478. Result(const Result &) = delete;
  3479. Result &operator=(const Result &) = delete;
  3480. // Response info
  3481. bool is_valid() const;
  3482. explicit operator bool() const;
  3483. int status() const;
  3484. const Headers &headers() const;
  3485. std::string get_header_value(const std::string &key,
  3486. const char *def = "") const;
  3487. bool has_header(const std::string &key) const;
  3488. Error error() const;
  3489. Error read_error() const;
  3490. bool has_read_error() const;
  3491. // Stream reading
  3492. bool next();
  3493. const char *data() const;
  3494. size_t size() const;
  3495. std::string read_all();
  3496. private:
  3497. ClientImpl::StreamHandle handle_;
  3498. std::string buffer_;
  3499. size_t current_size_ = 0;
  3500. size_t chunk_size_;
  3501. bool finished_ = false;
  3502. };
  3503. // GET
  3504. template <typename ClientType>
  3505. inline Result Get(ClientType &cli, const std::string &path,
  3506. size_t chunk_size = 8192) {
  3507. return Result{cli.open_stream("GET", path), chunk_size};
  3508. }
  3509. template <typename ClientType>
  3510. inline Result Get(ClientType &cli, const std::string &path,
  3511. const Headers &headers, size_t chunk_size = 8192) {
  3512. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3513. }
  3514. template <typename ClientType>
  3515. inline Result Get(ClientType &cli, const std::string &path,
  3516. const Params &params, size_t chunk_size = 8192) {
  3517. return Result{cli.open_stream("GET", path, params), chunk_size};
  3518. }
  3519. template <typename ClientType>
  3520. inline Result Get(ClientType &cli, const std::string &path,
  3521. const Params &params, const Headers &headers,
  3522. size_t chunk_size = 8192) {
  3523. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3524. }
  3525. // POST
  3526. template <typename ClientType>
  3527. inline Result Post(ClientType &cli, const std::string &path,
  3528. const std::string &body, const std::string &content_type,
  3529. size_t chunk_size = 8192) {
  3530. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3531. chunk_size};
  3532. }
  3533. template <typename ClientType>
  3534. inline Result Post(ClientType &cli, const std::string &path,
  3535. const Headers &headers, const std::string &body,
  3536. const std::string &content_type, size_t chunk_size = 8192) {
  3537. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3538. chunk_size};
  3539. }
  3540. template <typename ClientType>
  3541. inline Result Post(ClientType &cli, const std::string &path,
  3542. const Params &params, const std::string &body,
  3543. const std::string &content_type, size_t chunk_size = 8192) {
  3544. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3545. chunk_size};
  3546. }
  3547. template <typename ClientType>
  3548. inline Result Post(ClientType &cli, const std::string &path,
  3549. const Params &params, const Headers &headers,
  3550. const std::string &body, const std::string &content_type,
  3551. size_t chunk_size = 8192) {
  3552. return Result{
  3553. cli.open_stream("POST", path, params, headers, body, content_type),
  3554. chunk_size};
  3555. }
  3556. // PUT
  3557. template <typename ClientType>
  3558. inline Result Put(ClientType &cli, const std::string &path,
  3559. const std::string &body, const std::string &content_type,
  3560. size_t chunk_size = 8192) {
  3561. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3562. chunk_size};
  3563. }
  3564. template <typename ClientType>
  3565. inline Result Put(ClientType &cli, const std::string &path,
  3566. const Headers &headers, const std::string &body,
  3567. const std::string &content_type, size_t chunk_size = 8192) {
  3568. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3569. chunk_size};
  3570. }
  3571. template <typename ClientType>
  3572. inline Result Put(ClientType &cli, const std::string &path,
  3573. const Params &params, const std::string &body,
  3574. const std::string &content_type, size_t chunk_size = 8192) {
  3575. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3576. chunk_size};
  3577. }
  3578. template <typename ClientType>
  3579. inline Result Put(ClientType &cli, const std::string &path,
  3580. const Params &params, const Headers &headers,
  3581. const std::string &body, const std::string &content_type,
  3582. size_t chunk_size = 8192) {
  3583. return Result{
  3584. cli.open_stream("PUT", path, params, headers, body, content_type),
  3585. chunk_size};
  3586. }
  3587. // PATCH
  3588. template <typename ClientType>
  3589. inline Result Patch(ClientType &cli, const std::string &path,
  3590. const std::string &body, const std::string &content_type,
  3591. size_t chunk_size = 8192) {
  3592. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3593. chunk_size};
  3594. }
  3595. template <typename ClientType>
  3596. inline Result Patch(ClientType &cli, const std::string &path,
  3597. const Headers &headers, const std::string &body,
  3598. const std::string &content_type, size_t chunk_size = 8192) {
  3599. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3600. chunk_size};
  3601. }
  3602. template <typename ClientType>
  3603. inline Result Patch(ClientType &cli, const std::string &path,
  3604. const Params &params, const std::string &body,
  3605. const std::string &content_type, size_t chunk_size = 8192) {
  3606. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3607. chunk_size};
  3608. }
  3609. template <typename ClientType>
  3610. inline Result Patch(ClientType &cli, const std::string &path,
  3611. const Params &params, const Headers &headers,
  3612. const std::string &body, const std::string &content_type,
  3613. size_t chunk_size = 8192) {
  3614. return Result{
  3615. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3616. chunk_size};
  3617. }
  3618. // DELETE
  3619. template <typename ClientType>
  3620. inline Result Delete(ClientType &cli, const std::string &path,
  3621. size_t chunk_size = 8192) {
  3622. return Result{cli.open_stream("DELETE", path), chunk_size};
  3623. }
  3624. template <typename ClientType>
  3625. inline Result Delete(ClientType &cli, const std::string &path,
  3626. const Headers &headers, size_t chunk_size = 8192) {
  3627. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3628. }
  3629. template <typename ClientType>
  3630. inline Result Delete(ClientType &cli, const std::string &path,
  3631. const std::string &body, const std::string &content_type,
  3632. size_t chunk_size = 8192) {
  3633. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3634. chunk_size};
  3635. }
  3636. template <typename ClientType>
  3637. inline Result Delete(ClientType &cli, const std::string &path,
  3638. const Headers &headers, const std::string &body,
  3639. const std::string &content_type,
  3640. size_t chunk_size = 8192) {
  3641. return Result{
  3642. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3643. chunk_size};
  3644. }
  3645. template <typename ClientType>
  3646. inline Result Delete(ClientType &cli, const std::string &path,
  3647. const Params &params, size_t chunk_size = 8192) {
  3648. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3649. }
  3650. template <typename ClientType>
  3651. inline Result Delete(ClientType &cli, const std::string &path,
  3652. const Params &params, const Headers &headers,
  3653. size_t chunk_size = 8192) {
  3654. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3655. }
  3656. template <typename ClientType>
  3657. inline Result Delete(ClientType &cli, const std::string &path,
  3658. const Params &params, const std::string &body,
  3659. const std::string &content_type,
  3660. size_t chunk_size = 8192) {
  3661. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3662. chunk_size};
  3663. }
  3664. template <typename ClientType>
  3665. inline Result Delete(ClientType &cli, const std::string &path,
  3666. const Params &params, const Headers &headers,
  3667. const std::string &body, const std::string &content_type,
  3668. size_t chunk_size = 8192) {
  3669. return Result{
  3670. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3671. chunk_size};
  3672. }
  3673. // HEAD
  3674. template <typename ClientType>
  3675. inline Result Head(ClientType &cli, const std::string &path,
  3676. size_t chunk_size = 8192) {
  3677. return Result{cli.open_stream("HEAD", path), chunk_size};
  3678. }
  3679. template <typename ClientType>
  3680. inline Result Head(ClientType &cli, const std::string &path,
  3681. const Headers &headers, size_t chunk_size = 8192) {
  3682. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3683. }
  3684. template <typename ClientType>
  3685. inline Result Head(ClientType &cli, const std::string &path,
  3686. const Params &params, size_t chunk_size = 8192) {
  3687. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3688. }
  3689. template <typename ClientType>
  3690. inline Result Head(ClientType &cli, const std::string &path,
  3691. const Params &params, const Headers &headers,
  3692. size_t chunk_size = 8192) {
  3693. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3694. }
  3695. // OPTIONS
  3696. template <typename ClientType>
  3697. inline Result Options(ClientType &cli, const std::string &path,
  3698. size_t chunk_size = 8192) {
  3699. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3700. }
  3701. template <typename ClientType>
  3702. inline Result Options(ClientType &cli, const std::string &path,
  3703. const Headers &headers, size_t chunk_size = 8192) {
  3704. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3705. }
  3706. template <typename ClientType>
  3707. inline Result Options(ClientType &cli, const std::string &path,
  3708. const Params &params, size_t chunk_size = 8192) {
  3709. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3710. }
  3711. template <typename ClientType>
  3712. inline Result Options(ClientType &cli, const std::string &path,
  3713. const Params &params, const Headers &headers,
  3714. size_t chunk_size = 8192) {
  3715. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3716. }
  3717. } // namespace stream
  3718. namespace sse {
  3719. struct SSEMessage {
  3720. std::string event; // Event type (default: "message")
  3721. std::string data; // Event payload
  3722. std::string id; // Event ID for Last-Event-ID header
  3723. SSEMessage();
  3724. void clear();
  3725. };
  3726. class SSEClient {
  3727. public:
  3728. using MessageHandler = std::function<void(const SSEMessage &)>;
  3729. using ErrorHandler = std::function<void(Error)>;
  3730. using OpenHandler = std::function<void()>;
  3731. SSEClient(Client &client, const std::string &path);
  3732. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3733. ~SSEClient();
  3734. SSEClient(const SSEClient &) = delete;
  3735. SSEClient &operator=(const SSEClient &) = delete;
  3736. // Event handlers
  3737. SSEClient &on_message(MessageHandler handler);
  3738. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3739. SSEClient &on_open(OpenHandler handler);
  3740. SSEClient &on_error(ErrorHandler handler);
  3741. SSEClient &set_reconnect_interval(int ms);
  3742. SSEClient &set_max_reconnect_attempts(int n);
  3743. // Update headers (thread-safe)
  3744. SSEClient &set_headers(const Headers &headers);
  3745. // State accessors
  3746. bool is_connected() const;
  3747. std::string last_event_id() const;
  3748. // Blocking start - runs event loop with auto-reconnect
  3749. void start();
  3750. // Non-blocking start - runs in background thread
  3751. void start_async();
  3752. // Stop the client (thread-safe)
  3753. void stop();
  3754. private:
  3755. void run_event_loop();
  3756. void dispatch_event(const SSEMessage &msg);
  3757. bool should_reconnect(int count) const;
  3758. void wait_for_reconnect();
  3759. // Client and path
  3760. Client &client_;
  3761. std::string path_;
  3762. Headers headers_;
  3763. mutable std::mutex headers_mutex_;
  3764. // Callbacks
  3765. MessageHandler on_message_;
  3766. std::map<std::string, MessageHandler> event_handlers_;
  3767. OpenHandler on_open_;
  3768. ErrorHandler on_error_;
  3769. // Configuration
  3770. int reconnect_interval_ms_ = 3000;
  3771. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3772. // State
  3773. std::atomic<bool> running_{false};
  3774. std::atomic<bool> connected_{false};
  3775. // Written by the event loop, which start_async() runs on its own thread
  3776. std::string last_event_id_;
  3777. mutable std::mutex last_event_id_mutex_;
  3778. // Async support
  3779. std::thread async_thread_;
  3780. };
  3781. } // namespace sse
  3782. namespace detail {
  3783. // Interprets an event stream fed in chunks of any size
  3784. class SSEParser {
  3785. public:
  3786. using EventHandler = std::function<void(const sse::SSEMessage &msg)>;
  3787. using IdHandler = std::function<void(const std::string &id)>;
  3788. using RetryHandler = std::function<void(int retry_ms)>;
  3789. SSEParser(EventHandler on_event, IdHandler on_id, RetryHandler on_retry,
  3790. size_t max_event_length = CPPHTTPLIB_SSE_MAX_EVENT_LENGTH);
  3791. // Returns false once the line and the event still waiting for their end
  3792. // exceed max_event_length. 0 means no limit.
  3793. bool parse(const char *buf, size_t n);
  3794. private:
  3795. void parse_line(const std::string &line);
  3796. EventHandler on_event_;
  3797. IdHandler on_id_;
  3798. RetryHandler on_retry_;
  3799. size_t max_event_length_;
  3800. std::string buffer_;
  3801. sse::SSEMessage msg_;
  3802. bool has_data_ = false;
  3803. bool has_id_ = false;
  3804. bool first_line_ = true;
  3805. bool after_cr_ = false;
  3806. };
  3807. } // namespace detail
  3808. namespace ws {
  3809. class WebSocketClient;
  3810. enum class Opcode : uint8_t {
  3811. Continuation = 0x0,
  3812. Text = 0x1,
  3813. Binary = 0x2,
  3814. Close = 0x8,
  3815. Ping = 0x9,
  3816. Pong = 0xA,
  3817. };
  3818. enum class CloseStatus : uint16_t {
  3819. Normal = 1000,
  3820. GoingAway = 1001,
  3821. ProtocolError = 1002,
  3822. UnsupportedData = 1003,
  3823. NoStatus = 1005,
  3824. Abnormal = 1006,
  3825. InvalidPayload = 1007,
  3826. PolicyViolation = 1008,
  3827. MessageTooBig = 1009,
  3828. MandatoryExtension = 1010,
  3829. InternalError = 1011,
  3830. };
  3831. // Timeout is returned only when a read timeout was set and it elapsed before
  3832. // any byte of a frame arrived: nothing was consumed and the connection is
  3833. // still open, so the caller can send on it and read again. `msg` is left
  3834. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3835. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3836. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3837. // upgrade handshake fully succeeded. On failure error() identifies the
  3838. // failing layer; status()/headers() expose the server's upgrade response
  3839. // when one was received (status() is -1 otherwise), or the proxy's reply to
  3840. // CONNECT when error() is ProxyConnection.
  3841. class Result {
  3842. public:
  3843. Result() = default;
  3844. Result(Error err, int status, Headers &&headers)
  3845. : err_(err), status_(status), headers_(std::move(headers)) {}
  3846. explicit operator bool() const { return err_ == Error::Success; }
  3847. Error error() const { return err_; }
  3848. // Upgrade response info
  3849. int status() const { return status_; }
  3850. const Headers &headers() const { return headers_; }
  3851. std::string get_header_value(const std::string &key,
  3852. const char *def = "") const {
  3853. return detail::get_header_value(headers_, key, def, 0);
  3854. }
  3855. bool has_header(const std::string &key) const {
  3856. return headers_.find(key) != headers_.end();
  3857. }
  3858. #ifdef CPPHTTPLIB_SSL_ENABLED
  3859. Result(Error err, int status, Headers &&headers, int ssl_error,
  3860. uint64_t ssl_backend_error)
  3861. : err_(err), status_(status), headers_(std::move(headers)),
  3862. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3863. int ssl_error() const { return ssl_error_; }
  3864. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3865. #endif
  3866. private:
  3867. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3868. int status_ = -1;
  3869. Headers headers_;
  3870. #ifdef CPPHTTPLIB_SSL_ENABLED
  3871. int ssl_error_ = 0;
  3872. uint64_t ssl_backend_error_ = 0;
  3873. #endif
  3874. };
  3875. class WebSocket {
  3876. public:
  3877. WebSocket(const WebSocket &) = delete;
  3878. WebSocket &operator=(const WebSocket &) = delete;
  3879. ~WebSocket();
  3880. ReadResult read(std::string &msg);
  3881. bool send(const std::string &data);
  3882. bool send(const char *data, size_t len);
  3883. void close(CloseStatus status = CloseStatus::Normal,
  3884. const std::string &reason = "");
  3885. const Request &request() const;
  3886. bool is_open() const;
  3887. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3888. // A server handler owns its connection's timeout this way; a client sets it
  3889. // through WebSocketClient. Safe to call while another thread is in read().
  3890. //
  3891. // Only a timeout set here is reported as Timeout. The compile-time default
  3892. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3893. // than a request for control, so when it elapses read() returns Fail and
  3894. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3895. void set_read_timeout(time_t sec, time_t usec = 0);
  3896. template <class Rep, class Period>
  3897. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3898. private:
  3899. friend class httplib::Server;
  3900. friend class httplib::ws::WebSocketClient;
  3901. WebSocket(
  3902. Stream &strm, const Request &req, bool is_server,
  3903. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3904. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS,
  3905. std::function<bool()> server_stopping = nullptr)
  3906. : strm_(strm), req_(req), is_server_(is_server),
  3907. ping_interval_sec_(ping_interval_sec),
  3908. max_missed_pongs_(max_missed_pongs),
  3909. server_stopping_(std::move(server_stopping)) {
  3910. interrupt_reads();
  3911. start_heartbeat();
  3912. }
  3913. WebSocket(
  3914. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3915. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3916. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS,
  3917. std::function<bool()> server_stopping = nullptr)
  3918. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3919. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3920. max_missed_pongs_(max_missed_pongs),
  3921. server_stopping_(std::move(server_stopping)) {
  3922. interrupt_reads();
  3923. start_heartbeat();
  3924. }
  3925. void interrupt_reads();
  3926. bool server_stopping() const {
  3927. return server_stopping_ && server_stopping_();
  3928. }
  3929. void start_heartbeat();
  3930. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3931. Stream &strm_;
  3932. std::unique_ptr<Stream> owned_strm_;
  3933. Request req_;
  3934. bool is_server_;
  3935. time_t ping_interval_sec_;
  3936. int max_missed_pongs_;
  3937. int unacked_pings_ = 0;
  3938. std::atomic<bool> closed_{false};
  3939. // Set when the peer stopped answering pings, to end a read() waiting on it
  3940. std::atomic<bool> pong_timed_out_{false};
  3941. // A server connection's view of Server::stop(), which ends its read() too
  3942. std::function<bool()> server_stopping_;
  3943. // Set once the caller has bounded read() through set_read_timeout(). Until
  3944. // then the timeout in effect is the compile-time default, and elapsing it
  3945. // is a failure that closes the connection, not a Timeout.
  3946. std::atomic<bool> read_timeout_set_{false};
  3947. std::mutex write_mutex_;
  3948. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3949. // may do so: read_websocket_frame() reads a payload until it has the whole
  3950. // declared length, so a second parser stealing bytes silently corrupts the
  3951. // message the first one is assembling.
  3952. std::mutex read_mutex_;
  3953. std::thread ping_thread_;
  3954. std::mutex ping_mutex_;
  3955. std::condition_variable ping_cv_;
  3956. };
  3957. class WebSocketClient {
  3958. public:
  3959. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3960. const Headers &headers = {});
  3961. ~WebSocketClient();
  3962. WebSocketClient(const WebSocketClient &) = delete;
  3963. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3964. bool is_valid() const;
  3965. Result connect();
  3966. ReadResult read(std::string &msg);
  3967. bool send(const std::string &data);
  3968. bool send(const char *data, size_t len);
  3969. void close(CloseStatus status = CloseStatus::Normal,
  3970. const std::string &reason = "");
  3971. bool is_open() const;
  3972. const std::string &subprotocol() const;
  3973. void set_read_timeout(time_t sec, time_t usec = 0);
  3974. template <class Rep, class Period>
  3975. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3976. void set_write_timeout(time_t sec, time_t usec = 0);
  3977. template <class Rep, class Period>
  3978. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3979. void set_websocket_ping_interval(time_t sec);
  3980. void set_websocket_max_missed_pongs(int count);
  3981. void set_tcp_nodelay(bool on);
  3982. void set_address_family(int family);
  3983. void set_ipv6_v6only(bool on);
  3984. void set_socket_options(SocketOptions socket_options);
  3985. void set_connection_timeout(time_t sec, time_t usec = 0);
  3986. template <class Rep, class Period>
  3987. void
  3988. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3989. void set_interface(const std::string &intf);
  3990. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  3991. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3992. void
  3993. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3994. void
  3995. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3996. void set_basic_auth(const std::string &username, const std::string &password);
  3997. void set_bearer_token_auth(const std::string &token);
  3998. void set_proxy(const std::string &host, int port);
  3999. void set_proxy_basic_auth(const std::string &username,
  4000. const std::string &password);
  4001. void set_proxy_bearer_token_auth(const std::string &token);
  4002. void set_no_proxy(const std::vector<std::string> &patterns);
  4003. #ifdef CPPHTTPLIB_SSL_ENABLED
  4004. struct PemMemory {
  4005. const char *cert_pem;
  4006. size_t cert_pem_len;
  4007. const char *key_pem;
  4008. size_t key_pem_len;
  4009. const char *private_key_password;
  4010. };
  4011. explicit WebSocketClient(const std::string &scheme_host_port_path,
  4012. const PemMemory &pem, const Headers &headers = {});
  4013. void set_ca_cert_path(const std::string &ca_cert_file_path,
  4014. const std::string &ca_cert_dir_path = std::string());
  4015. void set_ca_cert_store(tls::ca_store_t store);
  4016. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  4017. void enable_server_certificate_verification(bool enabled);
  4018. void enable_server_hostname_verification(bool enabled);
  4019. void enable_system_ca(bool enabled);
  4020. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  4021. void set_session_verifier(
  4022. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  4023. void set_proxy_digest_auth(const std::string &username,
  4024. const std::string &password);
  4025. #endif
  4026. private:
  4027. void shutdown_and_close();
  4028. std::pair<time_t, time_t> handshake_timeout() const;
  4029. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  4030. int &ssl_error, uint64_t &ssl_backend_error);
  4031. void prepare_default_headers(Request &req);
  4032. bool is_proxy_enabled() const;
  4033. bool create_and_connect_socket(Error &error);
  4034. bool send_proxy_connect(Request &req, Response &proxy_res, Error &error);
  4035. bool connect_with_proxy(Response &proxy_res, Error &error);
  4036. std::string host_;
  4037. int port_;
  4038. std::string path_;
  4039. Headers headers_;
  4040. std::string subprotocol_;
  4041. bool is_valid_ = false;
  4042. socket_t sock_ = INVALID_SOCKET;
  4043. std::unique_ptr<WebSocket> ws_;
  4044. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  4045. time_t read_timeout_usec_ = 0;
  4046. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  4047. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  4048. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  4049. time_t websocket_ping_interval_sec_ =
  4050. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  4051. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  4052. int address_family_ = AF_UNSPEC;
  4053. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  4054. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  4055. SocketOptions socket_options_ = nullptr;
  4056. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  4057. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  4058. std::string interface_;
  4059. // Hostname to connection target map. The value is an IP literal or another
  4060. // hostname; only the connection target changes, never the identity.
  4061. std::map<std::string, std::string> addr_map_;
  4062. // Hostname to CONNECT target map, used only through a proxy.
  4063. std::map<std::string, std::string> tunnel_addr_map_;
  4064. std::string basic_auth_username_;
  4065. std::string basic_auth_password_;
  4066. std::string bearer_token_auth_token_;
  4067. std::string proxy_host_;
  4068. int proxy_port_ = -1;
  4069. std::string proxy_basic_auth_username_;
  4070. std::string proxy_basic_auth_password_;
  4071. std::string proxy_bearer_token_auth_token_;
  4072. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  4073. #ifdef CPPHTTPLIB_SSL_ENABLED
  4074. bool is_ssl_ = false;
  4075. tls::ctx_t tls_ctx_ = nullptr;
  4076. tls::session_t tls_session_ = nullptr;
  4077. std::string ca_cert_file_path_;
  4078. std::string ca_cert_dir_path_;
  4079. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  4080. // no certificate, so that a CA that failed to come through fails
  4081. // verification instead of letting the system CAs in.
  4082. bool custom_ca_loaded_ = false;
  4083. bool certs_loaded_ = false;
  4084. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  4085. bool server_certificate_verification_ = true;
  4086. bool server_hostname_verification_ = true;
  4087. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  4088. std::string proxy_digest_auth_username_;
  4089. std::string proxy_digest_auth_password_;
  4090. #endif
  4091. };
  4092. template <class Rep, class Period>
  4093. inline void WebSocket::set_read_timeout(
  4094. const std::chrono::duration<Rep, Period> &duration) {
  4095. detail::duration_to_sec_and_usec(
  4096. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4097. }
  4098. template <class Rep, class Period>
  4099. inline void WebSocketClient::set_read_timeout(
  4100. const std::chrono::duration<Rep, Period> &duration) {
  4101. detail::duration_to_sec_and_usec(
  4102. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4103. }
  4104. template <class Rep, class Period>
  4105. inline void WebSocketClient::set_write_timeout(
  4106. const std::chrono::duration<Rep, Period> &duration) {
  4107. detail::duration_to_sec_and_usec(
  4108. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  4109. }
  4110. template <class Rep, class Period>
  4111. inline void WebSocketClient::set_connection_timeout(
  4112. const std::chrono::duration<Rep, Period> &duration) {
  4113. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  4114. set_connection_timeout(sec, usec);
  4115. });
  4116. }
  4117. namespace impl {
  4118. bool is_valid_utf8(const std::string &s);
  4119. // Three states, because a failure that consumed bytes and one that consumed
  4120. // none are not the same thing: the first has left the stream in the middle of
  4121. // a frame and the connection cannot be reused, the second can just be retried.
  4122. enum class FrameRead { Ok, Fail, Timeout };
  4123. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4124. std::string &payload, bool &fin,
  4125. bool expect_masked, size_t max_len);
  4126. } // namespace impl
  4127. } // namespace ws
  4128. // ----------------------------------------------------------------------------
  4129. /*
  4130. * Implementation that will be part of the .cc file if split into .h + .cc.
  4131. */
  4132. namespace stream {
  4133. // stream::Result implementations
  4134. inline Result::Result() : chunk_size_(8192) {}
  4135. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  4136. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  4137. inline Result::Result(Result &&other) noexcept
  4138. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  4139. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  4140. finished_(other.finished_) {
  4141. other.current_size_ = 0;
  4142. other.finished_ = true;
  4143. }
  4144. inline Result &Result::operator=(Result &&other) noexcept {
  4145. if (this != &other) {
  4146. handle_ = std::move(other.handle_);
  4147. buffer_ = std::move(other.buffer_);
  4148. current_size_ = other.current_size_;
  4149. chunk_size_ = other.chunk_size_;
  4150. finished_ = other.finished_;
  4151. other.current_size_ = 0;
  4152. other.finished_ = true;
  4153. }
  4154. return *this;
  4155. }
  4156. inline bool Result::is_valid() const { return handle_.is_valid(); }
  4157. inline Result::operator bool() const { return is_valid(); }
  4158. inline int Result::status() const {
  4159. return handle_.response ? handle_.response->status : -1;
  4160. }
  4161. inline const Headers &Result::headers() const {
  4162. static const Headers empty_headers;
  4163. return handle_.response ? handle_.response->headers : empty_headers;
  4164. }
  4165. inline std::string Result::get_header_value(const std::string &key,
  4166. const char *def) const {
  4167. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  4168. }
  4169. inline bool Result::has_header(const std::string &key) const {
  4170. return handle_.response ? handle_.response->has_header(key) : false;
  4171. }
  4172. inline Error Result::error() const { return handle_.error; }
  4173. inline Error Result::read_error() const { return handle_.get_read_error(); }
  4174. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  4175. inline bool Result::next() {
  4176. if (!handle_.is_valid() || finished_) { return false; }
  4177. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4178. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4179. if (n > 0) {
  4180. current_size_ = static_cast<size_t>(n);
  4181. return true;
  4182. }
  4183. current_size_ = 0;
  4184. finished_ = true;
  4185. return false;
  4186. }
  4187. inline const char *Result::data() const { return buffer_.data(); }
  4188. inline size_t Result::size() const { return current_size_; }
  4189. inline std::string Result::read_all() {
  4190. std::string result;
  4191. while (next()) {
  4192. result.append(data(), size());
  4193. }
  4194. return result;
  4195. }
  4196. } // namespace stream
  4197. namespace detail {
  4198. inline SSEParser::SSEParser(EventHandler on_event, IdHandler on_id,
  4199. RetryHandler on_retry, size_t max_event_length)
  4200. : on_event_(std::move(on_event)), on_id_(std::move(on_id)),
  4201. on_retry_(std::move(on_retry)), max_event_length_(max_event_length) {}
  4202. inline bool SSEParser::parse(const char *buf, size_t n) {
  4203. // What is left in the buffer has no line ending
  4204. auto search_pos = buffer_.size();
  4205. buffer_.append(buf, n);
  4206. // A line ends with \r\n, \n or \r per the SSE spec
  4207. size_t line_start = 0;
  4208. size_t eol_pos;
  4209. while ((eol_pos = buffer_.find_first_of("\r\n", search_pos)) !=
  4210. std::string::npos) {
  4211. auto line = buffer_.substr(line_start, eol_pos - line_start);
  4212. line_start = eol_pos + 1;
  4213. search_pos = line_start;
  4214. // The \n of a \r\n may arrive in a later chunk than its \r
  4215. auto is_lf_of_crlf = after_cr_ && line.empty() && buffer_[eol_pos] == '\n';
  4216. after_cr_ = buffer_[eol_pos] == '\r';
  4217. if (is_lf_of_crlf) { continue; }
  4218. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4219. if (first_line_) {
  4220. first_line_ = false;
  4221. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4222. }
  4223. parse_line(line);
  4224. }
  4225. // Keep unprocessed data in buffer
  4226. buffer_.erase(0, line_start);
  4227. return max_event_length_ == 0 ||
  4228. buffer_.size() + msg_.data.size() <= max_event_length_;
  4229. }
  4230. inline void SSEParser::parse_line(const std::string &line) {
  4231. // Blank line signals end of event
  4232. if (line.empty()) {
  4233. // The id counts for Last-Event-ID even for an event that has no data. An
  4234. // empty id clears it.
  4235. if (has_id_ && on_id_) { on_id_(msg_.id); }
  4236. // An event without a data field is not dispatched
  4237. if (has_data_ && on_event_) { on_event_(msg_); }
  4238. msg_.clear();
  4239. has_data_ = false;
  4240. has_id_ = false;
  4241. return;
  4242. }
  4243. // Lines starting with ':' are comments (ignored)
  4244. if (line[0] == ':') { return; }
  4245. // Find the colon separator
  4246. auto colon_pos = line.find(':');
  4247. auto field = line.substr(0, colon_pos);
  4248. std::string value;
  4249. // Value starts after colon, skip optional single space
  4250. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4251. auto value_start = colon_pos + 1;
  4252. if (line[value_start] == ' ') { value_start++; }
  4253. value = line.substr(value_start);
  4254. }
  4255. // Handle known fields
  4256. if (field == "event") {
  4257. // An empty event type is dispatched as "message" per the SSE spec
  4258. msg_.event = value.empty() ? std::string("message") : std::move(value);
  4259. } else if (field == "data") {
  4260. // Multiple data lines are concatenated with newlines
  4261. if (has_data_) { msg_.data += "\n"; }
  4262. msg_.data += value;
  4263. has_data_ = true;
  4264. } else if (field == "id") {
  4265. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4266. // valid (clears the last event ID)
  4267. if (fields::is_field_value(value)) {
  4268. msg_.id = value;
  4269. has_id_ = true;
  4270. }
  4271. } else if (field == "retry") {
  4272. // Parse retry interval in milliseconds
  4273. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4274. if (is_numeric(value)) {
  4275. int v = 0;
  4276. auto res = from_chars(value.data(), value.data() + value.size(), v);
  4277. if (res.ec == std::errc{} && on_retry_) { on_retry_(v); }
  4278. }
  4279. }
  4280. // Unknown fields are ignored per SSE spec
  4281. }
  4282. } // namespace detail
  4283. namespace sse {
  4284. // SSEMessage implementations
  4285. inline SSEMessage::SSEMessage() : event("message") {}
  4286. inline void SSEMessage::clear() {
  4287. event = "message";
  4288. data.clear();
  4289. id.clear();
  4290. }
  4291. // SSEClient implementations
  4292. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4293. : client_(client), path_(path) {}
  4294. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4295. const Headers &headers)
  4296. : client_(client), path_(path), headers_(headers) {}
  4297. inline SSEClient::~SSEClient() { stop(); }
  4298. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4299. on_message_ = std::move(handler);
  4300. return *this;
  4301. }
  4302. inline SSEClient &SSEClient::on_event(const std::string &type,
  4303. MessageHandler handler) {
  4304. event_handlers_[type] = std::move(handler);
  4305. return *this;
  4306. }
  4307. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4308. on_open_ = std::move(handler);
  4309. return *this;
  4310. }
  4311. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4312. on_error_ = std::move(handler);
  4313. return *this;
  4314. }
  4315. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4316. reconnect_interval_ms_ = ms;
  4317. return *this;
  4318. }
  4319. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4320. max_reconnect_attempts_ = n;
  4321. return *this;
  4322. }
  4323. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4324. std::lock_guard<std::mutex> lock(headers_mutex_);
  4325. headers_ = headers;
  4326. return *this;
  4327. }
  4328. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4329. inline std::string SSEClient::last_event_id() const {
  4330. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4331. return last_event_id_;
  4332. }
  4333. inline void SSEClient::start() {
  4334. running_.store(true);
  4335. run_event_loop();
  4336. }
  4337. inline void SSEClient::start_async() {
  4338. running_.store(true);
  4339. async_thread_ = std::thread([this]() { run_event_loop(); });
  4340. }
  4341. inline void SSEClient::stop() {
  4342. running_.store(false);
  4343. client_.stop(); // Cancel any pending operations
  4344. if (async_thread_.joinable()) { async_thread_.join(); }
  4345. }
  4346. inline void SSEClient::run_event_loop() {
  4347. auto reconnect_count = 0;
  4348. while (running_.load()) {
  4349. // Build headers, including Last-Event-ID if we have one
  4350. Headers request_headers;
  4351. {
  4352. std::lock_guard<std::mutex> lock(headers_mutex_);
  4353. request_headers = headers_;
  4354. }
  4355. if (!last_event_id_.empty()) {
  4356. request_headers.emplace("Last-Event-ID", last_event_id_);
  4357. }
  4358. // Open streaming connection. An event stream has no end, so each event is
  4359. // bounded instead of the whole body.
  4360. auto handle = client_.open_stream("GET", path_, {}, request_headers);
  4361. handle.body_reader_.payload_max_length = 0;
  4362. // stop() ends a read that is waiting for the next event
  4363. if (handle.stream_) {
  4364. handle.stream_->set_read_interrupt([this] { return !running_.load(); });
  4365. }
  4366. stream::Result result{std::move(handle)};
  4367. // Connection error handling
  4368. if (!result) {
  4369. connected_.store(false);
  4370. if (on_error_) { on_error_(result.error()); }
  4371. if (!should_reconnect(reconnect_count)) { break; }
  4372. wait_for_reconnect();
  4373. reconnect_count++;
  4374. continue;
  4375. }
  4376. if (result.status() != StatusCode::OK_200) {
  4377. connected_.store(false);
  4378. if (on_error_) { on_error_(Error::Connection); }
  4379. // For certain errors, don't reconnect.
  4380. // Note: 401 is intentionally absent so that handlers can refresh
  4381. // credentials via set_headers() and let the client reconnect.
  4382. if (result.status() == StatusCode::NoContent_204 ||
  4383. result.status() == StatusCode::NotFound_404 ||
  4384. result.status() == StatusCode::Forbidden_403) {
  4385. break;
  4386. }
  4387. if (!should_reconnect(reconnect_count)) { break; }
  4388. wait_for_reconnect();
  4389. reconnect_count++;
  4390. continue;
  4391. }
  4392. // Connection successful
  4393. connected_.store(true);
  4394. reconnect_count = 0;
  4395. if (on_open_) { on_open_(); }
  4396. // Event receiving loop
  4397. detail::SSEParser parser(
  4398. [this](const SSEMessage &msg) { dispatch_event(msg); },
  4399. [this](const std::string &id) {
  4400. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4401. last_event_id_ = id;
  4402. },
  4403. [this](int retry_ms) { reconnect_interval_ms_ = retry_ms; });
  4404. auto event_too_long = false;
  4405. while (running_.load() && result.next()) {
  4406. if (!parser.parse(result.data(), result.size())) {
  4407. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4408. event_too_long = true;
  4409. break;
  4410. }
  4411. }
  4412. // Connection ended
  4413. connected_.store(false);
  4414. // Reconnecting would only get the same event again
  4415. if (!running_.load() || event_too_long) { break; }
  4416. // Check for read errors
  4417. if (result.has_read_error()) {
  4418. if (on_error_) { on_error_(result.read_error()); }
  4419. }
  4420. if (!should_reconnect(reconnect_count)) { break; }
  4421. wait_for_reconnect();
  4422. reconnect_count++;
  4423. }
  4424. connected_.store(false);
  4425. }
  4426. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4427. // Check for specific event type handler first
  4428. auto it = event_handlers_.find(msg.event);
  4429. if (it != event_handlers_.end()) {
  4430. it->second(msg);
  4431. return;
  4432. }
  4433. // Fall back to generic message handler
  4434. if (on_message_) { on_message_(msg); }
  4435. }
  4436. inline bool SSEClient::should_reconnect(int count) const {
  4437. if (!running_.load()) { return false; }
  4438. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4439. return count < max_reconnect_attempts_;
  4440. }
  4441. inline void SSEClient::wait_for_reconnect() {
  4442. // Use small increments to check running_ flag frequently.
  4443. // Always wait at least one increment, so that a zero interval (e.g.
  4444. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4445. const auto step_ms = 100;
  4446. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4447. auto waited = 0;
  4448. while (running_.load() && waited < interval_ms) {
  4449. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4450. waited += step_ms;
  4451. }
  4452. }
  4453. } // namespace sse
  4454. #ifdef CPPHTTPLIB_SSL_ENABLED
  4455. /*
  4456. * TLS abstraction layer - internal function declarations
  4457. * These are implementation details and not part of the public API.
  4458. */
  4459. namespace tls {
  4460. // Client context
  4461. ctx_t create_client_context();
  4462. void free_context(ctx_t ctx);
  4463. bool set_min_version(ctx_t ctx, Version version);
  4464. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4465. bool load_ca_file(ctx_t ctx, const char *file_path);
  4466. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4467. bool load_system_certs(ctx_t ctx);
  4468. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4469. const char *password);
  4470. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4471. const char *key_path, const char *password);
  4472. // Server context
  4473. ctx_t create_server_context();
  4474. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4475. const char *password);
  4476. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4477. const char *key_path, const char *password);
  4478. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4479. void set_verify_client(ctx_t ctx, bool require);
  4480. // Session management
  4481. session_t create_session(ctx_t ctx, socket_t sock);
  4482. void free_session(session_t session);
  4483. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4484. // Handshake (non-blocking capable)
  4485. TlsError connect(session_t session);
  4486. TlsError accept(session_t session);
  4487. // Handshake with timeout (blocking until timeout, or until interrupted)
  4488. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4489. time_t timeout_usec, TlsError *err,
  4490. const std::function<bool()> &interrupted = nullptr);
  4491. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4492. time_t timeout_usec, TlsError *err);
  4493. // I/O (non-blocking capable)
  4494. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4495. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4496. int pending(const_session_t session);
  4497. void shutdown(session_t session, bool graceful);
  4498. // Connection state
  4499. bool is_peer_closed(session_t session, socket_t sock);
  4500. // Certificate verification
  4501. cert_t get_peer_cert(const_session_t session);
  4502. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4503. // do not use them after free_session(), as with get_peer_cert().
  4504. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4505. void free_cert(cert_t cert);
  4506. // Matches the host against the subjectAltName entries only, never the Common
  4507. // Name (RFC 9525).
  4508. bool verify_hostname(cert_t cert, const char *hostname);
  4509. uint64_t hostname_mismatch_code();
  4510. long get_verify_result(const_session_t session);
  4511. // Certificate introspection
  4512. std::string get_cert_subject_cn(cert_t cert);
  4513. std::string get_cert_issuer_name(cert_t cert);
  4514. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4515. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4516. std::string get_cert_serial(cert_t cert);
  4517. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4518. const char *get_sni(const_session_t session);
  4519. // CA store management
  4520. ca_store_t create_ca_store(const char *pem, size_t len);
  4521. void free_ca_store(ca_store_t store);
  4522. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4523. // Free each with free_cert(), and do not use them once the context's CA
  4524. // certificates change.
  4525. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4526. std::vector<std::string> get_ca_names(ctx_t ctx);
  4527. // Dynamic certificate update (for servers)
  4528. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4529. const char *password);
  4530. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4531. // Certificate verification callback
  4532. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4533. long get_verify_error(const_session_t session);
  4534. std::string verify_error_string(long error_code);
  4535. // TlsError information
  4536. uint64_t peek_error();
  4537. uint64_t get_error();
  4538. std::string error_string(uint64_t code);
  4539. } // namespace tls
  4540. #endif // CPPHTTPLIB_SSL_ENABLED
  4541. /*
  4542. * Group 1: detail namespace - Non-SSL utilities
  4543. */
  4544. namespace detail {
  4545. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4546. const void *optval, socklen_t optlen) {
  4547. return setsockopt(sock, level, optname,
  4548. #ifdef _WIN32
  4549. reinterpret_cast<const char *>(optval),
  4550. #else
  4551. optval,
  4552. #endif
  4553. optlen) == 0;
  4554. }
  4555. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4556. time_t sec, time_t usec) {
  4557. #ifdef _WIN32
  4558. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4559. #else
  4560. timeval timeout;
  4561. timeout.tv_sec = static_cast<long>(sec);
  4562. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4563. #endif
  4564. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4565. }
  4566. inline bool is_hex(char c, int &v) {
  4567. if (is_ascii_digit(c)) {
  4568. v = c - '0';
  4569. return true;
  4570. } else if ('A' <= c && c <= 'F') {
  4571. v = c - 'A' + 10;
  4572. return true;
  4573. } else if ('a' <= c && c <= 'f') {
  4574. v = c - 'a' + 10;
  4575. return true;
  4576. }
  4577. return false;
  4578. }
  4579. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4580. int &val) {
  4581. if (i >= s.size()) { return false; }
  4582. val = 0;
  4583. for (; cnt; i++, cnt--) {
  4584. if (!s[i]) { return false; }
  4585. auto v = 0;
  4586. if (is_hex(s[i], v)) {
  4587. val = val * 16 + v;
  4588. } else {
  4589. return false;
  4590. }
  4591. }
  4592. return true;
  4593. }
  4594. inline std::string from_i_to_hex(size_t n) {
  4595. static const auto charset = "0123456789abcdef";
  4596. std::string ret;
  4597. do {
  4598. ret = charset[n & 15] + ret;
  4599. n >>= 4;
  4600. } while (n > 0);
  4601. return ret;
  4602. }
  4603. // A round trip rather than `n <= SIZE_MAX`, which is always true on 64-bit
  4604. // builds and trips -Wtautological-type-limit-compare.
  4605. inline bool fits_in_size_t(uint64_t n) {
  4606. return static_cast<uint64_t>(static_cast<size_t>(n)) == n;
  4607. }
  4608. inline std::string compute_etag(const FileStat &fs,
  4609. const std::string &suffix = std::string()) {
  4610. if (!fs.is_file()) { return std::string(); }
  4611. // If mtime cannot be determined (negative value indicates an error
  4612. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4613. // value like 0 could collide with a real file that legitimately has
  4614. // mtime == 0 (epoch) and lead to misleading validators.
  4615. auto mtime_raw = fs.mtime();
  4616. if (mtime_raw < 0) { return std::string(); }
  4617. auto mtime = static_cast<size_t>(mtime_raw);
  4618. auto size = fs.size();
  4619. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4620. from_i_to_hex(size) + suffix + "\"";
  4621. }
  4622. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4623. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4624. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4625. inline std::string file_mtime_to_http_date(time_t mtime) {
  4626. if (mtime < 0) { return std::string(); }
  4627. struct tm tm_buf;
  4628. #ifdef _WIN32
  4629. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4630. #else
  4631. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4632. #endif
  4633. char buf[64];
  4634. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4635. return std::string();
  4636. }
  4637. return std::string(buf);
  4638. }
  4639. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4640. inline time_t parse_http_date(const std::string &date_str) {
  4641. struct tm tm_buf;
  4642. // Create a classic locale object once for all parsing attempts
  4643. const std::locale classic_locale = std::locale::classic();
  4644. // Try to parse using std::get_time (C++11, cross-platform)
  4645. auto try_parse = [&](const char *fmt) -> bool {
  4646. std::istringstream ss(date_str);
  4647. ss.imbue(classic_locale);
  4648. memset(&tm_buf, 0, sizeof(tm_buf));
  4649. ss >> std::get_time(&tm_buf, fmt);
  4650. return !ss.fail();
  4651. };
  4652. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4653. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4654. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4655. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4656. // asctime format: "Sun Nov 6 08:49:37 1994"
  4657. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4658. return static_cast<time_t>(-1);
  4659. }
  4660. }
  4661. }
  4662. #ifdef _WIN32
  4663. return _mkgmtime(&tm_buf);
  4664. #elif defined _AIX
  4665. return mktime(&tm_buf);
  4666. #else
  4667. return timegm(&tm_buf);
  4668. #endif
  4669. }
  4670. inline bool is_weak_etag(const std::string &s) {
  4671. // Check if the string is a weak ETag (starts with 'W/"')
  4672. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4673. }
  4674. inline bool is_strong_etag(const std::string &s) {
  4675. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4676. // chars)
  4677. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4678. }
  4679. inline size_t to_utf8(int code, char *buff) {
  4680. if (code < 0x0080) {
  4681. buff[0] = static_cast<char>(code & 0x7F);
  4682. return 1;
  4683. } else if (code < 0x0800) {
  4684. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4685. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4686. return 2;
  4687. } else if (code < 0xD800) {
  4688. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4689. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4690. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4691. return 3;
  4692. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4693. return 0;
  4694. } else if (code < 0x10000) {
  4695. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4696. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4697. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4698. return 3;
  4699. } else if (code < 0x110000) {
  4700. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4701. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4702. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4703. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4704. return 4;
  4705. }
  4706. // NOTREACHED
  4707. return 0;
  4708. }
  4709. } // namespace detail
  4710. namespace ws {
  4711. namespace impl {
  4712. inline bool is_valid_utf8(const std::string &s) {
  4713. size_t i = 0;
  4714. auto n = s.size();
  4715. while (i < n) {
  4716. auto c = static_cast<unsigned char>(s[i]);
  4717. size_t len;
  4718. uint32_t cp;
  4719. if (c < 0x80) {
  4720. i++;
  4721. continue;
  4722. } else if ((c & 0xE0) == 0xC0) {
  4723. len = 2;
  4724. cp = c & 0x1F;
  4725. } else if ((c & 0xF0) == 0xE0) {
  4726. len = 3;
  4727. cp = c & 0x0F;
  4728. } else if ((c & 0xF8) == 0xF0) {
  4729. len = 4;
  4730. cp = c & 0x07;
  4731. } else {
  4732. return false;
  4733. }
  4734. if (i + len > n) { return false; }
  4735. for (size_t j = 1; j < len; j++) {
  4736. auto b = static_cast<unsigned char>(s[i + j]);
  4737. if ((b & 0xC0) != 0x80) { return false; }
  4738. cp = (cp << 6) | (b & 0x3F);
  4739. }
  4740. // Overlong encoding check
  4741. if (len == 2 && cp < 0x80) { return false; }
  4742. if (len == 3 && cp < 0x800) { return false; }
  4743. if (len == 4 && cp < 0x10000) { return false; }
  4744. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4745. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4746. if (cp > 0x10FFFF) { return false; }
  4747. i += len;
  4748. }
  4749. return true;
  4750. }
  4751. } // namespace impl
  4752. } // namespace ws
  4753. namespace detail {
  4754. // NOTE: This code came up with the following stackoverflow post:
  4755. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4756. inline std::string base64_encode(const std::string &in) {
  4757. static const auto lookup =
  4758. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4759. std::string out;
  4760. out.reserve(in.size());
  4761. // Unsigned: the accumulator is never masked, so with a signed int the
  4762. // `val << 8` below overflows once enough bytes are folded in (undefined
  4763. // behaviour before C++20). Only the low bits are ever emitted, so the
  4764. // wrap-around of an unsigned accumulator does not affect the output.
  4765. uint32_t val = 0;
  4766. auto valb = -6;
  4767. for (auto c : in) {
  4768. val = (val << 8) + static_cast<uint8_t>(c);
  4769. valb += 8;
  4770. while (valb >= 0) {
  4771. out.push_back(lookup[(val >> valb) & 0x3F]);
  4772. valb -= 6;
  4773. }
  4774. }
  4775. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4776. while (out.size() % 4) {
  4777. out.push_back('=');
  4778. }
  4779. return out;
  4780. }
  4781. inline std::string sha1(const std::string &input) {
  4782. // RFC 3174 SHA-1 implementation
  4783. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4784. return (x << n) | (x >> (32 - n));
  4785. };
  4786. uint32_t h0 = 0x67452301;
  4787. uint32_t h1 = 0xEFCDAB89;
  4788. uint32_t h2 = 0x98BADCFE;
  4789. uint32_t h3 = 0x10325476;
  4790. uint32_t h4 = 0xC3D2E1F0;
  4791. // Pre-processing: adding padding bits
  4792. std::string msg = input;
  4793. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4794. msg.push_back(static_cast<char>(0x80u));
  4795. while (msg.size() % 64 != 56) {
  4796. msg.push_back(0);
  4797. }
  4798. // Append original length in bits as 64-bit big-endian
  4799. for (int i = 56; i >= 0; i -= 8) {
  4800. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4801. }
  4802. // Process each 512-bit chunk
  4803. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4804. uint32_t w[80];
  4805. for (size_t i = 0; i < 16; i++) {
  4806. w[i] =
  4807. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4808. << 24) |
  4809. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4810. << 16) |
  4811. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4812. << 8) |
  4813. (static_cast<uint32_t>(
  4814. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4815. }
  4816. for (int i = 16; i < 80; i++) {
  4817. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4818. }
  4819. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4820. for (int i = 0; i < 80; i++) {
  4821. uint32_t f, k;
  4822. if (i < 20) {
  4823. f = (b & c) | ((~b) & d);
  4824. k = 0x5A827999;
  4825. } else if (i < 40) {
  4826. f = b ^ c ^ d;
  4827. k = 0x6ED9EBA1;
  4828. } else if (i < 60) {
  4829. f = (b & c) | (b & d) | (c & d);
  4830. k = 0x8F1BBCDC;
  4831. } else {
  4832. f = b ^ c ^ d;
  4833. k = 0xCA62C1D6;
  4834. }
  4835. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4836. e = d;
  4837. d = c;
  4838. c = left_rotate(b, 30);
  4839. b = a;
  4840. a = temp;
  4841. }
  4842. h0 += a;
  4843. h1 += b;
  4844. h2 += c;
  4845. h3 += d;
  4846. h4 += e;
  4847. }
  4848. // Produce the final hash as a 20-byte binary string
  4849. std::string hash(20, '\0');
  4850. for (size_t i = 0; i < 4; i++) {
  4851. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4852. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4853. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4854. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4855. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4856. }
  4857. return hash;
  4858. }
  4859. inline std::string websocket_accept_key(const std::string &client_key) {
  4860. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4861. return base64_encode(sha1(client_key + magic));
  4862. }
  4863. inline bool is_websocket_upgrade(const Request &req) {
  4864. if (req.method != "GET") { return false; }
  4865. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4866. // list of protocols and asks recipients to match each name
  4867. // case-insensitively, so look for the token rather than compare the whole
  4868. // field value.
  4869. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4870. // Check Connection: Upgrade
  4871. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4872. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4873. // RFC 6455 Section 4.2.1
  4874. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4875. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4876. return false;
  4877. }
  4878. static const std::string b64chars =
  4879. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4880. for (size_t i = 0; i < 22; i++) {
  4881. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4882. }
  4883. // Check Sec-WebSocket-Version: 13
  4884. auto version = req.get_header_value("Sec-WebSocket-Version");
  4885. if (version != "13") { return false; }
  4886. return true;
  4887. }
  4888. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4889. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4890. thread_local std::random_device rd;
  4891. size_t filled = 0;
  4892. while (filled < n) {
  4893. auto v = rd();
  4894. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4895. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4896. }
  4897. }
  4898. }
  4899. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4900. const char *data, size_t len, bool fin,
  4901. bool mask) {
  4902. // First byte: FIN + opcode
  4903. uint8_t header[2];
  4904. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4905. (static_cast<uint8_t>(opcode) & 0x0F));
  4906. // Second byte: MASK + payload length
  4907. if (len < 126) {
  4908. header[1] = static_cast<uint8_t>(len);
  4909. if (mask) { header[1] |= 0x80; }
  4910. if (!write_data(strm, reinterpret_cast<char *>(header), 2)) {
  4911. return false;
  4912. }
  4913. } else if (len <= 0xFFFF) {
  4914. header[1] = 126;
  4915. if (mask) { header[1] |= 0x80; }
  4916. if (!write_data(strm, reinterpret_cast<char *>(header), 2)) {
  4917. return false;
  4918. }
  4919. uint8_t ext[2];
  4920. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4921. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4922. if (!write_data(strm, reinterpret_cast<char *>(ext), 2)) { return false; }
  4923. } else {
  4924. header[1] = 127;
  4925. if (mask) { header[1] |= 0x80; }
  4926. if (!write_data(strm, reinterpret_cast<char *>(header), 2)) {
  4927. return false;
  4928. }
  4929. uint8_t ext[8];
  4930. for (int i = 7; i >= 0; i--) {
  4931. ext[7 - i] =
  4932. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4933. }
  4934. if (!write_data(strm, reinterpret_cast<char *>(ext), 8)) { return false; }
  4935. }
  4936. if (mask) {
  4937. // Generate random mask key
  4938. uint8_t mask_key[4];
  4939. fill_random_bytes(mask_key, sizeof(mask_key));
  4940. if (!write_data(strm, reinterpret_cast<char *>(mask_key), 4)) {
  4941. return false;
  4942. }
  4943. // Write masked payload in chunks
  4944. const size_t chunk_size = 4096;
  4945. std::vector<char> buf((std::min)(len, chunk_size));
  4946. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4947. size_t n = (std::min)(chunk_size, len - offset);
  4948. for (size_t i = 0; i < n; i++) {
  4949. buf[i] =
  4950. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4951. }
  4952. if (!write_data(strm, buf.data(), n)) { return false; }
  4953. }
  4954. } else {
  4955. if (len > 0) {
  4956. if (!write_data(strm, data, len)) { return false; }
  4957. }
  4958. }
  4959. return true;
  4960. }
  4961. } // namespace detail
  4962. namespace ws {
  4963. namespace impl {
  4964. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4965. // hands back whatever its buffer already holds -- so every multi-byte field has
  4966. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4967. // header straddles the read buffer's boundary.
  4968. //
  4969. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4970. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4971. // there is a failure like any other. (When read() fails it always records why,
  4972. // so the error belongs to this call and not to an earlier one.)
  4973. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4974. auto p = static_cast<char *>(buf);
  4975. size_t total = 0;
  4976. while (total < size) {
  4977. auto n = strm.read(p + total, size - total);
  4978. if (n <= 0) {
  4979. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4980. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4981. }
  4982. total += static_cast<size_t>(n);
  4983. }
  4984. return FrameRead::Ok;
  4985. }
  4986. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4987. std::string &payload, bool &fin,
  4988. bool expect_masked, size_t max_len) {
  4989. // Read first 2 bytes. This is the only read that may report a timeout: it
  4990. // sits on a frame boundary, where nothing has been consumed yet.
  4991. uint8_t header[2];
  4992. FrameRead first = read_exact(strm, header, 2);
  4993. if (first != FrameRead::Ok) { return first; }
  4994. fin = (header[0] & 0x80) != 0;
  4995. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4996. if (header[0] & 0x70) { return FrameRead::Fail; }
  4997. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4998. bool masked = (header[1] & 0x80) != 0;
  4999. uint64_t payload_len = header[1] & 0x7F;
  5000. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  5001. // MUST have a payload length of 125 bytes or less
  5002. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  5003. if (is_control) {
  5004. if (!fin) { return FrameRead::Fail; }
  5005. if (payload_len > 125) { return FrameRead::Fail; }
  5006. }
  5007. if (masked != expect_masked) { return FrameRead::Fail; }
  5008. // Extended payload length
  5009. if (payload_len == 126) {
  5010. uint8_t ext[2];
  5011. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  5012. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  5013. } else if (payload_len == 127) {
  5014. uint8_t ext[8];
  5015. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  5016. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  5017. if (ext[0] & 0x80) { return FrameRead::Fail; }
  5018. payload_len = 0;
  5019. for (int i = 0; i < 8; i++) {
  5020. payload_len = (payload_len << 8) | ext[i];
  5021. }
  5022. }
  5023. // A max_len of 0 means no limit, as payload_max_length does, and a length
  5024. // size_t cannot hold (32-bit builds) is refused either way.
  5025. if ((max_len > 0 && payload_len > max_len) ||
  5026. !detail::fits_in_size_t(payload_len)) {
  5027. return FrameRead::Fail;
  5028. }
  5029. // Read mask key if present
  5030. uint8_t mask_key[4] = {0};
  5031. if (masked) {
  5032. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  5033. return FrameRead::Fail;
  5034. }
  5035. }
  5036. // Grow the payload only as it arrives, since a header alone can announce
  5037. // max_len bytes that never come.
  5038. payload.clear();
  5039. auto len = static_cast<size_t>(payload_len);
  5040. while (payload.size() < len) {
  5041. auto offset = payload.size();
  5042. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  5043. payload.resize(offset + n);
  5044. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  5045. return FrameRead::Fail;
  5046. }
  5047. }
  5048. // Unmask if needed
  5049. if (masked) {
  5050. for (size_t i = 0; i < payload.size(); i++) {
  5051. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  5052. }
  5053. }
  5054. return FrameRead::Ok;
  5055. }
  5056. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  5057. // be sent followed by a UTF-8 reason.
  5058. inline bool is_valid_close_payload(const std::string &payload) {
  5059. if (payload.empty()) { return true; }
  5060. if (payload.size() < 2) { return false; }
  5061. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  5062. static_cast<uint8_t>(payload[1]);
  5063. auto may_be_sent = (1000 <= code && code <= 1003) ||
  5064. (1007 <= code && code <= 1014) ||
  5065. (3000 <= code && code <= 4999);
  5066. return may_be_sent && is_valid_utf8(payload.substr(2));
  5067. }
  5068. } // namespace impl
  5069. } // namespace ws
  5070. namespace detail {
  5071. // A path a mount point serves: absolute, with no empty segment except a
  5072. // trailing '/', no segment ending in '.' or a space (which covers "." and
  5073. // ".." and names Windows trims into another file's name) and, on Windows, no
  5074. // ':' (which names an NTFS stream, so "a.txt::$DATA" is a.txt), so the file
  5075. // served is the one that req.path names to the handlers that ran before it.
  5076. inline bool is_valid_path(const std::string &path) {
  5077. if (path.empty() || path[0] != '/') { return false; }
  5078. auto beg = size_t{1};
  5079. for (auto i = beg; i <= path.size(); i++) {
  5080. if (i < path.size() && path[i] != '/') {
  5081. if (path[i] == '\0' || path[i] == '\\') { return false; }
  5082. #ifdef _WIN32
  5083. if (path[i] == ':') { return false; }
  5084. #endif
  5085. continue;
  5086. }
  5087. auto len = i - beg;
  5088. if ((len == 0 && i < path.size()) ||
  5089. (len > 0 && (path[i - 1] == '.' || path[i - 1] == ' '))) {
  5090. return false;
  5091. }
  5092. beg = i + 1;
  5093. }
  5094. return true;
  5095. }
  5096. inline bool canonicalize_path(const char *path, std::string &resolved) {
  5097. #if defined(_WIN32)
  5098. // Resolve junctions and symlinks, as realpath() does
  5099. auto wpath = u8string_to_wstring(path);
  5100. if (wpath.empty()) { return false; }
  5101. CREATEFILE2_EXTENDED_PARAMETERS params{};
  5102. params.dwSize = sizeof(params);
  5103. params.dwFileFlags = FILE_FLAG_BACKUP_SEMANTICS; // Needed to open a directory
  5104. auto h = ::CreateFile2(wpath.c_str(), 0,
  5105. FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
  5106. OPEN_EXISTING, &params);
  5107. if (h == INVALID_HANDLE_VALUE) { return false; }
  5108. auto guard = scope_exit([&]() { ::CloseHandle(h); });
  5109. std::wstring wbuf(MAX_PATH, L'\0');
  5110. auto len = ::GetFinalPathNameByHandleW(
  5111. h, &wbuf[0], static_cast<DWORD>(wbuf.size()), FILE_NAME_NORMALIZED);
  5112. if (len >= wbuf.size()) {
  5113. wbuf.resize(len);
  5114. len = ::GetFinalPathNameByHandleW(
  5115. h, &wbuf[0], static_cast<DWORD>(wbuf.size()), FILE_NAME_NORMALIZED);
  5116. }
  5117. if (len == 0 || len >= wbuf.size()) { return false; }
  5118. auto n = ::WideCharToMultiByte(CP_UTF8, 0, wbuf.data(), static_cast<int>(len),
  5119. nullptr, 0, nullptr, nullptr);
  5120. if (n <= 0) { return false; }
  5121. resolved.assign(static_cast<size_t>(n), '\0');
  5122. ::WideCharToMultiByte(CP_UTF8, 0, wbuf.data(), static_cast<int>(len),
  5123. &resolved[0], n, nullptr, nullptr);
  5124. #elif defined(PATH_MAX)
  5125. char buf[PATH_MAX];
  5126. if (realpath(path, buf) == nullptr) { return false; }
  5127. resolved = buf;
  5128. #else
  5129. auto buf = realpath(path, nullptr);
  5130. auto guard = scope_exit([&]() { std::free(buf); });
  5131. if (buf == nullptr) { return false; }
  5132. resolved = buf;
  5133. #endif
  5134. return true;
  5135. }
  5136. inline bool is_path_within_base(const std::string &resolved_path,
  5137. const std::string &resolved_base) {
  5138. #if defined(_WIN32)
  5139. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  5140. resolved_base.size()) == 0;
  5141. #else
  5142. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  5143. resolved_base.size()) == 0;
  5144. #endif
  5145. }
  5146. inline FileStat::FileStat(const std::string &path) {
  5147. #if defined(_WIN32)
  5148. auto wpath = u8string_to_wstring(path.c_str());
  5149. ret_ = _wstat(wpath.c_str(), &st_);
  5150. #else
  5151. ret_ = stat(path.c_str(), &st_);
  5152. #endif
  5153. }
  5154. inline bool FileStat::is_file() const {
  5155. return ret_ >= 0 && S_ISREG(st_.st_mode);
  5156. }
  5157. inline bool FileStat::is_dir() const {
  5158. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  5159. }
  5160. inline time_t FileStat::mtime() const {
  5161. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  5162. : static_cast<time_t>(-1);
  5163. }
  5164. inline size_t FileStat::size() const {
  5165. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  5166. }
  5167. inline std::string encode_path(const std::string &s) {
  5168. std::string result;
  5169. result.reserve(s.size());
  5170. for (size_t i = 0; s[i]; i++) {
  5171. switch (s[i]) {
  5172. case ' ': result += "%20"; break;
  5173. case '+': result += "%2B"; break;
  5174. case '\'': result += "%27"; break;
  5175. case ',': result += "%2C"; break;
  5176. // case ':': result += "%3A"; break; // ok? probably...
  5177. case ';': result += "%3B"; break;
  5178. default:
  5179. auto c = static_cast<uint8_t>(s[i]);
  5180. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  5181. // in a request-target as-is.
  5182. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  5183. result += '%';
  5184. char hex[4];
  5185. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  5186. assert(len == 2);
  5187. result.append(hex, static_cast<size_t>(len));
  5188. } else {
  5189. result += s[i];
  5190. }
  5191. break;
  5192. }
  5193. }
  5194. return result;
  5195. }
  5196. inline std::string file_extension(const std::string &path) {
  5197. auto i = path.size();
  5198. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  5199. i--;
  5200. }
  5201. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  5202. return std::string();
  5203. }
  5204. return path.substr(i);
  5205. }
  5206. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  5207. template <typename T>
  5208. inline bool parse_header(const char *beg, const char *end, T fn);
  5209. template <typename T>
  5210. inline bool parse_header(const char *beg, const char *end, T fn) {
  5211. // Skip trailing spaces and tabs.
  5212. while (beg < end && is_space_or_tab(end[-1])) {
  5213. end--;
  5214. }
  5215. auto p = beg;
  5216. while (p < end && *p != ':') {
  5217. p++;
  5218. }
  5219. auto name = std::string(beg, p);
  5220. if (!detail::fields::is_field_name(name)) { return false; }
  5221. if (p == end) { return false; }
  5222. auto key_end = p;
  5223. if (*p++ != ':') { return false; }
  5224. while (p < end && is_space_or_tab(*p)) {
  5225. p++;
  5226. }
  5227. if (p <= end) {
  5228. auto key_len = key_end - beg;
  5229. if (!key_len) { return false; }
  5230. auto key = std::string(beg, key_end);
  5231. auto val = std::string(p, end);
  5232. if (!detail::fields::is_field_value(val)) { return false; }
  5233. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5234. // percent-decoded by the recipient. Applications that need to interpret a
  5235. // value as a URI component should call httplib::decode_uri_component()
  5236. // (or decode_path_component()) explicitly.
  5237. fn(key, val);
  5238. return true;
  5239. }
  5240. return false;
  5241. }
  5242. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5243. const Headers &src_headers) {
  5244. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5245. // transfer coding is complete when a chunk with a chunk-size of zero is
  5246. // received, possibly followed by a trailer section, and finally terminated by
  5247. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5248. //
  5249. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5250. // doesn't care for the existence of the final CRLF. In other words, it seems
  5251. // to be ok whether the final CRLF exists or not in the chunked data.
  5252. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5253. //
  5254. // According to the reference code in RFC 9112, cpp-httplib now allows
  5255. // chunked transfer coding data without the final CRLF.
  5256. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5257. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5258. "transfer-encoding",
  5259. "content-length",
  5260. "host",
  5261. "authorization",
  5262. "www-authenticate",
  5263. "proxy-authenticate",
  5264. "proxy-authorization",
  5265. "cookie",
  5266. "set-cookie",
  5267. "cache-control",
  5268. "expect",
  5269. "max-forwards",
  5270. "pragma",
  5271. "range",
  5272. "te",
  5273. "age",
  5274. "expires",
  5275. "date",
  5276. "location",
  5277. "retry-after",
  5278. "vary",
  5279. "warning",
  5280. "content-encoding",
  5281. "content-type",
  5282. "content-range",
  5283. "trailer"};
  5284. case_ignore::unordered_set<std::string> declared_trailers;
  5285. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5286. if (!trailer_header.empty()) {
  5287. // split() trims each token and skips empty ones, so the name arrives ready
  5288. // to look up.
  5289. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5290. ',', [&](const char *b, const char *e) {
  5291. // A legitimate message declares only a handful of trailers. Cap the
  5292. // set so a peer cannot grow it without bound: an oversized set only
  5293. // arises from an attempt to force many colliding names into
  5294. // quadratic lookups (case_ignore::hash is unkeyed).
  5295. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5296. return;
  5297. }
  5298. std::string key(b, e);
  5299. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5300. declared_trailers.insert(key);
  5301. }
  5302. });
  5303. }
  5304. size_t trailer_header_count = 0;
  5305. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5306. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5307. // Count every received trailer field, not only the declared ones stored in
  5308. // dest, so undeclared fields cannot keep this loop running past the limit.
  5309. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5310. constexpr auto line_terminator_len = 2;
  5311. auto line_beg = line_reader.ptr();
  5312. auto line_end =
  5313. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5314. if (!parse_header(line_beg, line_end,
  5315. [&](const std::string &key, const std::string &val) {
  5316. if (declared_trailers.find(key) !=
  5317. declared_trailers.end()) {
  5318. dest.emplace(key, val);
  5319. }
  5320. })) {
  5321. return false;
  5322. }
  5323. trailer_header_count++;
  5324. if (!line_reader.getline()) { return false; }
  5325. }
  5326. return true;
  5327. }
  5328. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5329. size_t right) {
  5330. while (b + left < e && is_space_or_tab(b[left])) {
  5331. left++;
  5332. }
  5333. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5334. right--;
  5335. }
  5336. return std::make_pair(left, right);
  5337. }
  5338. inline std::string trim_copy(const std::string &s) {
  5339. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5340. return s.substr(r.first, r.second - r.first);
  5341. }
  5342. inline std::string trim_double_quotes_copy(const std::string &s) {
  5343. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5344. return s.substr(1, s.size() - 2);
  5345. }
  5346. return s;
  5347. }
  5348. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  5349. // here, as browsers send any other backslash, such as one in a Windows path,
  5350. // as it is.
  5351. inline std::string unquote_param(const std::string &s) {
  5352. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  5353. std::string out;
  5354. for (size_t i = 1; i + 1 < s.size(); i++) {
  5355. if (s[i] == '\\' && i + 2 < s.size() &&
  5356. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  5357. i++;
  5358. }
  5359. out += s[i];
  5360. }
  5361. return out;
  5362. }
  5363. inline void
  5364. divide(const char *data, std::size_t size, char d,
  5365. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5366. fn) {
  5367. const auto it = std::find(data, data + size, d);
  5368. const auto found = static_cast<std::size_t>(it != data + size);
  5369. const auto lhs_data = data;
  5370. const auto lhs_size = static_cast<std::size_t>(it - data);
  5371. const auto rhs_data = it + found;
  5372. const auto rhs_size = size - lhs_size - found;
  5373. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5374. }
  5375. inline void
  5376. divide(const std::string &str, char d,
  5377. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5378. fn) {
  5379. divide(str.data(), str.size(), d, std::move(fn));
  5380. }
  5381. inline void split(const char *b, const char *e, char d,
  5382. std::function<void(const char *, const char *)> fn) {
  5383. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5384. }
  5385. inline void split(const char *b, const char *e, char d, size_t m,
  5386. std::function<void(const char *, const char *)> fn) {
  5387. size_t i = 0;
  5388. size_t beg = 0;
  5389. size_t count = 1;
  5390. while (e ? (b + i < e) : (b[i] != '\0')) {
  5391. if (b[i] == d && count < m) {
  5392. auto r = trim(b, e, beg, i);
  5393. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5394. beg = i + 1;
  5395. count++;
  5396. }
  5397. i++;
  5398. }
  5399. if (i) {
  5400. auto r = trim(b, e, beg, i);
  5401. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5402. }
  5403. }
  5404. // Same contract as split(), except that a delimiter inside a quoted-string is
  5405. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5406. // quoted-string, and ';' and '=' are legal characters inside one.
  5407. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5408. std::function<void(const char *, const char *)> fn) {
  5409. size_t i = 0;
  5410. size_t beg = 0;
  5411. size_t count = 1;
  5412. auto in_quotes = false;
  5413. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5414. while (has(i)) {
  5415. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5416. // A quoted-pair, whose second character does not end the string.
  5417. i++;
  5418. } else if (b[i] == '"') {
  5419. in_quotes = !in_quotes;
  5420. } else if (b[i] == d && !in_quotes && count < m) {
  5421. auto r = trim(b, e, beg, i);
  5422. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5423. beg = i + 1;
  5424. count++;
  5425. }
  5426. i++;
  5427. }
  5428. if (i) {
  5429. auto r = trim(b, e, beg, i);
  5430. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5431. }
  5432. }
  5433. inline void split_unquoted(const char *b, const char *e, char d,
  5434. std::function<void(const char *, const char *)> fn) {
  5435. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5436. std::move(fn));
  5437. }
  5438. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5439. // key a token, so the first '=' is the separator even when the value is a
  5440. // quoted-string carrying more of them.
  5441. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5442. std::string &val) {
  5443. divide(
  5444. b, static_cast<std::size_t>(e - b), '=',
  5445. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5446. const auto kr = trim(kb, kb + klen, 0, klen);
  5447. key.assign(kb + kr.first, kb + kr.second);
  5448. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5449. val.assign(vb + vr.first, vb + vr.second);
  5450. });
  5451. }
  5452. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5453. std::function<bool(const char *, const char *)> fn) {
  5454. size_t i = 0;
  5455. size_t beg = 0;
  5456. size_t count = 1;
  5457. while (e ? (b + i < e) : (b[i] != '\0')) {
  5458. if (b[i] == d && count < m) {
  5459. auto r = trim(b, e, beg, i);
  5460. if (r.first < r.second) {
  5461. auto found = fn(&b[r.first], &b[r.second]);
  5462. if (found) { return true; }
  5463. }
  5464. beg = i + 1;
  5465. count++;
  5466. }
  5467. i++;
  5468. }
  5469. if (i) {
  5470. auto r = trim(b, e, beg, i);
  5471. if (r.first < r.second) {
  5472. auto found = fn(&b[r.first], &b[r.second]);
  5473. if (found) { return true; }
  5474. }
  5475. }
  5476. return false;
  5477. }
  5478. inline bool split_find(const char *b, const char *e, char d,
  5479. std::function<bool(const char *, const char *)> fn) {
  5480. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5481. std::move(fn));
  5482. }
  5483. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5484. size_t fixed_buffer_size)
  5485. : strm_(strm), fixed_buffer_(fixed_buffer),
  5486. fixed_buffer_size_(fixed_buffer_size) {}
  5487. inline const char *stream_line_reader::ptr() const {
  5488. if (growable_buffer_.empty()) {
  5489. return fixed_buffer_;
  5490. } else {
  5491. return growable_buffer_.data();
  5492. }
  5493. }
  5494. inline size_t stream_line_reader::size() const {
  5495. if (growable_buffer_.empty()) {
  5496. return fixed_buffer_used_size_;
  5497. } else {
  5498. return growable_buffer_.size();
  5499. }
  5500. }
  5501. inline bool stream_line_reader::end_with_crlf() const {
  5502. auto end = ptr() + size();
  5503. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5504. }
  5505. inline bool stream_line_reader::getline() {
  5506. fixed_buffer_used_size_ = 0;
  5507. growable_buffer_.clear();
  5508. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5509. char prev_byte = 0;
  5510. #endif
  5511. for (size_t i = 0;; i++) {
  5512. // Fast path: whatever the stream has already buffered can be scanned for
  5513. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5514. // call, a bounds check and a one-byte copy per character of the request.
  5515. size_t buffered_size = 0;
  5516. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5517. auto take = buffered_size;
  5518. auto terminated = false;
  5519. for (size_t at = 0; at < buffered_size;) {
  5520. auto nl = static_cast<const char *>(
  5521. memchr(buffered + at, '\n', buffered_size - at));
  5522. if (!nl) { break; }
  5523. auto pos = static_cast<size_t>(nl - buffered);
  5524. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5525. take = pos + 1;
  5526. terminated = true;
  5527. break;
  5528. #else
  5529. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5530. // be the last byte of an earlier chunk, hence prev_byte.
  5531. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5532. take = pos + 1;
  5533. terminated = true;
  5534. break;
  5535. }
  5536. at = pos + 1;
  5537. #endif
  5538. }
  5539. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5540. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5541. prev_byte = buffered[take - 1];
  5542. #endif
  5543. append(buffered, take);
  5544. strm_.consume_buffered(take);
  5545. i += take;
  5546. if (terminated) { return true; }
  5547. continue;
  5548. }
  5549. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5550. // Treat exceptionally long lines as an error to
  5551. // prevent infinite loops/memory exhaustion
  5552. return false;
  5553. }
  5554. char byte;
  5555. auto n = strm_.read(&byte, 1);
  5556. if (n < 0) {
  5557. return false;
  5558. } else if (n == 0) {
  5559. if (i == 0) {
  5560. return false;
  5561. } else {
  5562. break;
  5563. }
  5564. }
  5565. append(byte);
  5566. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5567. if (byte == '\n') { break; }
  5568. #else
  5569. if (prev_byte == '\r' && byte == '\n') { break; }
  5570. prev_byte = byte;
  5571. #endif
  5572. }
  5573. return true;
  5574. }
  5575. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5576. inline void stream_line_reader::append(const char *data, size_t size) {
  5577. // Once the line has outgrown the fixed buffer everything must keep going to
  5578. // the growable one, even if a later chunk would have fit. Without the
  5579. // emptiness check a short append after a long one would land in the fixed
  5580. // buffer, which ptr() and size() no longer look at, and be lost.
  5581. if (growable_buffer_.empty() &&
  5582. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5583. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5584. fixed_buffer_used_size_ += size;
  5585. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5586. } else {
  5587. // Unlike the per-character overload, this can be the very first append of
  5588. // the line, so the fixed buffer may hold nothing and carry no terminator
  5589. // yet. assign() takes an explicit length and does not need one.
  5590. if (growable_buffer_.empty()) {
  5591. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5592. }
  5593. growable_buffer_.append(data, size);
  5594. }
  5595. }
  5596. inline mmap::mmap(const char *path) { open(path); }
  5597. inline mmap::~mmap() { close(); }
  5598. inline bool mmap::open(const char *path) {
  5599. close();
  5600. #if defined(_WIN32)
  5601. auto wpath = u8string_to_wstring(path);
  5602. if (wpath.empty()) { return false; }
  5603. hFile_ =
  5604. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5605. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5606. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5607. LARGE_INTEGER size{};
  5608. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5609. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5610. // See:
  5611. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5612. if (!fits_in_size_t(static_cast<uint64_t>(size.QuadPart))) { return false; }
  5613. size_ = static_cast<size_t>(size.QuadPart);
  5614. hMapping_ =
  5615. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5616. // Special treatment for an empty file...
  5617. if (hMapping_ == NULL && size_ == 0) {
  5618. close();
  5619. is_open_empty_file = true;
  5620. return true;
  5621. }
  5622. if (hMapping_ == NULL) {
  5623. close();
  5624. return false;
  5625. }
  5626. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5627. if (addr_ == nullptr) {
  5628. close();
  5629. return false;
  5630. }
  5631. #else
  5632. // O_NONBLOCK so that opening a FIFO does not wait for a writer.
  5633. fd_ = ::open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
  5634. if (fd_ == -1) { return false; }
  5635. // Only a regular file has a size to serve, unlike a directory or a device.
  5636. struct stat sb;
  5637. if (fstat(fd_, &sb) == -1 || !S_ISREG(sb.st_mode) ||
  5638. !fits_in_size_t(static_cast<uint64_t>(sb.st_size))) {
  5639. close();
  5640. return false;
  5641. }
  5642. size_ = static_cast<size_t>(sb.st_size);
  5643. #endif
  5644. return true;
  5645. }
  5646. inline bool mmap::is_open() const {
  5647. #if defined(_WIN32)
  5648. return is_open_empty_file ? true : addr_ != nullptr;
  5649. #else
  5650. return fd_ != -1;
  5651. #endif
  5652. }
  5653. inline size_t mmap::size() const { return size_; }
  5654. inline void mmap::close() {
  5655. #if defined(_WIN32)
  5656. if (addr_) {
  5657. ::UnmapViewOfFile(addr_);
  5658. addr_ = nullptr;
  5659. }
  5660. if (hMapping_) {
  5661. ::CloseHandle(hMapping_);
  5662. hMapping_ = NULL;
  5663. }
  5664. if (hFile_ != INVALID_HANDLE_VALUE) {
  5665. ::CloseHandle(hFile_);
  5666. hFile_ = INVALID_HANDLE_VALUE;
  5667. }
  5668. is_open_empty_file = false;
  5669. #else
  5670. if (fd_ != -1) {
  5671. ::close(fd_);
  5672. fd_ = -1;
  5673. }
  5674. #endif
  5675. size_ = 0;
  5676. }
  5677. inline int close_socket(socket_t sock) noexcept {
  5678. #ifdef _WIN32
  5679. return closesocket(sock);
  5680. #else
  5681. return close(sock);
  5682. #endif
  5683. }
  5684. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5685. ssize_t res = 0;
  5686. while (true) {
  5687. res = fn();
  5688. if (res < 0 && errno == EINTR) {
  5689. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5690. continue;
  5691. }
  5692. break;
  5693. }
  5694. return res;
  5695. }
  5696. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5697. if (offset >= size_) { return 0; }
  5698. len = (std::min)(len, size_ - offset);
  5699. #if defined(_WIN32)
  5700. // Windows does not let a mapped file be truncated.
  5701. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5702. return len;
  5703. #else
  5704. auto n = handle_EINTR(
  5705. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5706. return n > 0 ? static_cast<size_t>(n) : 0;
  5707. #endif
  5708. }
  5709. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5710. return handle_EINTR([&]() {
  5711. return recv(sock,
  5712. #ifdef _WIN32
  5713. static_cast<char *>(ptr), static_cast<int>(size),
  5714. #else
  5715. ptr, size,
  5716. #endif
  5717. flags);
  5718. });
  5719. }
  5720. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5721. int flags) {
  5722. return handle_EINTR([&]() {
  5723. return send(sock,
  5724. #ifdef _WIN32
  5725. static_cast<const char *>(ptr), static_cast<int>(size),
  5726. #else
  5727. ptr, size,
  5728. #endif
  5729. flags);
  5730. });
  5731. }
  5732. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5733. #ifdef _WIN32
  5734. return ::WSAPoll(fds, nfds, timeout);
  5735. #else
  5736. return ::poll(fds, nfds, timeout);
  5737. #endif
  5738. }
  5739. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5740. time_t usec) {
  5741. struct pollfd pfd;
  5742. pfd.fd = sock;
  5743. pfd.events = events;
  5744. pfd.revents = 0;
  5745. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5746. // "return immediately", which callers here rely on to probe a socket.
  5747. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5748. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5749. }
  5750. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5751. return select_impl(sock, POLLIN, sec, usec);
  5752. }
  5753. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5754. return select_impl(sock, POLLOUT, sec, usec);
  5755. }
  5756. // The point sec and usec from now, for select_until(). A negative sec, or one
  5757. // past what the clock reaches, never comes.
  5758. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5759. time_t usec) {
  5760. auto now = std::chrono::steady_clock::now();
  5761. auto never = (std::chrono::steady_clock::time_point::max)();
  5762. if (sec < 0 ||
  5763. sec >= std::chrono::duration_cast<std::chrono::seconds>(never - now)
  5764. .count()) {
  5765. return never;
  5766. }
  5767. return now + std::chrono::seconds(sec) + std::chrono::microseconds(usec);
  5768. }
  5769. // Waits only for the time left until deadline, so that all the waits of one
  5770. // TLS handshake come out of a single timeout. With interrupted, it waits in
  5771. // slices and gives up once interrupted() returns true, as a local shutdown()
  5772. // would not wake the wait on Windows.
  5773. inline ssize_t
  5774. select_until(socket_t sock, short events,
  5775. std::chrono::steady_clock::time_point deadline,
  5776. const std::function<bool()> &interrupted = nullptr) {
  5777. if (!interrupted) {
  5778. if (deadline == (std::chrono::steady_clock::time_point::max)()) {
  5779. return select_impl(sock, events, -1, 0);
  5780. }
  5781. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5782. deadline - std::chrono::steady_clock::now())
  5783. .count();
  5784. if (left <= 0) { return 0; }
  5785. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5786. static_cast<time_t>(left % 1000000));
  5787. }
  5788. const auto slice = std::chrono::microseconds(100000);
  5789. while (!interrupted()) {
  5790. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5791. deadline - std::chrono::steady_clock::now());
  5792. auto last = left < slice;
  5793. // poll() takes whole milliseconds, so round the last wait up to keep it
  5794. // from ending before the deadline.
  5795. auto wait_usec = last ? (std::max)((left.count() + 999) / 1000 * 1000,
  5796. static_cast<decltype(left.count())>(0))
  5797. : slice.count();
  5798. auto ret = select_impl(sock, events, 0, static_cast<time_t>(wait_usec));
  5799. if (ret != 0 || last) { return ret; }
  5800. }
  5801. return 0;
  5802. }
  5803. // select_impl(), but waits in slices and gives up once interrupted() returns
  5804. // true
  5805. inline ssize_t select_interruptible(socket_t sock, short events, time_t sec,
  5806. time_t usec,
  5807. const std::function<bool()> &interrupted) {
  5808. if (!interrupted) { return select_impl(sock, events, sec, usec); }
  5809. return select_until(sock, events, deadline_after(sec, usec), interrupted);
  5810. }
  5811. inline ssize_t
  5812. select_read_interruptible(socket_t sock, time_t sec, time_t usec,
  5813. const std::function<bool()> &interrupted) {
  5814. return select_interruptible(sock, POLLIN, sec, usec, interrupted);
  5815. }
  5816. // Waits for a connect in progress, which ends as Error::Canceled once
  5817. // interrupted() returns true
  5818. inline Error
  5819. wait_until_socket_is_ready(socket_t sock, time_t sec, time_t usec,
  5820. const std::function<bool()> &interrupted = nullptr) {
  5821. auto ret =
  5822. select_interruptible(sock, POLLIN | POLLOUT, sec, usec, interrupted);
  5823. if (ret == 0) {
  5824. return interrupted && interrupted() ? Error::Canceled
  5825. : Error::ConnectionTimeout;
  5826. }
  5827. if (ret < 0) { return Error::Connection; }
  5828. // A failed connect reports its error here, whatever events poll() returned
  5829. auto error = 0;
  5830. socklen_t len = sizeof(error);
  5831. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5832. reinterpret_cast<char *>(&error), &len);
  5833. return res >= 0 && !error ? Error::Success : Error::Connection;
  5834. }
  5835. inline bool is_socket_alive(socket_t sock) {
  5836. const auto val = detail::select_read(sock, 0, 0);
  5837. if (val == 0) {
  5838. return true;
  5839. } else if (val < 0 && errno == EBADF) {
  5840. return false;
  5841. }
  5842. char buf[1];
  5843. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5844. }
  5845. class SocketStream final : public Stream {
  5846. public:
  5847. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5848. time_t write_timeout_sec, time_t write_timeout_usec,
  5849. time_t max_timeout_msec = 0,
  5850. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5851. (std::chrono::steady_clock::time_point::min)());
  5852. ~SocketStream() override;
  5853. bool is_readable() const override;
  5854. bool wait_readable() const override;
  5855. bool wait_writable() const override;
  5856. bool is_peer_alive() const override;
  5857. ssize_t read(char *ptr, size_t size) override;
  5858. ssize_t write(const char *ptr, size_t size) override;
  5859. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5860. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5861. socket_t socket() const override;
  5862. time_t duration() const override;
  5863. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5864. void set_max_timeout(time_t msec) override;
  5865. void set_read_interrupt(std::function<bool()> interrupted) override;
  5866. const char *buffered_data(size_t &size) const override;
  5867. void consume_buffered(size_t size) override;
  5868. // The caller has just seen this socket become readable. Lets the next read
  5869. // skip its own readiness wait, which would otherwise ask the kernel a
  5870. // question that was answered a moment ago. Consumed by that read.
  5871. void set_readable_hint() { readable_hint_ = true; }
  5872. private:
  5873. bool ensure_readable();
  5874. socket_t sock_;
  5875. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5876. // thread while a read is in flight -- that is the point of it, for a caller
  5877. // holding one connection and wanting control back to send on it.
  5878. std::atomic<time_t> read_timeout_sec_;
  5879. std::atomic<time_t> read_timeout_usec_;
  5880. time_t write_timeout_sec_;
  5881. time_t write_timeout_usec_;
  5882. time_t max_timeout_msec_;
  5883. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5884. std::function<bool()> read_interrupted_;
  5885. std::vector<char> read_buff_;
  5886. size_t read_buff_off_ = 0;
  5887. size_t read_buff_content_size_ = 0;
  5888. bool readable_hint_ = false;
  5889. static const size_t read_buff_size_ = 1024l * 4;
  5890. };
  5891. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5892. time_t keep_alive_timeout_sec) {
  5893. using namespace std::chrono;
  5894. const auto interval_usec =
  5895. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5896. // Avoid expensive `steady_clock::now()` call for the first time
  5897. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5898. const auto start = steady_clock::now() - microseconds{interval_usec};
  5899. const auto timeout = seconds{keep_alive_timeout_sec};
  5900. while (true) {
  5901. if (svr_sock == INVALID_SOCKET) {
  5902. break; // Server socket is closed
  5903. }
  5904. auto val = select_read(sock, 0, interval_usec);
  5905. if (val < 0) {
  5906. break; // Ssocket error
  5907. } else if (val == 0) {
  5908. if (steady_clock::now() - start > timeout) {
  5909. break; // Timeout
  5910. }
  5911. } else {
  5912. return true; // Ready for read
  5913. }
  5914. }
  5915. return false;
  5916. }
  5917. // `has_buffered_request` reports whether the connection's stream already holds
  5918. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5919. // 9.3.2), so reading one request can pull the start of the next one into the
  5920. // stream's buffer; that request must be served without waiting for the socket
  5921. // to become readable again, since its bytes are no longer on the socket.
  5922. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5923. template <typename P, typename T>
  5924. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5925. socket_t sock,
  5926. size_t keep_alive_max_count,
  5927. time_t keep_alive_timeout_sec,
  5928. P has_buffered_request, T callback) {
  5929. auto ret = false;
  5930. // A keep_alive_max_count of 0 sets no limit.
  5931. for (size_t served = 0;
  5932. keep_alive_max_count == 0 || served < keep_alive_max_count; served++) {
  5933. auto socket_readable = false;
  5934. if (!has_buffered_request()) {
  5935. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5936. socket_readable = true;
  5937. }
  5938. auto close_connection = served + 1 == keep_alive_max_count;
  5939. auto connection_closed = false;
  5940. ret = callback(socket_readable, close_connection, connection_closed);
  5941. if (!ret || connection_closed) { break; }
  5942. }
  5943. return ret;
  5944. }
  5945. template <typename T>
  5946. inline bool
  5947. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5948. size_t keep_alive_max_count,
  5949. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5950. time_t read_timeout_usec, time_t write_timeout_sec,
  5951. time_t write_timeout_usec, T callback) {
  5952. // One stream per connection: its read buffer can already hold the start of
  5953. // the next, pipelined request.
  5954. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5955. write_timeout_sec, write_timeout_usec);
  5956. return process_server_socket_core(
  5957. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5958. [&]() { return strm.is_readable(); },
  5959. [&](bool socket_readable, bool close_connection,
  5960. bool &connection_closed) {
  5961. if (socket_readable) { strm.set_readable_hint(); }
  5962. return callback(strm, close_connection, connection_closed);
  5963. });
  5964. }
  5965. inline bool process_client_socket(
  5966. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5967. time_t write_timeout_sec, time_t write_timeout_usec,
  5968. time_t max_timeout_msec,
  5969. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5970. std::function<bool(Stream &)> callback) {
  5971. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5972. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5973. start_time);
  5974. return callback(strm);
  5975. }
  5976. inline int shutdown_socket(socket_t sock) noexcept {
  5977. #ifdef _WIN32
  5978. return shutdown(sock, SD_BOTH);
  5979. #else
  5980. return shutdown(sock, SHUT_RDWR);
  5981. #endif
  5982. }
  5983. // Half-closes the write side and drains any in-flight/queued bytes before
  5984. // the final shutdown+close. Closing with unread data in the receive queue
  5985. // (or bytes arriving after the receive side is closed) makes the stack send
  5986. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5987. // response as a failed read even though it was fully written.
  5988. inline void drain_and_close_socket(socket_t sock) noexcept {
  5989. #ifdef _WIN32
  5990. shutdown(sock, SD_SEND);
  5991. #else
  5992. shutdown(sock, SHUT_WR);
  5993. #endif
  5994. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5995. size_t total = 0;
  5996. const auto deadline = std::chrono::steady_clock::now() +
  5997. std::chrono::milliseconds(100); // bound #1
  5998. while (total < size_t(1024u * 1024u)) { // bound #2
  5999. const auto remaining =
  6000. std::chrono::duration_cast<std::chrono::microseconds>(
  6001. deadline - std::chrono::steady_clock::now())
  6002. .count();
  6003. if (remaining <= 0) { break; }
  6004. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  6005. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  6006. if (n <= 0) { break; }
  6007. total += static_cast<size_t>(n);
  6008. }
  6009. shutdown_socket(sock);
  6010. close_socket(sock);
  6011. }
  6012. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  6013. if (s.size() > 1 && s[0] == '\0') {
  6014. auto ret = s;
  6015. ret[0] = '@';
  6016. return ret;
  6017. }
  6018. return s;
  6019. }
  6020. inline std::string
  6021. unescape_abstract_namespace_unix_domain(const std::string &s) {
  6022. if (s.size() > 1 && s[0] == '@') {
  6023. auto ret = s;
  6024. ret[0] = '\0';
  6025. return ret;
  6026. }
  6027. return s;
  6028. }
  6029. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  6030. const struct addrinfo *hints,
  6031. struct addrinfo **res, time_t timeout_sec) {
  6032. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  6033. if (timeout_sec <= 0) {
  6034. // No timeout specified, use standard getaddrinfo
  6035. return getaddrinfo(node, service, hints, res);
  6036. }
  6037. #ifdef _WIN32
  6038. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  6039. OVERLAPPED overlapped = {};
  6040. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  6041. if (!event) { return EAI_FAIL; }
  6042. overlapped.hEvent = event;
  6043. PADDRINFOEXW result_addrinfo = nullptr;
  6044. HANDLE cancel_handle = nullptr;
  6045. ADDRINFOEXW hints_ex = {};
  6046. if (hints) {
  6047. hints_ex.ai_flags = hints->ai_flags;
  6048. hints_ex.ai_family = hints->ai_family;
  6049. hints_ex.ai_socktype = hints->ai_socktype;
  6050. hints_ex.ai_protocol = hints->ai_protocol;
  6051. }
  6052. auto wnode = u8string_to_wstring(node);
  6053. auto wservice = u8string_to_wstring(service);
  6054. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  6055. hints ? &hints_ex : nullptr, &result_addrinfo,
  6056. nullptr, &overlapped, nullptr, &cancel_handle);
  6057. if (ret == WSA_IO_PENDING) {
  6058. auto wait_result =
  6059. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  6060. if (wait_result == WAIT_TIMEOUT) {
  6061. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  6062. ::CloseHandle(event);
  6063. return EAI_AGAIN;
  6064. }
  6065. DWORD bytes_returned;
  6066. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  6067. &bytes_returned, FALSE)) {
  6068. ::CloseHandle(event);
  6069. return ::WSAGetLastError();
  6070. }
  6071. }
  6072. ::CloseHandle(event);
  6073. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  6074. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  6075. return 0;
  6076. }
  6077. return ret;
  6078. #elif TARGET_OS_MAC && defined(__clang__)
  6079. if (!node) { return EAI_NONAME; }
  6080. // macOS implementation using CFHost API for asynchronous DNS resolution
  6081. CFStringRef hostname_ref = CFStringCreateWithCString(
  6082. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  6083. if (!hostname_ref) { return EAI_MEMORY; }
  6084. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  6085. CFRelease(hostname_ref);
  6086. if (!host_ref) { return EAI_MEMORY; }
  6087. // Set up context for callback
  6088. struct CFHostContext {
  6089. bool completed = false;
  6090. bool success = false;
  6091. CFArrayRef addresses = nullptr;
  6092. std::mutex mutex;
  6093. std::condition_variable cv;
  6094. } context;
  6095. CFHostClientContext client_context;
  6096. memset(&client_context, 0, sizeof(client_context));
  6097. client_context.info = &context;
  6098. // Set callback
  6099. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  6100. const CFStreamError *error, void *info) {
  6101. auto ctx = static_cast<CFHostContext *>(info);
  6102. std::lock_guard<std::mutex> lock(ctx->mutex);
  6103. if (error && error->error != 0) {
  6104. ctx->success = false;
  6105. } else {
  6106. Boolean hasBeenResolved;
  6107. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  6108. if (ctx->addresses && hasBeenResolved) {
  6109. CFRetain(ctx->addresses);
  6110. ctx->success = true;
  6111. } else {
  6112. ctx->success = false;
  6113. }
  6114. }
  6115. ctx->completed = true;
  6116. ctx->cv.notify_one();
  6117. };
  6118. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  6119. CFRelease(host_ref);
  6120. return EAI_SYSTEM;
  6121. }
  6122. // Schedule on run loop
  6123. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  6124. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6125. // Start resolution
  6126. CFStreamError stream_error;
  6127. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  6128. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6129. CFRelease(host_ref);
  6130. return EAI_FAIL;
  6131. }
  6132. // Wait for completion with timeout
  6133. auto timeout_time =
  6134. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  6135. bool timed_out = false;
  6136. {
  6137. std::unique_lock<std::mutex> lock(context.mutex);
  6138. while (!context.completed) {
  6139. auto now = std::chrono::steady_clock::now();
  6140. if (now >= timeout_time) {
  6141. timed_out = true;
  6142. break;
  6143. }
  6144. // Run the runloop for a short time
  6145. lock.unlock();
  6146. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  6147. lock.lock();
  6148. }
  6149. }
  6150. // Clean up
  6151. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6152. CFHostSetClient(host_ref, nullptr, nullptr);
  6153. if (timed_out || !context.completed) {
  6154. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  6155. CFRelease(host_ref);
  6156. return EAI_AGAIN;
  6157. }
  6158. if (!context.success || !context.addresses) {
  6159. CFRelease(host_ref);
  6160. return EAI_NODATA;
  6161. }
  6162. // Convert CFArray to addrinfo
  6163. CFIndex count = CFArrayGetCount(context.addresses);
  6164. if (count == 0) {
  6165. CFRelease(context.addresses);
  6166. CFRelease(host_ref);
  6167. return EAI_NODATA;
  6168. }
  6169. struct addrinfo *result_addrinfo = nullptr;
  6170. struct addrinfo **current = &result_addrinfo;
  6171. for (CFIndex i = 0; i < count; i++) {
  6172. CFDataRef addr_data =
  6173. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  6174. if (!addr_data) continue;
  6175. const struct sockaddr *sockaddr_ptr =
  6176. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  6177. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  6178. // Allocate addrinfo structure
  6179. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  6180. if (!*current) {
  6181. freeaddrinfo(result_addrinfo);
  6182. CFRelease(context.addresses);
  6183. CFRelease(host_ref);
  6184. return EAI_MEMORY;
  6185. }
  6186. memset(*current, 0, sizeof(struct addrinfo));
  6187. // Set up addrinfo fields
  6188. (*current)->ai_family = sockaddr_ptr->sa_family;
  6189. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  6190. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  6191. (*current)->ai_addrlen = sockaddr_len;
  6192. // Copy sockaddr
  6193. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  6194. if (!(*current)->ai_addr) {
  6195. freeaddrinfo(result_addrinfo);
  6196. CFRelease(context.addresses);
  6197. CFRelease(host_ref);
  6198. return EAI_MEMORY;
  6199. }
  6200. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  6201. // Set port if service is specified
  6202. if (service && *service) {
  6203. int port = 0;
  6204. if (parse_port(service, strlen(service), port)) {
  6205. if (sockaddr_ptr->sa_family == AF_INET) {
  6206. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  6207. ->sin_port = htons(static_cast<uint16_t>(port));
  6208. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  6209. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  6210. ->sin6_port = htons(static_cast<uint16_t>(port));
  6211. }
  6212. }
  6213. }
  6214. current = &((*current)->ai_next);
  6215. }
  6216. CFRelease(context.addresses);
  6217. CFRelease(host_ref);
  6218. *res = result_addrinfo;
  6219. return 0;
  6220. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  6221. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  6222. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  6223. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  6224. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  6225. // the resolver worker still references the stack-local gaicb. The cancel
  6226. // path therefore waits (gai_suspend with no timeout) for the worker to
  6227. // actually finish before letting the stack frame go. The trade-off is that
  6228. // a wedged DNS server can hold this thread for the system resolver timeout
  6229. // (~30s by default) past the caller's connection timeout.
  6230. struct gaicb request{};
  6231. struct gaicb *requests[1] = {&request};
  6232. struct sigevent sevp{};
  6233. struct timespec timeout{timeout_sec, 0};
  6234. request.ar_name = node;
  6235. request.ar_service = service;
  6236. request.ar_request = hints;
  6237. sevp.sigev_notify = SIGEV_NONE;
  6238. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  6239. if (rc != 0) { return rc; }
  6240. auto cleanup = scope_exit([&] {
  6241. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  6242. });
  6243. int wait_result = gai_suspend(requests, 1, &timeout);
  6244. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  6245. int gai_result = gai_error(&request);
  6246. if (gai_result == 0) {
  6247. *res = request.ar_result;
  6248. request.ar_result = nullptr;
  6249. return 0;
  6250. }
  6251. return gai_result;
  6252. }
  6253. gai_cancel(&request);
  6254. while (gai_error(&request) == EAI_INPROGRESS) {
  6255. gai_suspend(requests, 1, nullptr);
  6256. }
  6257. return wait_result;
  6258. #else
  6259. // Fallback implementation using thread-based timeout for other Unix systems.
  6260. struct GetAddrInfoState {
  6261. ~GetAddrInfoState() {
  6262. if (info) { freeaddrinfo(info); }
  6263. }
  6264. std::mutex mutex;
  6265. std::condition_variable result_cv;
  6266. bool completed = false;
  6267. int result = EAI_SYSTEM;
  6268. std::string node;
  6269. std::string service;
  6270. struct addrinfo hints;
  6271. struct addrinfo *info = nullptr;
  6272. };
  6273. // Allocate on the heap, so the resolver thread can keep using the data.
  6274. auto state = std::make_shared<GetAddrInfoState>();
  6275. if (node) { state->node = node; }
  6276. state->service = service;
  6277. state->hints = *hints;
  6278. std::thread resolve_thread([state]() {
  6279. auto thread_result =
  6280. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6281. &state->info);
  6282. std::lock_guard<std::mutex> lock(state->mutex);
  6283. state->result = thread_result;
  6284. state->completed = true;
  6285. state->result_cv.notify_one();
  6286. });
  6287. // Wait for completion or timeout
  6288. std::unique_lock<std::mutex> lock(state->mutex);
  6289. auto finished =
  6290. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6291. [&] { return state->completed; });
  6292. if (finished) {
  6293. // Operation completed within timeout
  6294. resolve_thread.join();
  6295. *res = state->info;
  6296. state->info = nullptr; // Pass ownership to caller
  6297. return state->result;
  6298. } else {
  6299. // Timeout occurred
  6300. resolve_thread.detach(); // Let the thread finish in background
  6301. return EAI_AGAIN; // Return timeout error
  6302. }
  6303. #endif
  6304. #else
  6305. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6306. return getaddrinfo(node, service, hints, res);
  6307. #endif
  6308. }
  6309. template <typename BindOrConnect>
  6310. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6311. int address_family, int socket_flags, bool tcp_nodelay,
  6312. bool ipv6_v6only, SocketOptions socket_options,
  6313. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6314. // Get address info
  6315. const char *node = nullptr;
  6316. struct addrinfo hints;
  6317. struct addrinfo *result;
  6318. memset(&hints, 0, sizeof(struct addrinfo));
  6319. hints.ai_socktype = SOCK_STREAM;
  6320. hints.ai_protocol = IPPROTO_IP;
  6321. if (!ip.empty()) {
  6322. node = ip.c_str();
  6323. // Ask getaddrinfo to convert IP in c-string to address
  6324. hints.ai_family = AF_UNSPEC;
  6325. hints.ai_flags = AI_NUMERICHOST;
  6326. } else {
  6327. if (!host.empty()) { node = host.c_str(); }
  6328. hints.ai_family = address_family;
  6329. hints.ai_flags = socket_flags;
  6330. }
  6331. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6332. if (hints.ai_family == AF_UNIX) {
  6333. const auto addrlen = host.length();
  6334. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6335. #ifdef SOCK_CLOEXEC
  6336. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6337. hints.ai_protocol);
  6338. #else
  6339. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6340. #endif
  6341. if (sock != INVALID_SOCKET) {
  6342. sockaddr_un addr{};
  6343. addr.sun_family = AF_UNIX;
  6344. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6345. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6346. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6347. hints.ai_addrlen = static_cast<socklen_t>(
  6348. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6349. #ifndef SOCK_CLOEXEC
  6350. #ifndef _WIN32
  6351. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6352. #endif
  6353. #endif
  6354. if (socket_options) { socket_options(sock); }
  6355. #ifdef _WIN32
  6356. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6357. // remove the option.
  6358. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6359. #endif
  6360. bool dummy;
  6361. if (!bind_or_connect(sock, hints, dummy)) {
  6362. close_socket(sock);
  6363. sock = INVALID_SOCKET;
  6364. }
  6365. }
  6366. return sock;
  6367. }
  6368. #endif
  6369. auto service = std::to_string(port);
  6370. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6371. timeout_sec)) {
  6372. #if defined __linux__ && !defined __ANDROID__
  6373. res_init();
  6374. #endif
  6375. return INVALID_SOCKET;
  6376. }
  6377. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6378. for (auto rp = result; rp; rp = rp->ai_next) {
  6379. // Create a socket
  6380. #ifdef _WIN32
  6381. auto sock =
  6382. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6383. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6384. /**
  6385. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6386. * and above the socket creation fails on older Windows Systems.
  6387. *
  6388. * Let's try to create a socket the old way in this case.
  6389. *
  6390. * Reference:
  6391. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6392. *
  6393. * WSA_FLAG_NO_HANDLE_INHERIT:
  6394. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6395. * SP1, and later
  6396. *
  6397. */
  6398. if (sock == INVALID_SOCKET) {
  6399. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6400. }
  6401. #else
  6402. #ifdef SOCK_CLOEXEC
  6403. auto sock =
  6404. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6405. #else
  6406. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6407. #endif
  6408. #endif
  6409. if (sock == INVALID_SOCKET) { continue; }
  6410. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6411. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6412. close_socket(sock);
  6413. continue;
  6414. }
  6415. #endif
  6416. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6417. if (rp->ai_family == AF_INET6) {
  6418. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6419. }
  6420. if (socket_options) { socket_options(sock); }
  6421. // bind or connect
  6422. auto quit = false;
  6423. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6424. close_socket(sock);
  6425. if (quit) { break; }
  6426. }
  6427. return INVALID_SOCKET;
  6428. }
  6429. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6430. #ifdef _WIN32
  6431. auto flags = nonblocking ? 1UL : 0UL;
  6432. ioctlsocket(sock, FIONBIO, &flags);
  6433. #else
  6434. auto flags = fcntl(sock, F_GETFL, 0);
  6435. fcntl(sock, F_SETFL,
  6436. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6437. #endif
  6438. }
  6439. inline bool is_connection_error() {
  6440. #ifdef _WIN32
  6441. return WSAGetLastError() != WSAEWOULDBLOCK;
  6442. #else
  6443. return errno != EINPROGRESS;
  6444. #endif
  6445. }
  6446. // accept() failed because the process or the network stack is temporarily out
  6447. // of resources. The listening socket is still usable, so back off briefly and
  6448. // try again.
  6449. inline bool is_accept_resource_error() {
  6450. #ifdef _WIN32
  6451. auto err = WSAGetLastError();
  6452. return err == WSAEMFILE || err == WSAENOBUFS;
  6453. #else
  6454. auto err = errno;
  6455. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6456. #endif
  6457. }
  6458. // accept() failed for a reason that says nothing about the listening socket:
  6459. // the pending connection went away before it could be accepted, or the call
  6460. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6461. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6462. // connection that way.
  6463. inline bool is_accept_transient_error() {
  6464. #ifdef _WIN32
  6465. auto err = WSAGetLastError();
  6466. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6467. err == WSAECONNABORTED;
  6468. #else
  6469. auto err = errno;
  6470. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6471. err == ECONNABORTED;
  6472. #endif
  6473. }
  6474. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6475. struct addrinfo hints;
  6476. struct addrinfo *result;
  6477. memset(&hints, 0, sizeof(struct addrinfo));
  6478. hints.ai_family = AF_UNSPEC;
  6479. hints.ai_socktype = SOCK_STREAM;
  6480. hints.ai_protocol = 0;
  6481. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6482. return false;
  6483. }
  6484. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6485. auto ret = false;
  6486. for (auto rp = result; rp; rp = rp->ai_next) {
  6487. const auto &ai = *rp;
  6488. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6489. ret = true;
  6490. break;
  6491. }
  6492. }
  6493. return ret;
  6494. }
  6495. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6496. #define USE_IF2IP
  6497. #endif
  6498. #ifdef USE_IF2IP
  6499. inline std::string if2ip(int address_family, const std::string &ifn) {
  6500. struct ifaddrs *ifap;
  6501. getifaddrs(&ifap);
  6502. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6503. std::string addr_candidate;
  6504. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6505. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6506. (AF_UNSPEC == address_family ||
  6507. ifa->ifa_addr->sa_family == address_family)) {
  6508. if (ifa->ifa_addr->sa_family == AF_INET) {
  6509. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6510. char buf[INET_ADDRSTRLEN];
  6511. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6512. return std::string(buf, INET_ADDRSTRLEN);
  6513. }
  6514. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6515. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6516. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6517. char buf[INET6_ADDRSTRLEN] = {};
  6518. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6519. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6520. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6521. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6522. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6523. } else {
  6524. return std::string(buf, INET6_ADDRSTRLEN);
  6525. }
  6526. }
  6527. }
  6528. }
  6529. }
  6530. }
  6531. return addr_candidate;
  6532. }
  6533. #endif
  6534. inline socket_t
  6535. create_client_socket(const std::string &host, const std::string &ip, int port,
  6536. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6537. SocketOptions socket_options,
  6538. time_t connection_timeout_sec,
  6539. time_t connection_timeout_usec, time_t read_timeout_sec,
  6540. time_t read_timeout_usec, time_t write_timeout_sec,
  6541. time_t write_timeout_usec, const std::string &intf,
  6542. Error &error, const std::function<bool()> &interrupted) {
  6543. auto sock = create_socket(
  6544. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6545. std::move(socket_options),
  6546. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6547. if (!intf.empty()) {
  6548. #ifdef USE_IF2IP
  6549. auto ip_from_if = if2ip(address_family, intf);
  6550. if (ip_from_if.empty()) { ip_from_if = intf; }
  6551. if (!bind_ip_address(sock2, ip_from_if)) {
  6552. error = Error::BindIPAddress;
  6553. return false;
  6554. }
  6555. #endif
  6556. }
  6557. set_nonblocking(sock2, true);
  6558. auto ret =
  6559. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6560. if (ret < 0) {
  6561. if (is_connection_error()) {
  6562. error = Error::Connection;
  6563. return false;
  6564. }
  6565. error =
  6566. wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6567. connection_timeout_usec, interrupted);
  6568. if (error != Error::Success) {
  6569. if (error == Error::ConnectionTimeout || error == Error::Canceled) {
  6570. quit = true;
  6571. }
  6572. return false;
  6573. }
  6574. }
  6575. set_nonblocking(sock2, false);
  6576. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6577. read_timeout_usec);
  6578. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6579. write_timeout_usec);
  6580. error = Error::Success;
  6581. return true;
  6582. },
  6583. connection_timeout_sec); // Pass DNS timeout
  6584. if (sock != INVALID_SOCKET) {
  6585. error = Error::Success;
  6586. } else {
  6587. if (error == Error::Success) { error = Error::Connection; }
  6588. }
  6589. return sock;
  6590. }
  6591. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6592. socklen_t addr_len, std::string &ip, int &port) {
  6593. if (addr.ss_family == AF_INET) {
  6594. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6595. } else if (addr.ss_family == AF_INET6) {
  6596. port =
  6597. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6598. } else {
  6599. return false;
  6600. }
  6601. std::array<char, NI_MAXHOST> ipstr{};
  6602. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6603. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6604. 0, NI_NUMERICHOST)) {
  6605. return false;
  6606. }
  6607. ip = ipstr.data();
  6608. return true;
  6609. }
  6610. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6611. struct sockaddr_storage addr;
  6612. socklen_t addr_len = sizeof(addr);
  6613. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6614. &addr_len)) {
  6615. get_ip_and_port(addr, addr_len, ip, port);
  6616. }
  6617. }
  6618. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6619. struct sockaddr_storage addr;
  6620. socklen_t addr_len = sizeof(addr);
  6621. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6622. &addr_len)) {
  6623. #ifndef _WIN32
  6624. if (addr.ss_family == AF_UNIX) {
  6625. #if defined(__linux__)
  6626. struct ucred ucred;
  6627. socklen_t len = sizeof(ucred);
  6628. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6629. port = ucred.pid;
  6630. }
  6631. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6632. pid_t pid;
  6633. socklen_t len = sizeof(pid);
  6634. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6635. port = pid;
  6636. }
  6637. #endif
  6638. return;
  6639. }
  6640. #endif
  6641. get_ip_and_port(addr, addr_len, ip, port);
  6642. }
  6643. }
  6644. inline std::string
  6645. find_content_type(const std::string &path,
  6646. const std::map<std::string, std::string> &user_data,
  6647. const std::string &default_content_type) {
  6648. // Extensions are matched regardless of case, as web servers do
  6649. auto ext = case_ignore::to_lower(file_extension(path));
  6650. auto it = user_data.find(ext);
  6651. if (it != user_data.end()) { return it->second; }
  6652. static const struct {
  6653. const char *ext;
  6654. const char *type;
  6655. } types[] = {
  6656. {"css", "text/css"},
  6657. {"csv", "text/csv"},
  6658. {"htm", "text/html"},
  6659. {"html", "text/html"},
  6660. {"js", "text/javascript"},
  6661. {"mjs", "text/javascript"},
  6662. {"txt", "text/plain"},
  6663. {"vtt", "text/vtt"},
  6664. {"apng", "image/apng"},
  6665. {"avif", "image/avif"},
  6666. {"bmp", "image/bmp"},
  6667. {"gif", "image/gif"},
  6668. {"png", "image/png"},
  6669. {"svg", "image/svg+xml"},
  6670. {"webp", "image/webp"},
  6671. {"ico", "image/x-icon"},
  6672. {"tif", "image/tiff"},
  6673. {"tiff", "image/tiff"},
  6674. {"jpg", "image/jpeg"},
  6675. {"jpeg", "image/jpeg"},
  6676. {"mp4", "video/mp4"},
  6677. {"mpeg", "video/mpeg"},
  6678. {"webm", "video/webm"},
  6679. {"mp3", "audio/mp3"},
  6680. {"mpga", "audio/mpeg"},
  6681. {"weba", "audio/webm"},
  6682. {"wav", "audio/wave"},
  6683. {"otf", "font/otf"},
  6684. {"ttf", "font/ttf"},
  6685. {"woff", "font/woff"},
  6686. {"woff2", "font/woff2"},
  6687. {"7z", "application/x-7z-compressed"},
  6688. {"atom", "application/atom+xml"},
  6689. {"pdf", "application/pdf"},
  6690. {"json", "application/json"},
  6691. {"rss", "application/rss+xml"},
  6692. {"tar", "application/x-tar"},
  6693. {"xht", "application/xhtml+xml"},
  6694. {"xhtml", "application/xhtml+xml"},
  6695. {"xslt", "application/xslt+xml"},
  6696. {"xml", "application/xml"},
  6697. {"gz", "application/gzip"},
  6698. {"zip", "application/zip"},
  6699. {"wasm", "application/wasm"},
  6700. };
  6701. for (const auto &t : types) {
  6702. if (ext == t.ext) { return t.type; }
  6703. }
  6704. return default_content_type;
  6705. }
  6706. inline std::string
  6707. extract_media_type(const std::string &content_type,
  6708. std::map<std::string, std::string> *params = nullptr) {
  6709. // Extract type/subtype from Content-Type value (RFC 2045)
  6710. // e.g. "application/json; charset=utf-8" -> "application/json"
  6711. auto media_type = content_type;
  6712. auto semicolon_pos = media_type.find(';');
  6713. if (semicolon_pos != std::string::npos) {
  6714. auto param_str = media_type.substr(semicolon_pos + 1);
  6715. media_type = media_type.substr(0, semicolon_pos);
  6716. if (params) {
  6717. // Parse parameters: key=value pairs separated by ';'
  6718. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6719. [&](const char *b, const char *e) {
  6720. std::string key;
  6721. std::string val;
  6722. divide_param_pair(b, e, key, val);
  6723. // Parameter names are case-insensitive (RFC 9110
  6724. // §5.6.6)
  6725. if (!key.empty()) {
  6726. params->emplace(case_ignore::to_lower(trim_copy(key)),
  6727. unquote_param(val));
  6728. }
  6729. });
  6730. }
  6731. }
  6732. // Trim whitespace from media type
  6733. return trim_copy(media_type);
  6734. }
  6735. inline bool can_compress_content_type(const std::string &content_type) {
  6736. // Media types are case-insensitive (RFC 9110 §8.3.1)
  6737. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  6738. static const char *const compressible[] = {
  6739. "image/svg+xml",
  6740. "application/javascript",
  6741. "application/x-javascript",
  6742. "application/json",
  6743. "application/ld+json",
  6744. "application/xml",
  6745. "application/xhtml+xml",
  6746. "application/rss+xml",
  6747. "application/atom+xml",
  6748. "application/xslt+xml",
  6749. "application/protobuf",
  6750. };
  6751. for (auto type : compressible) {
  6752. if (mime_type == type) { return true; }
  6753. }
  6754. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6755. }
  6756. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6757. double &quality) {
  6758. quality = 1.0;
  6759. token.clear();
  6760. // Split on first ';': left = token name, right = parameters
  6761. const char *params_b = nullptr;
  6762. std::size_t params_len = 0;
  6763. divide(
  6764. b, static_cast<std::size_t>(e - b), ';',
  6765. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6766. auto r = trim(lb, lb + llen, 0, llen);
  6767. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6768. params_b = rb;
  6769. params_len = rlen;
  6770. });
  6771. if (token.empty()) { return false; }
  6772. if (params_len == 0) { return true; }
  6773. // Scan parameters for q= (stops on first match)
  6774. bool invalid = false;
  6775. split_find(params_b, params_b + params_len, ';',
  6776. (std::numeric_limits<size_t>::max)(),
  6777. [&](const char *pb, const char *pe) -> bool {
  6778. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6779. auto len = static_cast<size_t>(pe - pb);
  6780. if (len < 2) { return false; }
  6781. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6782. return false;
  6783. }
  6784. // Trim the value portion
  6785. auto r = trim(pb, pe, 2, len);
  6786. if (r.first >= r.second) {
  6787. invalid = true;
  6788. return true;
  6789. }
  6790. double v = 0.0;
  6791. auto res = from_chars(pb + r.first, pb + r.second, v);
  6792. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6793. v < 0.0 || v > 1.0) {
  6794. invalid = true;
  6795. return true;
  6796. }
  6797. quality = v;
  6798. return true;
  6799. });
  6800. return !invalid;
  6801. }
  6802. inline EncodingType encoding_type(const Request &req,
  6803. const std::string &content_type) {
  6804. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6805. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6806. if (s.empty()) { return EncodingType::None; }
  6807. // Single-pass: iterate tokens and track the best supported encoding.
  6808. // Server preference breaks ties (br > gzip > zstd).
  6809. EncodingType best = EncodingType::None;
  6810. double best_q = 0.0; // q=0 means "not acceptable"
  6811. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6812. auto priority = [](EncodingType t) -> int {
  6813. switch (t) {
  6814. case EncodingType::Brotli: return 0;
  6815. case EncodingType::Gzip: return 1;
  6816. case EncodingType::Zstd: return 2;
  6817. default: return 3;
  6818. }
  6819. };
  6820. std::string name;
  6821. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6822. double quality = 1.0;
  6823. if (!parse_quality(b, e, name, quality)) { return; }
  6824. if (quality <= 0.0) { return; }
  6825. EncodingType type = EncodingType::None;
  6826. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6827. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6828. #endif
  6829. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6830. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6831. type = EncodingType::Gzip;
  6832. }
  6833. #endif
  6834. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6835. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6836. type = EncodingType::Zstd;
  6837. }
  6838. #endif
  6839. if (type == EncodingType::None) { return; }
  6840. // Higher q-value wins; for equal q, server preference breaks ties
  6841. if (quality > best_q ||
  6842. (quality == best_q && priority(type) < priority(best))) {
  6843. best_q = quality;
  6844. best = type;
  6845. }
  6846. });
  6847. return best;
  6848. }
  6849. // `content_type` is taken separately because a file-backed response has not
  6850. // been given one yet when its coding has to be decided.
  6851. inline EncodingType encoding_type(const Request &req, const Response &res,
  6852. const std::string &content_type) {
  6853. // The response already names a content coding of its own: a handler serving
  6854. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6855. // point whose headers name the coding its files are stored in. Applying one
  6856. // on top of that would double-encode the body and append a second
  6857. // `Content-Encoding` field line.
  6858. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6859. return encoding_type(req, content_type);
  6860. }
  6861. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6862. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6863. }
  6864. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6865. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6866. if (type == EncodingType::Gzip) {
  6867. return detail::make_unique<gzip_compressor>();
  6868. }
  6869. #endif
  6870. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6871. if (type == EncodingType::Brotli) {
  6872. return detail::make_unique<brotli_compressor>();
  6873. }
  6874. #endif
  6875. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6876. if (type == EncodingType::Zstd) {
  6877. return detail::make_unique<zstd_compressor>();
  6878. }
  6879. #endif
  6880. (void)type;
  6881. return nullptr;
  6882. }
  6883. inline const char *encoding_name(EncodingType type) {
  6884. switch (type) {
  6885. case EncodingType::Gzip: return "gzip";
  6886. case EncodingType::Brotli: return "br";
  6887. case EncodingType::Zstd: return "zstd";
  6888. default: return "";
  6889. }
  6890. }
  6891. inline bool nocompressor::compress(const char *data, size_t data_length,
  6892. bool /*last*/, Callback callback) {
  6893. if (!data_length) { return true; }
  6894. return callback(data, data_length);
  6895. }
  6896. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6897. inline gzip_compressor::gzip_compressor() {
  6898. std::memset(&strm_, 0, sizeof(strm_));
  6899. strm_.zalloc = Z_NULL;
  6900. strm_.zfree = Z_NULL;
  6901. strm_.opaque = Z_NULL;
  6902. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6903. Z_DEFAULT_STRATEGY) == Z_OK;
  6904. }
  6905. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6906. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6907. bool last, Callback callback) {
  6908. assert(is_valid_);
  6909. do {
  6910. constexpr size_t max_avail_in =
  6911. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6912. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6913. (std::min)(data_length, max_avail_in));
  6914. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6915. data_length -= strm_.avail_in;
  6916. data += strm_.avail_in;
  6917. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6918. auto ret = Z_OK;
  6919. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6920. do {
  6921. strm_.avail_out = static_cast<uInt>(buff.size());
  6922. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6923. ret = deflate(&strm_, flush);
  6924. if (ret == Z_STREAM_ERROR) { return false; }
  6925. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6926. return false;
  6927. }
  6928. } while (strm_.avail_out == 0);
  6929. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6930. (flush == Z_NO_FLUSH && ret == Z_OK));
  6931. assert(strm_.avail_in == 0);
  6932. } while (data_length > 0);
  6933. return true;
  6934. }
  6935. inline gzip_decompressor::gzip_decompressor() {
  6936. std::memset(&strm_, 0, sizeof(strm_));
  6937. strm_.zalloc = Z_NULL;
  6938. strm_.zfree = Z_NULL;
  6939. strm_.opaque = Z_NULL;
  6940. // 15 is the value of wbits, which should be at the maximum possible value
  6941. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6942. // that the stream type should be automatically detected either gzip or
  6943. // deflate.
  6944. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6945. }
  6946. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6947. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6948. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6949. Callback callback) {
  6950. assert(is_valid_);
  6951. auto ret = Z_OK;
  6952. do {
  6953. constexpr size_t max_avail_in =
  6954. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6955. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6956. (std::min)(data_length, max_avail_in));
  6957. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6958. data_length -= strm_.avail_in;
  6959. data += strm_.avail_in;
  6960. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6961. while (strm_.avail_in > 0 && ret == Z_OK) {
  6962. strm_.avail_out = static_cast<uInt>(buff.size());
  6963. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6964. ret = inflate(&strm_, Z_NO_FLUSH);
  6965. assert(ret != Z_STREAM_ERROR);
  6966. switch (ret) {
  6967. case Z_NEED_DICT:
  6968. case Z_DATA_ERROR:
  6969. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6970. }
  6971. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6972. return false;
  6973. }
  6974. }
  6975. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6976. } while (data_length > 0);
  6977. return true;
  6978. }
  6979. #endif
  6980. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6981. inline brotli_compressor::brotli_compressor() {
  6982. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6983. }
  6984. inline brotli_compressor::~brotli_compressor() {
  6985. BrotliEncoderDestroyInstance(state_);
  6986. }
  6987. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6988. bool last, Callback callback) {
  6989. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6990. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6991. auto available_in = data_length;
  6992. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6993. for (;;) {
  6994. if (last) {
  6995. if (BrotliEncoderIsFinished(state_)) { break; }
  6996. } else {
  6997. if (!available_in) { break; }
  6998. }
  6999. auto available_out = buff.size();
  7000. auto next_out = buff.data();
  7001. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  7002. &available_out, &next_out, nullptr)) {
  7003. return false;
  7004. }
  7005. auto output_bytes = buff.size() - available_out;
  7006. if (output_bytes) {
  7007. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  7008. }
  7009. }
  7010. return true;
  7011. }
  7012. inline brotli_decompressor::brotli_decompressor() {
  7013. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  7014. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  7015. : BROTLI_DECODER_RESULT_ERROR;
  7016. }
  7017. inline brotli_decompressor::~brotli_decompressor() {
  7018. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  7019. }
  7020. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  7021. inline bool brotli_decompressor::decompress(const char *data,
  7022. size_t data_length,
  7023. Callback callback) {
  7024. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  7025. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  7026. return 0;
  7027. }
  7028. auto next_in = reinterpret_cast<const uint8_t *>(data);
  7029. size_t avail_in = data_length;
  7030. size_t total_out;
  7031. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  7032. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7033. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  7034. char *next_out = buff.data();
  7035. size_t avail_out = buff.size();
  7036. decoder_r = BrotliDecoderDecompressStream(
  7037. decoder_s, &avail_in, &next_in, &avail_out,
  7038. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  7039. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  7040. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  7041. }
  7042. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  7043. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  7044. }
  7045. #endif
  7046. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7047. inline zstd_compressor::zstd_compressor() {
  7048. ctx_ = ZSTD_createCCtx();
  7049. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  7050. }
  7051. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  7052. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  7053. bool last, Callback callback) {
  7054. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7055. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  7056. ZSTD_inBuffer input = {data, data_length, 0};
  7057. bool finished;
  7058. do {
  7059. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  7060. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  7061. if (ZSTD_isError(remaining)) { return false; }
  7062. if (!callback(buff.data(), output.pos)) { return false; }
  7063. finished = last ? (remaining == 0) : (input.pos == input.size);
  7064. } while (!finished);
  7065. return true;
  7066. }
  7067. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  7068. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  7069. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  7070. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  7071. Callback callback) {
  7072. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7073. ZSTD_inBuffer input = {data, data_length, 0};
  7074. while (input.pos < input.size) {
  7075. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  7076. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  7077. if (ZSTD_isError(remaining)) { return false; }
  7078. if (!callback(buff.data(), output.pos)) { return false; }
  7079. }
  7080. return true;
  7081. }
  7082. #endif
  7083. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  7084. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  7085. // unknown coding, and its payload would be handed back still compressed.
  7086. inline bool is_zlib_encoding(const std::string &encoding) {
  7087. return case_ignore::equal(encoding, "gzip") ||
  7088. case_ignore::equal(encoding, "deflate");
  7089. }
  7090. inline bool is_brotli_encoding(const std::string &encoding) {
  7091. return case_ignore::equal(encoding, "br");
  7092. }
  7093. inline bool is_zstd_encoding(const std::string &encoding) {
  7094. return case_ignore::equal(encoding, "zstd");
  7095. }
  7096. // Returns true if the content coding is one cpp-httplib is able to decompress
  7097. // when the corresponding support is compiled in.
  7098. inline bool is_known_content_encoding(const std::string &encoding) {
  7099. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  7100. is_zstd_encoding(encoding);
  7101. }
  7102. inline std::unique_ptr<decompressor>
  7103. create_decompressor(const std::string &encoding) {
  7104. std::unique_ptr<decompressor> decompressor;
  7105. if (is_zlib_encoding(encoding)) {
  7106. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7107. decompressor = detail::make_unique<gzip_decompressor>();
  7108. #endif
  7109. } else if (is_brotli_encoding(encoding)) {
  7110. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7111. decompressor = detail::make_unique<brotli_decompressor>();
  7112. #endif
  7113. } else if (is_zstd_encoding(encoding)) {
  7114. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7115. decompressor = detail::make_unique<zstd_decompressor>();
  7116. #endif
  7117. }
  7118. return decompressor;
  7119. }
  7120. // Returns the best available compressor and its Content-Encoding name.
  7121. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  7122. inline std::pair<std::unique_ptr<compressor>, const char *>
  7123. create_compressor() {
  7124. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7125. return {detail::make_unique<brotli_compressor>(), "br"};
  7126. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  7127. return {detail::make_unique<gzip_compressor>(), "gzip"};
  7128. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  7129. return {detail::make_unique<zstd_compressor>(), "zstd"};
  7130. #else
  7131. return {nullptr, nullptr};
  7132. #endif
  7133. }
  7134. inline bool is_prohibited_header_name(const std::string &name) {
  7135. // Field names are case-insensitive (RFC 9110 §5.1)
  7136. return case_ignore::equal(name, "REMOTE_ADDR") ||
  7137. case_ignore::equal(name, "REMOTE_PORT") ||
  7138. case_ignore::equal(name, "LOCAL_ADDR") ||
  7139. case_ignore::equal(name, "LOCAL_PORT");
  7140. }
  7141. inline bool has_header(const Headers &headers, const std::string &key) {
  7142. if (is_prohibited_header_name(key)) { return false; }
  7143. return headers.find(key) != headers.end();
  7144. }
  7145. inline const char *get_header_value(const Headers &headers,
  7146. const std::string &key, const char *def,
  7147. size_t id) {
  7148. if (is_prohibited_header_name(key)) {
  7149. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  7150. std::string msg = "Prohibited header name '" + key + "' is specified.";
  7151. throw std::invalid_argument(msg);
  7152. #else
  7153. return "";
  7154. #endif
  7155. }
  7156. auto rng = headers.equal_range(key);
  7157. auto it = bounded_next(rng.first, id, rng.second);
  7158. if (it != rng.second) { return it->second.c_str(); }
  7159. return def;
  7160. }
  7161. inline size_t get_header_value_count(const Headers &headers,
  7162. const std::string &key) {
  7163. return headers.count(key);
  7164. }
  7165. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  7166. // list may be sent as several field lines, and the combined field value is
  7167. // those values joined by commas in the order they were received. Callers that
  7168. // parse such a list must work on the combined value; reading only the first
  7169. // occurrence silently drops whatever the later field lines carry.
  7170. inline std::string get_combined_header_value(const Headers &headers,
  7171. const std::string &key) {
  7172. std::string combined;
  7173. auto rng = headers.equal_range(key);
  7174. for (auto it = rng.first; it != rng.second; ++it) {
  7175. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  7176. // elements, so an empty field line must not contribute a bare comma to the
  7177. // combined value.
  7178. if (it->second.empty()) { continue; }
  7179. if (!combined.empty()) { combined += ", "; }
  7180. combined += it->second;
  7181. }
  7182. return combined;
  7183. }
  7184. inline bool has_header_token(const Headers &headers, const std::string &key,
  7185. const std::string &token) {
  7186. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  7187. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  7188. // several lines. Match complete tokens rather than searching the raw value,
  7189. // so that a value such as "notupgrade" is not read as the token "upgrade".
  7190. auto rng = headers.equal_range(key);
  7191. for (auto it = rng.first; it != rng.second; ++it) {
  7192. const auto &value = it->second;
  7193. if (split_find(value.data(), value.data() + value.size(), ',',
  7194. [&](const char *b, const char *e) {
  7195. return case_ignore::equal(std::string(b, e), token);
  7196. })) {
  7197. return true;
  7198. }
  7199. }
  7200. return false;
  7201. }
  7202. template <typename Map>
  7203. inline typename Map::mapped_type
  7204. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  7205. auto rng = m.equal_range(key);
  7206. auto it = bounded_next(rng.first, id, rng.second);
  7207. if (it != rng.second) { return it->second; }
  7208. return typename Map::mapped_type();
  7209. }
  7210. inline void set_header(Headers &headers, const std::string &key,
  7211. const std::string &val) {
  7212. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  7213. }
  7214. // Drops the fields set_header() would refuse, from headers an application can
  7215. // fill directly: CR/LF in one would split the message.
  7216. inline void erase_invalid_fields(Headers &headers) {
  7217. for (auto it = headers.begin(); it != headers.end();) {
  7218. if (fields::is_field_valid(it->first, it->second)) {
  7219. ++it;
  7220. } else {
  7221. it = headers.erase(it);
  7222. }
  7223. }
  7224. }
  7225. inline bool read_headers(Stream &strm, Headers &headers) {
  7226. const auto bufsiz = 2048;
  7227. char buf[bufsiz];
  7228. stream_line_reader line_reader(strm, buf, bufsiz);
  7229. size_t header_count = 0;
  7230. for (;;) {
  7231. if (!line_reader.getline()) { return false; }
  7232. // Check if the line ends with CRLF.
  7233. auto line_terminator_len = 2;
  7234. if (line_reader.end_with_crlf()) {
  7235. // Blank line indicates end of headers.
  7236. if (line_reader.size() == 2) { break; }
  7237. } else {
  7238. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7239. // Blank line indicates end of headers.
  7240. if (line_reader.size() == 1) { break; }
  7241. line_terminator_len = 1;
  7242. #else
  7243. continue; // Skip invalid line.
  7244. #endif
  7245. }
  7246. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7247. // Check header count limit
  7248. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  7249. // Exclude line terminator
  7250. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  7251. if (!parse_header(line_reader.ptr(), end,
  7252. [&](const std::string &key, const std::string &val) {
  7253. headers.emplace(key, val);
  7254. })) {
  7255. return false;
  7256. }
  7257. header_count++;
  7258. }
  7259. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7260. // headers that have different values to prevent request smuggling.
  7261. auto cl_range = headers.equal_range("Content-Length");
  7262. if (cl_range.first != cl_range.second) {
  7263. const auto &first_val = cl_range.first->second;
  7264. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7265. if (it->second != first_val) { return false; }
  7266. }
  7267. }
  7268. return true;
  7269. }
  7270. // Parsed by hand: std::regex_match recurses once per character of the reason
  7271. // phrase, which a server can make as long as a whole line.
  7272. inline bool parse_status_line(const char *line, std::string &version,
  7273. int &status, std::string &reason) {
  7274. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7275. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7276. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7277. !is_ascii_digit(line[11])) {
  7278. return false;
  7279. }
  7280. auto p = line + 12;
  7281. auto reason_begin = p;
  7282. if (*p == ' ') {
  7283. reason_begin = ++p;
  7284. p += std::strcspn(p, "\r\n");
  7285. }
  7286. auto reason_end = p;
  7287. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7288. if (*p == '\r') { p++; }
  7289. #else
  7290. if (*p++ != '\r') { return false; }
  7291. #endif
  7292. if (*p++ != '\n' || *p != '\0') { return false; }
  7293. version.assign(line, 8);
  7294. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7295. reason.assign(reason_begin, reason_end);
  7296. return true;
  7297. }
  7298. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7299. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7300. struct WebSocketUpgradeResponse {
  7301. Error error = Error::Success;
  7302. int status = -1;
  7303. Headers headers;
  7304. std::string selected_subprotocol;
  7305. };
  7306. // Reads a response's status line and headers, leaving any body unread. An
  7307. // unparsable status line is no stream error; it just leaves `status` as is.
  7308. inline bool read_response_head(Stream &strm, int &status, Headers &headers) {
  7309. const auto bufsiz = 2048;
  7310. char buf[bufsiz];
  7311. stream_line_reader line_reader(strm, buf, bufsiz);
  7312. if (!line_reader.getline()) { return false; }
  7313. std::string version;
  7314. std::string reason;
  7315. if (!parse_status_line(line_reader.ptr(), version, status, reason)) {
  7316. return true;
  7317. }
  7318. return read_headers(strm, headers);
  7319. }
  7320. inline bool
  7321. read_websocket_upgrade_response(Stream &strm,
  7322. const std::string &expected_accept,
  7323. const std::string &offered_subprotocols,
  7324. WebSocketUpgradeResponse &upgrade) {
  7325. // The headers of a rejection are kept so the caller can see why the server
  7326. // refused the upgrade.
  7327. if (!read_response_head(strm, upgrade.status, upgrade.headers)) {
  7328. upgrade.error = Error::Read;
  7329. return false;
  7330. }
  7331. const auto &headers = upgrade.headers;
  7332. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7333. upgrade.error = Error::WebSocketHandshake;
  7334. return false;
  7335. }
  7336. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7337. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7338. upgrade.error = Error::WebSocketHandshake;
  7339. return false;
  7340. }
  7341. // Verify Connection: Upgrade
  7342. if (!has_header_token(headers, "Connection", "upgrade")) {
  7343. upgrade.error = Error::WebSocketHandshake;
  7344. return false;
  7345. }
  7346. // Verify Sec-WebSocket-Accept header value
  7347. auto it = headers.find("Sec-WebSocket-Accept");
  7348. if (it == headers.end() || it->second != expected_accept) {
  7349. upgrade.error = Error::WebSocketHandshake;
  7350. return false;
  7351. }
  7352. // Extract negotiated subprotocol
  7353. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7354. if (proto_it != headers.end()) {
  7355. upgrade.selected_subprotocol = proto_it->second;
  7356. }
  7357. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7358. if (!upgrade.selected_subprotocol.empty()) {
  7359. auto was_offered = false;
  7360. split(offered_subprotocols.data(),
  7361. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7362. [&](const char *b, const char *e) {
  7363. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7364. was_offered = true;
  7365. }
  7366. });
  7367. if (!was_offered) {
  7368. upgrade.error = Error::WebSocketHandshake;
  7369. return false;
  7370. }
  7371. }
  7372. return true;
  7373. }
  7374. enum class ReadContentResult {
  7375. Success, // Successfully read the content
  7376. PayloadTooLarge, // The content exceeds the specified payload limit
  7377. Error // An error occurred while reading the content
  7378. };
  7379. inline ReadContentResult read_content_with_length(
  7380. Stream &strm, size_t len, DownloadProgress progress,
  7381. ContentReceiverWithProgress out,
  7382. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7383. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7384. detail::BodyReader br;
  7385. br.stream = &strm;
  7386. br.has_content_length = true;
  7387. br.content_length = len;
  7388. br.payload_max_length = payload_max_length;
  7389. br.chunked = false;
  7390. br.bytes_read = 0;
  7391. br.last_error = Error::Success;
  7392. size_t r = 0;
  7393. while (r < len) {
  7394. auto read_len = static_cast<size_t>(len - r);
  7395. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7396. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7397. if (n <= 0) {
  7398. // Check if it was a payload size error
  7399. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7400. return ReadContentResult::PayloadTooLarge;
  7401. }
  7402. return ReadContentResult::Error;
  7403. }
  7404. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7405. return ReadContentResult::Error;
  7406. }
  7407. r += static_cast<size_t>(n);
  7408. if (progress) {
  7409. if (!progress(r, len)) { return ReadContentResult::Error; }
  7410. }
  7411. }
  7412. return ReadContentResult::Success;
  7413. }
  7414. inline ReadContentResult
  7415. read_content_without_length(Stream &strm, size_t payload_max_length,
  7416. ContentReceiverWithProgress out) {
  7417. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7418. size_t r = 0;
  7419. for (;;) {
  7420. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7421. if (n == 0) { return ReadContentResult::Success; }
  7422. if (n < 0) { return ReadContentResult::Error; }
  7423. // Check if adding this data would exceed the payload limit
  7424. if (payload_max_length > 0 &&
  7425. (r > payload_max_length ||
  7426. payload_max_length - r < static_cast<size_t>(n))) {
  7427. return ReadContentResult::PayloadTooLarge;
  7428. }
  7429. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7430. return ReadContentResult::Error;
  7431. }
  7432. r += static_cast<size_t>(n);
  7433. }
  7434. return ReadContentResult::Success;
  7435. }
  7436. template <typename T>
  7437. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7438. size_t payload_max_length,
  7439. ContentReceiverWithProgress out) {
  7440. detail::ChunkedDecoder dec(strm);
  7441. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7442. size_t total_len = 0;
  7443. for (;;) {
  7444. size_t chunk_offset = 0;
  7445. size_t chunk_total = 0;
  7446. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7447. if (n < 0) { return ReadContentResult::Error; }
  7448. if (n == 0) {
  7449. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7450. return ReadContentResult::Error;
  7451. }
  7452. return ReadContentResult::Success;
  7453. }
  7454. if (payload_max_length > 0 &&
  7455. (total_len > payload_max_length ||
  7456. payload_max_length - total_len < static_cast<size_t>(n))) {
  7457. return ReadContentResult::PayloadTooLarge;
  7458. }
  7459. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7460. return ReadContentResult::Error;
  7461. }
  7462. total_len += static_cast<size_t>(n);
  7463. }
  7464. }
  7465. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7466. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7467. // is the final transfer coding. A single field value may list several
  7468. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7469. // several Transfer-Encoding lines, which combine into one comma-separated
  7470. // list in the order the lines were received. Headers preserves that order,
  7471. // so the final coding is the last token of the last line. Match it
  7472. // case-insensitively rather than comparing the whole value against
  7473. // "chunked".
  7474. //
  7475. // Security: reading a chunked message as unframed leaves its body in the
  7476. // socket, where a keep-alive connection parses it as a smuggled request.
  7477. // Server::process_request() answers 400 and closes when the final coding is
  7478. // not chunked, so a request whose framing cannot be determined never
  7479. // reaches the "no body" path.
  7480. auto rng = headers.equal_range("Transfer-Encoding");
  7481. if (rng.first == rng.second) { return false; }
  7482. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7483. // combined list ending in nothing rather than inheriting the line before it.
  7484. std::string last_coding;
  7485. for (auto it = rng.first; it != rng.second; ++it) {
  7486. const auto &value = it->second;
  7487. last_coding.clear();
  7488. split(value.data(), value.data() + value.size(), ',',
  7489. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7490. }
  7491. return case_ignore::equal(last_coding, "chunked");
  7492. }
  7493. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7494. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7495. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7496. return msg.has_header("Transfer-Encoding") &&
  7497. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7498. }
  7499. inline bool has_conflicting_content_length(const Headers &headers) {
  7500. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7501. // Content-Length is framed ambiguously. The body readers here delimit it by
  7502. // the transfer coding and drop Content-Length, while an intermediary may do
  7503. // the reverse, so the two disagree on where the body ends and a reused
  7504. // connection is desynchronised (request/response smuggling). Content-Length:
  7505. // 0 is tolerated for compatibility with existing peers.
  7506. return has_header(headers, "Transfer-Encoding") &&
  7507. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7508. }
  7509. template <typename T, typename U>
  7510. bool prepare_content_receiver(T &x, int &status,
  7511. ContentReceiverWithProgress receiver,
  7512. bool decompress, size_t payload_max_length,
  7513. bool &exceed_payload_max_length, U callback) {
  7514. if (decompress) {
  7515. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7516. std::unique_ptr<decompressor> decompressor;
  7517. if (!encoding.empty()) {
  7518. // A coding we know about but were not built with is an error. An
  7519. // unrecognized coding (including "identity") is left alone and the
  7520. // payload is passed through as-is, since some servers misuse the header,
  7521. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7522. decompressor = detail::create_decompressor(encoding);
  7523. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7524. status = StatusCode::UnsupportedMediaType_415;
  7525. return false;
  7526. }
  7527. }
  7528. if (decompressor) {
  7529. if (decompressor->is_valid()) {
  7530. size_t decompressed_size = 0;
  7531. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7532. size_t off, size_t len) {
  7533. return decompressor->decompress(
  7534. buf, n, [&](const char *buf2, size_t n2) {
  7535. // Guard against zip-bomb: check
  7536. // decompressed size against limit.
  7537. if (payload_max_length > 0 &&
  7538. (decompressed_size >= payload_max_length ||
  7539. n2 > payload_max_length - decompressed_size)) {
  7540. exceed_payload_max_length = true;
  7541. return false;
  7542. }
  7543. decompressed_size += n2;
  7544. return receiver(buf2, n2, off, len);
  7545. });
  7546. };
  7547. return callback(std::move(out));
  7548. } else {
  7549. status = StatusCode::InternalServerError_500;
  7550. return false;
  7551. }
  7552. }
  7553. }
  7554. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7555. size_t len) {
  7556. return receiver(buf, n, off, len);
  7557. };
  7558. return callback(std::move(out));
  7559. }
  7560. template <typename T>
  7561. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7562. DownloadProgress progress,
  7563. ContentReceiverWithProgress receiver, bool decompress) {
  7564. bool exceed_payload_max_length = false;
  7565. return prepare_content_receiver(
  7566. x, status, std::move(receiver), decompress, payload_max_length,
  7567. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7568. auto ret = true;
  7569. // Note: exceed_payload_max_length may also be set by the decompressor
  7570. // wrapper in prepare_content_receiver when the decompressed payload
  7571. // size exceeds the limit.
  7572. if (is_chunked_transfer_encoding(x.headers)) {
  7573. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7574. if (result == ReadContentResult::Success) {
  7575. ret = true;
  7576. } else if (result == ReadContentResult::PayloadTooLarge) {
  7577. exceed_payload_max_length = true;
  7578. ret = false;
  7579. } else {
  7580. ret = false;
  7581. }
  7582. } else if (!has_header(x.headers, "Content-Length")) {
  7583. auto result =
  7584. read_content_without_length(strm, payload_max_length, out);
  7585. if (result == ReadContentResult::Success) {
  7586. ret = true;
  7587. } else if (result == ReadContentResult::PayloadTooLarge) {
  7588. exceed_payload_max_length = true;
  7589. ret = false;
  7590. } else {
  7591. ret = false;
  7592. }
  7593. } else {
  7594. auto is_invalid_value = false;
  7595. auto len = get_header_value_u64(x.headers, "Content-Length",
  7596. (std::numeric_limits<size_t>::max)(),
  7597. 0, is_invalid_value);
  7598. if (is_invalid_value) {
  7599. ret = false;
  7600. } else if (len > 0) {
  7601. auto result = read_content_with_length(
  7602. strm, len, std::move(progress), out, payload_max_length);
  7603. ret = (result == ReadContentResult::Success);
  7604. if (result == ReadContentResult::PayloadTooLarge) {
  7605. exceed_payload_max_length = true;
  7606. }
  7607. }
  7608. }
  7609. if (!ret) {
  7610. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7611. : StatusCode::BadRequest_400;
  7612. }
  7613. return ret;
  7614. });
  7615. }
  7616. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7617. const std::string &path) {
  7618. // Neither the method nor the request target may carry CR/LF, SP or other
  7619. // control octets; otherwise a value smuggled into either splits the request
  7620. // line and injects headers or a whole request.
  7621. if (!fields::is_token(method)) { return -1; }
  7622. if (!fields::is_request_target(path)) { return -1; }
  7623. std::string s = method;
  7624. s += ' ';
  7625. s += path;
  7626. s += " HTTP/1.1\r\n";
  7627. return strm.write(s.data(), s.size());
  7628. }
  7629. inline ssize_t write_response_line(Stream &strm, int status) {
  7630. std::string s = "HTTP/1.1 ";
  7631. s += std::to_string(status);
  7632. s += ' ';
  7633. s += httplib::status_message(status);
  7634. s += "\r\n";
  7635. return strm.write(s.data(), s.size());
  7636. }
  7637. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7638. ssize_t write_len = 0;
  7639. for (const auto &x : headers) {
  7640. std::string s;
  7641. s = x.first;
  7642. s += ": ";
  7643. s += x.second;
  7644. s += "\r\n";
  7645. auto len = strm.write(s.data(), s.size());
  7646. if (len < 0) { return len; }
  7647. write_len += len;
  7648. }
  7649. auto len = strm.write("\r\n");
  7650. if (len < 0) { return len; }
  7651. write_len += len;
  7652. return write_len;
  7653. }
  7654. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7655. size_t offset = 0;
  7656. while (offset < l) {
  7657. auto length = strm.write(d + offset, l - offset);
  7658. if (length < 0) { return false; }
  7659. offset += static_cast<size_t>(length);
  7660. }
  7661. return true;
  7662. }
  7663. template <typename T>
  7664. inline bool write_content_with_progress(Stream &strm,
  7665. const ContentProvider &content_provider,
  7666. size_t offset, size_t length,
  7667. T is_shutting_down,
  7668. const UploadProgress &upload_progress,
  7669. Error &error) {
  7670. size_t end_offset = offset + length;
  7671. size_t start_offset = offset;
  7672. auto ok = true;
  7673. auto finished = false;
  7674. DataSink data_sink;
  7675. data_sink.write = [&](const char *d, size_t l) -> bool {
  7676. if (ok) {
  7677. // Bytes past `length` would follow the framed body, where the peer reads
  7678. // them as the next message. Write only what fits and fail the rest.
  7679. if (l > end_offset - offset) {
  7680. l = end_offset - offset;
  7681. ok = false;
  7682. }
  7683. if (write_data(strm, d, l)) {
  7684. offset += l;
  7685. if (upload_progress && length > 0) {
  7686. size_t current_written = offset - start_offset;
  7687. if (!upload_progress(current_written, length)) {
  7688. ok = false;
  7689. return false;
  7690. }
  7691. }
  7692. } else {
  7693. ok = false;
  7694. }
  7695. }
  7696. return ok;
  7697. };
  7698. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7699. // The body is framed by `length`, so a provider that reports itself done
  7700. // early has truncated it. Record that and let the short-body check below
  7701. // fail the write, rather than calling the provider again forever.
  7702. data_sink.done = [&]() { finished = true; };
  7703. while (offset < end_offset && !finished && !is_shutting_down()) {
  7704. auto last_offset = offset;
  7705. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7706. error = Error::Write;
  7707. return false;
  7708. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7709. error = Error::Canceled;
  7710. return false;
  7711. } else if (!ok) {
  7712. error = Error::Write;
  7713. return false;
  7714. }
  7715. // A provider that reports success without writing anything and without
  7716. // reporting itself done gets handed the same offset and length again on
  7717. // the next pass, so it would spin here for as long as the peer stays
  7718. // connected. Treat making no progress as a short body, like done() early.
  7719. if (!finished && offset == last_offset) {
  7720. error = Error::Write;
  7721. return false;
  7722. }
  7723. }
  7724. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7725. error = Error::Write;
  7726. return false;
  7727. }
  7728. error = Error::Success;
  7729. return true;
  7730. }
  7731. template <typename T>
  7732. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7733. size_t offset, size_t length, T is_shutting_down,
  7734. Error &error) {
  7735. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7736. is_shutting_down, nullptr, error);
  7737. }
  7738. template <typename T>
  7739. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7740. size_t offset, size_t length,
  7741. const T &is_shutting_down) {
  7742. auto error = Error::Success;
  7743. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7744. error);
  7745. }
  7746. template <typename T>
  7747. inline bool
  7748. write_content_without_length(Stream &strm,
  7749. const ContentProvider &content_provider,
  7750. const T &is_shutting_down) {
  7751. size_t offset = 0;
  7752. auto data_available = true;
  7753. auto ok = true;
  7754. DataSink data_sink;
  7755. data_sink.write = [&](const char *d, size_t l) -> bool {
  7756. if (ok) {
  7757. offset += l;
  7758. if (!write_data(strm, d, l)) { ok = false; }
  7759. }
  7760. return ok;
  7761. };
  7762. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7763. data_sink.done = [&](void) { data_available = false; };
  7764. while (data_available && !is_shutting_down()) {
  7765. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7766. return false;
  7767. } else if (!content_provider(offset, 0, data_sink)) {
  7768. return false;
  7769. } else if (!ok) {
  7770. return false;
  7771. }
  7772. }
  7773. return !data_available; // true only if done() was called, false if shutting
  7774. // down
  7775. }
  7776. // Runs a known-length content provider to completion and compresses what it
  7777. // writes into `out`, chunk by chunk, without holding the identity form.
  7778. inline bool compress_content_provider(const ContentProvider &content_provider,
  7779. size_t length, compressor &cmp,
  7780. std::string &out) {
  7781. size_t offset = 0;
  7782. auto ok = true;
  7783. auto finished = false;
  7784. DataSink data_sink;
  7785. auto append = [&](const char *data, size_t data_len) {
  7786. out.append(data, data_len);
  7787. return true;
  7788. };
  7789. data_sink.write = [&](const char *d, size_t l) -> bool {
  7790. if (!ok) { return false; }
  7791. offset += l;
  7792. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7793. return ok;
  7794. };
  7795. // The body is framed by `length`, so a provider that reports itself done
  7796. // early has truncated it; the short-body check below turns that into a
  7797. // failure rather than calling the provider again forever.
  7798. data_sink.done = [&]() { finished = true; };
  7799. while (offset < length && !finished) {
  7800. auto prev_offset = offset;
  7801. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7802. return false;
  7803. }
  7804. // No Stream to block on here, so a provider that keeps returning true
  7805. // without writing would spin. Treat a pass that made no progress as a
  7806. // failure.
  7807. if (offset == prev_offset) { return false; }
  7808. }
  7809. if (offset != length) { return false; }
  7810. return cmp.compress(nullptr, 0, true, append);
  7811. }
  7812. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7813. // and the file flag, so recording them has to come after; keeping all of it
  7814. // here means a third file-serving path cannot get that order wrong.
  7815. inline void set_file_content_provider(Response &res,
  7816. const std::shared_ptr<mmap> &m,
  7817. const std::string &content_type,
  7818. EncodingType encoding) {
  7819. // One read and one write move up to this much of the file at a time.
  7820. auto buf = std::make_shared<std::vector<char>>(
  7821. (std::min)(m->size(), size_t(256 * 1024)));
  7822. res.set_content_provider(
  7823. m->size(), content_type,
  7824. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  7825. // Never read past the file, which ends the response early if it has
  7826. // shrunk since it was opened.
  7827. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  7828. if (n == 0) { return false; }
  7829. sink.write(buf->data(), n);
  7830. return true;
  7831. });
  7832. res.is_file_content_provider_ = true;
  7833. res.content_coding_ = encoding;
  7834. }
  7835. template <typename T, typename U>
  7836. inline bool
  7837. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7838. const T &is_shutting_down, U &compressor, Error &error) {
  7839. size_t offset = 0;
  7840. auto data_available = true;
  7841. auto ok = true;
  7842. DataSink data_sink;
  7843. data_sink.write = [&](const char *d, size_t l) -> bool {
  7844. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7845. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7846. // zero-length chunk is the terminator, so it must not be emitted here.
  7847. if (ok && l > 0) {
  7848. offset += l;
  7849. std::string payload;
  7850. if (compressor.compress(d, l, false,
  7851. [&](const char *data, size_t data_len) {
  7852. payload.append(data, data_len);
  7853. return true;
  7854. })) {
  7855. if (!payload.empty()) {
  7856. // Emit chunked response header and footer for each chunk
  7857. auto chunk =
  7858. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7859. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7860. }
  7861. } else {
  7862. ok = false;
  7863. }
  7864. }
  7865. return ok;
  7866. };
  7867. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7868. auto done_with_trailer = [&](const Headers *trailer) {
  7869. if (!ok) { return; }
  7870. data_available = false;
  7871. std::string payload;
  7872. if (!compressor.compress(nullptr, 0, true,
  7873. [&](const char *data, size_t data_len) {
  7874. payload.append(data, data_len);
  7875. return true;
  7876. })) {
  7877. ok = false;
  7878. return;
  7879. }
  7880. if (!payload.empty()) {
  7881. // Emit chunked response header and footer for each chunk
  7882. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7883. if (!write_data(strm, chunk.data(), chunk.size())) {
  7884. ok = false;
  7885. return;
  7886. }
  7887. }
  7888. constexpr const char done_marker[] = "0\r\n";
  7889. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7890. // Trailer
  7891. if (trailer) {
  7892. for (const auto &kv : *trailer) {
  7893. // Skip fields with invalid names or values to prevent response
  7894. // splitting via CR/LF injection, matching set_header().
  7895. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7896. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7897. if (!write_data(strm, field_line.data(), field_line.size())) {
  7898. ok = false;
  7899. }
  7900. }
  7901. }
  7902. constexpr const char crlf[] = "\r\n";
  7903. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7904. };
  7905. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7906. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7907. done_with_trailer(&trailer);
  7908. };
  7909. while (data_available && !is_shutting_down()) {
  7910. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7911. error = Error::Write;
  7912. return false;
  7913. } else if (!content_provider(offset, 0, data_sink)) {
  7914. error = Error::Canceled;
  7915. return false;
  7916. } else if (!ok) {
  7917. error = Error::Write;
  7918. return false;
  7919. }
  7920. }
  7921. if (data_available) { // exited due to is_shutting_down(), not done()
  7922. error = Error::Write;
  7923. return false;
  7924. }
  7925. error = Error::Success;
  7926. return true;
  7927. }
  7928. template <typename T, typename U>
  7929. inline bool write_content_chunked(Stream &strm,
  7930. const ContentProvider &content_provider,
  7931. const T &is_shutting_down, U &compressor) {
  7932. auto error = Error::Success;
  7933. return write_content_chunked(strm, content_provider, is_shutting_down,
  7934. compressor, error);
  7935. }
  7936. template <typename T>
  7937. inline bool redirect(T &cli, Request &req, Response &res,
  7938. const std::string &path, const std::string &location,
  7939. Error &error) {
  7940. Request new_req = req;
  7941. new_req.path = path;
  7942. new_req.params.clear();
  7943. new_req.redirect_count_ -= 1;
  7944. if (res.status == StatusCode::SeeOther_303 &&
  7945. (req.method != "GET" && req.method != "HEAD")) {
  7946. new_req.method = "GET";
  7947. new_req.body.clear();
  7948. new_req.headers.clear();
  7949. new_req.content_length_ = 0;
  7950. new_req.content_provider_ = nullptr;
  7951. new_req.is_chunked_content_provider_ = false;
  7952. }
  7953. Response new_res;
  7954. auto ret = cli.send(new_req, new_res, error);
  7955. if (ret) {
  7956. req = std::move(new_req);
  7957. res = std::move(new_res);
  7958. if (res.location.empty()) { res.location = location; }
  7959. }
  7960. return ret;
  7961. }
  7962. inline std::string params_to_query_str(const Params &params) {
  7963. std::string query;
  7964. for (auto it = params.begin(); it != params.end(); ++it) {
  7965. if (it != params.begin()) { query += '&'; }
  7966. query += encode_query_component(it->first);
  7967. query += '=';
  7968. query += encode_query_component(it->second);
  7969. }
  7970. return query;
  7971. }
  7972. // Splits one "key=value" span of a query string at its first '='. A span with
  7973. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7974. // "?flag" keeps its name.
  7975. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7976. std::string &val) {
  7977. divide(b, static_cast<std::size_t>(e - b), '=',
  7978. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7979. std::size_t rhs_size) {
  7980. key.assign(lhs_data, lhs_size);
  7981. val.assign(rhs_data, rhs_size);
  7982. });
  7983. }
  7984. inline void parse_query_text(const char *data, std::size_t size,
  7985. Params &params) {
  7986. std::set<std::string> cache;
  7987. split(data, data + size, '&', [&](const char *b, const char *e) {
  7988. std::string kv(b, e);
  7989. if (cache.find(kv) != cache.end()) { return; }
  7990. cache.insert(std::move(kv));
  7991. std::string key;
  7992. std::string val;
  7993. divide_query_pair(b, e, key, val);
  7994. if (!key.empty()) {
  7995. params.emplace(decode_query_component(key), decode_query_component(val));
  7996. }
  7997. });
  7998. }
  7999. inline void parse_query_text(const std::string &s, Params &params) {
  8000. parse_query_text(s.data(), s.size(), params);
  8001. }
  8002. // Normalize a query string by decoding and re-encoding each key/value pair
  8003. // while preserving the original parameter order. This avoids double-encoding
  8004. // and ensures consistent encoding. It works on the raw string rather than
  8005. // parsing into Params and re-serializing, because that round trip cannot
  8006. // reproduce the input: params_to_query_str() always emits '=', so a bare
  8007. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  8008. // duplicated pairs.
  8009. inline std::string normalize_query_string(const std::string &query) {
  8010. std::string result;
  8011. split(query.data(), query.data() + query.size(), '&',
  8012. [&](const char *b, const char *e) {
  8013. std::string key;
  8014. std::string val;
  8015. divide_query_pair(b, e, key, val);
  8016. if (!key.empty()) {
  8017. auto dec_key = decode_query_component(key);
  8018. auto dec_val = decode_query_component(val);
  8019. if (!result.empty()) { result += '&'; }
  8020. result += encode_query_component(dec_key);
  8021. if (!val.empty() || std::find(b, e, '=') != e) {
  8022. result += '=';
  8023. result += encode_query_component(dec_val);
  8024. }
  8025. }
  8026. });
  8027. return result;
  8028. }
  8029. // The query of a client's path: what follows '?', up to the fragment.
  8030. inline std::string query_of(const std::string &path) {
  8031. auto fragment_pos = path.find('#');
  8032. auto query_pos = path.find('?');
  8033. return query_pos < fragment_pos
  8034. ? path.substr(query_pos + 1, fragment_pos - query_pos - 1)
  8035. : std::string();
  8036. }
  8037. // Build the request target that goes on the wire from a caller-supplied path.
  8038. // Shared by the buffered send path and the streaming API so that both put the
  8039. // same bytes in the request line for the same input.
  8040. inline std::string encode_request_target(const std::string &uri,
  8041. bool path_encode) {
  8042. // The fragment stays with the client (RFC 9110 §7.1).
  8043. auto target = uri.substr(0, uri.find('#'));
  8044. // `substr(0, npos)` yields the whole string, which is what the no-query
  8045. // case needs.
  8046. auto query_pos = target.find('?');
  8047. auto path_part = target.substr(0, query_pos);
  8048. std::string query_part;
  8049. if (query_pos != std::string::npos) {
  8050. query_part = target.substr(query_pos + 1);
  8051. }
  8052. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  8053. if (!query_part.empty()) {
  8054. // When path encoding is disabled the caller has supplied an already-encoded
  8055. // target and expects the exact bytes to be sent on the wire, so skip
  8056. // normalization for the query too. Normalizing would decode-then-re-encode
  8057. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  8058. // which a strict RFC 3986 server decodes back as `+`, not a space).
  8059. if (path_encode) {
  8060. auto normalized = normalize_query_string(query_part);
  8061. if (!normalized.empty()) {
  8062. result += '?';
  8063. result += normalized;
  8064. }
  8065. } else {
  8066. result += '?';
  8067. result += query_part;
  8068. }
  8069. }
  8070. return result;
  8071. }
  8072. inline bool parse_multipart_boundary(const std::string &content_type,
  8073. std::string &boundary) {
  8074. std::map<std::string, std::string> params;
  8075. extract_media_type(content_type, &params);
  8076. auto it = params.find("boundary");
  8077. if (it == params.end()) { return false; }
  8078. boundary = it->second;
  8079. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  8080. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  8081. // bytes costs a nearly full comparison at nearly every position: the
  8082. // boundary's length multiplies the worst-case cost of scanning a body.
  8083. return !boundary.empty() && boundary.size() <= 70;
  8084. }
  8085. inline void parse_disposition_params(const std::string &s, Params &params) {
  8086. std::set<std::string> cache;
  8087. split_unquoted(
  8088. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  8089. std::string kv(b, e);
  8090. if (cache.find(kv) != cache.end()) { return; }
  8091. cache.insert(kv);
  8092. std::string key;
  8093. std::string val;
  8094. divide_param_pair(b, e, key, val);
  8095. if (!key.empty()) {
  8096. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  8097. }
  8098. });
  8099. }
  8100. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8101. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  8102. #else
  8103. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  8104. #endif
  8105. auto is_valid = [](const std::string &str) {
  8106. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  8107. };
  8108. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  8109. const auto pos = static_cast<size_t>(6);
  8110. const auto len = static_cast<size_t>(s.size() - 6);
  8111. auto all_valid_ranges = true;
  8112. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  8113. if (!all_valid_ranges) { return; }
  8114. const auto it = std::find(b, e, '-');
  8115. if (it == e) {
  8116. all_valid_ranges = false;
  8117. return;
  8118. }
  8119. const auto lhs = std::string(b, it);
  8120. const auto rhs = std::string(it + 1, e);
  8121. if (!is_valid(lhs) || !is_valid(rhs)) {
  8122. all_valid_ranges = false;
  8123. return;
  8124. }
  8125. ssize_t first = -1;
  8126. if (!lhs.empty()) {
  8127. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  8128. // would turn the range into a suffix range.
  8129. auto res =
  8130. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  8131. if (res.ec != std::errc{}) {
  8132. all_valid_ranges = false;
  8133. return;
  8134. }
  8135. }
  8136. ssize_t last = -1;
  8137. if (!rhs.empty()) {
  8138. // An overflowing last-byte-pos is past any content length, so keeping
  8139. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  8140. ssize_t v;
  8141. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  8142. if (res.ec == std::errc{}) { last = v; }
  8143. }
  8144. if ((first == -1 && last == -1) ||
  8145. (first != -1 && last != -1 && first > last)) {
  8146. all_valid_ranges = false;
  8147. return;
  8148. }
  8149. ranges.emplace_back(first, last);
  8150. });
  8151. return all_valid_ranges && !ranges.empty();
  8152. }
  8153. return false;
  8154. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8155. }
  8156. #else
  8157. } catch (...) { return false; }
  8158. #endif
  8159. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  8160. inline std::string remove_quoted_strings(const std::string &s) {
  8161. std::string out;
  8162. auto in_quotes = false;
  8163. for (size_t i = 0; i < s.size(); i++) {
  8164. if (s[i] == '"') {
  8165. in_quotes = !in_quotes;
  8166. } else if (!in_quotes) {
  8167. out += s[i];
  8168. } else if (s[i] == '\\') {
  8169. i++;
  8170. }
  8171. }
  8172. return out;
  8173. }
  8174. inline bool parse_accept_header(const std::string &s,
  8175. std::vector<std::string> &content_types) {
  8176. // Parameter values are not used here, so a quoted-string is dropped rather
  8177. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  8178. if (s.find('"') != std::string::npos) {
  8179. return parse_accept_header(remove_quoted_strings(s), content_types);
  8180. }
  8181. content_types.clear();
  8182. // Empty string is considered valid (no preference)
  8183. if (s.empty()) { return true; }
  8184. struct AcceptEntry {
  8185. std::string media_type;
  8186. double quality;
  8187. int order;
  8188. };
  8189. std::vector<AcceptEntry> entries;
  8190. int order = 0;
  8191. bool has_invalid_entry = false;
  8192. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  8193. // has to parse and ignore empty list elements, so a leading, trailing or
  8194. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  8195. // split() skips them, and the header length limit bounds how many a sender
  8196. // can send, so ignoring all of them cannot be used as a denial-of-service
  8197. // vector.
  8198. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  8199. std::string entry(b, e);
  8200. entry = trim_copy(entry);
  8201. AcceptEntry accept_entry;
  8202. accept_entry.order = order++;
  8203. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  8204. accept_entry.media_type, accept_entry.quality)) {
  8205. has_invalid_entry = true;
  8206. return;
  8207. }
  8208. // Remove additional parameters from media type
  8209. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  8210. // Basic validation of media type format
  8211. if (accept_entry.media_type.empty()) {
  8212. has_invalid_entry = true;
  8213. return;
  8214. }
  8215. // Check for basic media type format (should contain '/' or be '*')
  8216. if (accept_entry.media_type != "*" &&
  8217. accept_entry.media_type.find('/') == std::string::npos) {
  8218. has_invalid_entry = true;
  8219. return;
  8220. }
  8221. entries.push_back(std::move(accept_entry));
  8222. });
  8223. // Return false if any invalid entry was found
  8224. if (has_invalid_entry) { return false; }
  8225. // Sort by quality (descending), then by original order (ascending)
  8226. std::sort(entries.begin(), entries.end(),
  8227. [](const AcceptEntry &a, const AcceptEntry &b) {
  8228. if (a.quality != b.quality) {
  8229. return a.quality > b.quality; // Higher quality first
  8230. }
  8231. return a.order < b.order; // Earlier order first for same quality
  8232. });
  8233. // Extract sorted media types
  8234. content_types.reserve(entries.size());
  8235. for (auto &entry : entries) {
  8236. content_types.push_back(std::move(entry.media_type));
  8237. }
  8238. return true;
  8239. }
  8240. class FormDataParser {
  8241. public:
  8242. FormDataParser() = default;
  8243. void set_boundary(std::string &&boundary) {
  8244. boundary_ = std::move(boundary);
  8245. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8246. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8247. }
  8248. bool is_valid() const { return is_valid_; }
  8249. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8250. const ContentReceiver &content_callback) {
  8251. // Once the close delimiter has been seen the rest of the body is epilogue
  8252. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8253. // spread across reads is not copied in only to be erased right away.
  8254. if (state_ == 5) { return true; }
  8255. buf_append(buf, n);
  8256. while (buf_size() > 0) {
  8257. switch (state_) {
  8258. case 0: { // Initial boundary
  8259. auto pos = buf_find(dash_boundary_crlf_);
  8260. if (pos == buf_size()) {
  8261. // Not found yet: keep only a possible partial boundary at the tail so
  8262. // that a body which never contains the boundary cannot grow the
  8263. // buffer (and get rescanned from the start) without bound.
  8264. auto keep = dash_boundary_crlf_.size() - 1;
  8265. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8266. return true;
  8267. }
  8268. buf_erase(pos + dash_boundary_crlf_.size());
  8269. state_ = 1;
  8270. break;
  8271. }
  8272. case 1: { // New entry
  8273. clear_file_info();
  8274. header_searched_ = 0;
  8275. state_ = 2;
  8276. break;
  8277. }
  8278. case 2: { // Headers
  8279. // Resume where the last call stopped looking, so that a line arriving
  8280. // a few bytes at a time is not searched from its start each time.
  8281. auto pos = buf_find(crlf_, header_searched_);
  8282. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8283. while (pos < buf_size()) {
  8284. // Empty line
  8285. if (pos == 0) {
  8286. if (!header_callback(file_)) {
  8287. is_valid_ = false;
  8288. return false;
  8289. }
  8290. buf_erase(crlf_.size());
  8291. state_ = 3;
  8292. break;
  8293. }
  8294. // Check header count limit
  8295. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8296. is_valid_ = false;
  8297. return false;
  8298. }
  8299. header_count_++;
  8300. const auto header = buf_head(pos);
  8301. if (!parse_header(header.data(), header.data() + header.size(),
  8302. [&](const std::string &, const std::string &) {})) {
  8303. is_valid_ = false;
  8304. return false;
  8305. }
  8306. // Parse and emplace space trimmed headers into a map
  8307. if (!parse_header(
  8308. header.data(), header.data() + header.size(),
  8309. [&](const std::string &key, const std::string &val) {
  8310. file_.headers.emplace(key, val);
  8311. })) {
  8312. is_valid_ = false;
  8313. return false;
  8314. }
  8315. constexpr const char header_content_type[] = "Content-Type:";
  8316. if (start_with_case_ignore(header, header_content_type)) {
  8317. file_.content_type =
  8318. trim_copy(header.substr(str_len(header_content_type)));
  8319. } else {
  8320. std::string disposition_params;
  8321. if (parse_content_disposition(header, disposition_params)) {
  8322. Params params;
  8323. parse_disposition_params(disposition_params, params);
  8324. auto it = params.find("name");
  8325. if (it != params.end()) {
  8326. file_.name = it->second;
  8327. } else {
  8328. is_valid_ = false;
  8329. return false;
  8330. }
  8331. it = params.find("filename");
  8332. if (it != params.end()) { file_.filename = it->second; }
  8333. it = params.find("filename*");
  8334. if (it != params.end()) {
  8335. // RFC 5987: only UTF-8 encoding is allowed
  8336. const auto &val = it->second;
  8337. constexpr const char utf8_prefix[] = "UTF-8''";
  8338. constexpr size_t prefix_len = str_len(utf8_prefix);
  8339. if (val.size() > prefix_len &&
  8340. start_with_case_ignore(val, utf8_prefix)) {
  8341. file_.filename = decode_path_component(
  8342. val.substr(prefix_len)); // override...
  8343. } else {
  8344. is_valid_ = false;
  8345. return false;
  8346. }
  8347. }
  8348. }
  8349. }
  8350. buf_erase(pos + crlf_.size());
  8351. pos = buf_find(crlf_);
  8352. }
  8353. if (state_ != 3) {
  8354. // The CR of the CRLF may be the last byte so far.
  8355. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8356. return true;
  8357. }
  8358. break;
  8359. }
  8360. case 3: { // Body
  8361. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8362. auto pos = buf_find(crlf_dash_boundary_);
  8363. if (pos < buf_size()) {
  8364. if (!content_callback(buf_data(), pos)) {
  8365. is_valid_ = false;
  8366. return false;
  8367. }
  8368. buf_erase(pos + crlf_dash_boundary_.size());
  8369. state_ = 4;
  8370. } else {
  8371. auto len = buf_size() - crlf_dash_boundary_.size();
  8372. if (len > 0) {
  8373. if (!content_callback(buf_data(), len)) {
  8374. is_valid_ = false;
  8375. return false;
  8376. }
  8377. buf_erase(len);
  8378. }
  8379. return true;
  8380. }
  8381. break;
  8382. }
  8383. case 4: { // Boundary
  8384. if (crlf_.size() > buf_size()) { return true; }
  8385. if (buf_start_with(crlf_)) {
  8386. buf_erase(crlf_.size());
  8387. state_ = 1;
  8388. } else if (buf_start_with(dash_)) {
  8389. buf_erase(dash_.size());
  8390. is_valid_ = true;
  8391. state_ = 5;
  8392. } else {
  8393. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8394. // accepted after a boundary; RFC 2046 allows transport-padding in
  8395. // between, but this parser has never supported it. Either way the
  8396. // body is already destined to be rejected, so fail now instead of
  8397. // buffering the rest of it. Both are two bytes, so the check above
  8398. // already guarantees enough buffered data to decide.
  8399. is_valid_ = false;
  8400. return false;
  8401. }
  8402. break;
  8403. }
  8404. case 5: { // Epilogue
  8405. buf_erase(buf_size());
  8406. break;
  8407. }
  8408. }
  8409. }
  8410. return true;
  8411. }
  8412. private:
  8413. void clear_file_info() {
  8414. file_.name.clear();
  8415. file_.filename.clear();
  8416. file_.content_type.clear();
  8417. file_.headers.clear();
  8418. header_count_ = 0;
  8419. }
  8420. bool start_with_case_ignore(const std::string &a, const char *b,
  8421. size_t offset = 0) const {
  8422. const auto b_len = strlen(b);
  8423. if (a.size() < offset + b_len) { return false; }
  8424. for (size_t i = 0; i < b_len; i++) {
  8425. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8426. return false;
  8427. }
  8428. }
  8429. return true;
  8430. }
  8431. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8432. // Returns true if header matches, with the params portion in `params_out`.
  8433. bool parse_content_disposition(const std::string &header,
  8434. std::string &params_out) const {
  8435. constexpr const char prefix[] = "Content-Disposition:";
  8436. constexpr size_t prefix_len = str_len(prefix);
  8437. if (!start_with_case_ignore(header, prefix)) { return false; }
  8438. // Skip whitespace after "Content-Disposition:"
  8439. auto pos = prefix_len;
  8440. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8441. pos++;
  8442. }
  8443. // Match "form-data;" (case-insensitive)
  8444. constexpr const char form_data[] = "form-data;";
  8445. constexpr size_t form_data_len = str_len(form_data);
  8446. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8447. pos += form_data_len;
  8448. // Skip whitespace after "form-data;"
  8449. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8450. pos++;
  8451. }
  8452. params_out = header.substr(pos);
  8453. return true;
  8454. }
  8455. const std::string dash_ = "--";
  8456. const std::string crlf_ = "\r\n";
  8457. std::string boundary_;
  8458. std::string dash_boundary_crlf_;
  8459. std::string crlf_dash_boundary_;
  8460. size_t state_ = 0;
  8461. bool is_valid_ = false;
  8462. FormData file_;
  8463. size_t header_count_ = 0;
  8464. size_t header_searched_ = 0;
  8465. // Buffer
  8466. bool start_with(const std::string &a, size_t spos, size_t epos,
  8467. const std::string &b) const {
  8468. if (epos - spos < b.size()) { return false; }
  8469. for (size_t i = 0; i < b.size(); i++) {
  8470. if (a[i + spos] != b[i]) { return false; }
  8471. }
  8472. return true;
  8473. }
  8474. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8475. const char *buf_data() const { return &buf_[buf_spos_]; }
  8476. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8477. bool buf_start_with(const std::string &s) const {
  8478. return start_with(buf_, buf_spos_, buf_epos_, s);
  8479. }
  8480. size_t buf_find(const std::string &s, size_t from = 0) const {
  8481. auto c = s.front();
  8482. size_t off = buf_spos_ + from;
  8483. while (off < buf_epos_) {
  8484. auto pos = off;
  8485. while (true) {
  8486. if (pos == buf_epos_) { return buf_size(); }
  8487. if (buf_[pos] == c) { break; }
  8488. pos++;
  8489. }
  8490. auto remaining_size = buf_epos_ - pos;
  8491. if (s.size() > remaining_size) { return buf_size(); }
  8492. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8493. off = pos + 1;
  8494. }
  8495. return buf_size();
  8496. }
  8497. void buf_append(const char *data, size_t n) {
  8498. auto remaining_size = buf_size();
  8499. if (remaining_size > 0 && buf_spos_ > 0) {
  8500. for (size_t i = 0; i < remaining_size; i++) {
  8501. buf_[i] = buf_[buf_spos_ + i];
  8502. }
  8503. }
  8504. buf_spos_ = 0;
  8505. buf_epos_ = remaining_size;
  8506. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8507. for (size_t i = 0; i < n; i++) {
  8508. buf_[buf_epos_ + i] = data[i];
  8509. }
  8510. buf_epos_ += n;
  8511. }
  8512. void buf_erase(size_t size) { buf_spos_ += size; }
  8513. std::string buf_;
  8514. size_t buf_spos_ = 0;
  8515. size_t buf_epos_ = 0;
  8516. };
  8517. inline std::string random_string(size_t length) {
  8518. constexpr const char data[] =
  8519. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8520. std::string result(length, '\0');
  8521. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8522. for (auto &c : result) {
  8523. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8524. }
  8525. return result;
  8526. }
  8527. inline std::string make_multipart_data_boundary() {
  8528. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8529. }
  8530. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8531. auto valid = true;
  8532. for (size_t i = 0; i < boundary.size(); i++) {
  8533. auto c = boundary[i];
  8534. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8535. valid = false;
  8536. break;
  8537. }
  8538. }
  8539. return valid;
  8540. }
  8541. // Escape a multipart field name/filename following the WHATWG HTML standard
  8542. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  8543. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  8544. // With quoted = false, only CR and LF are escaped; this is for header values
  8545. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  8546. inline std::string escape_multipart_field(const std::string &s,
  8547. bool quoted = true) {
  8548. std::string result;
  8549. result.reserve(s.size());
  8550. for (auto c : s) {
  8551. switch (c) {
  8552. case '"':
  8553. if (quoted) {
  8554. result += "%22";
  8555. } else {
  8556. result += c;
  8557. }
  8558. break;
  8559. case '\\':
  8560. // A lone backslash would escape the character after it (RFC 9110
  8561. // 5.6.4).
  8562. if (quoted) { result += '\\'; }
  8563. result += c;
  8564. break;
  8565. case '\r': result += "%0D"; break;
  8566. case '\n': result += "%0A"; break;
  8567. default: result += c; break;
  8568. }
  8569. }
  8570. return result;
  8571. }
  8572. template <typename T>
  8573. inline std::string
  8574. serialize_multipart_formdata_item_begin(const T &item,
  8575. const std::string &boundary) {
  8576. std::string body = "--" + boundary + "\r\n";
  8577. body += "Content-Disposition: form-data; name=\"" +
  8578. escape_multipart_field(item.name) + "\"";
  8579. if (!item.filename.empty()) {
  8580. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8581. }
  8582. body += "\r\n";
  8583. if (!item.content_type.empty()) {
  8584. body +=
  8585. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8586. "\r\n";
  8587. }
  8588. body += "\r\n";
  8589. return body;
  8590. }
  8591. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8592. inline std::string
  8593. serialize_multipart_formdata_finish(const std::string &boundary) {
  8594. return "--" + boundary + "--\r\n";
  8595. }
  8596. inline std::string
  8597. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8598. return "multipart/form-data; boundary=" + boundary;
  8599. }
  8600. inline std::string
  8601. serialize_multipart_formdata(const UploadFormDataItems &items,
  8602. const std::string &boundary, bool finish = true) {
  8603. std::string body;
  8604. for (const auto &item : items) {
  8605. body += serialize_multipart_formdata_item_begin(item, boundary);
  8606. body += item.content + serialize_multipart_formdata_item_end();
  8607. }
  8608. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8609. return body;
  8610. }
  8611. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8612. const std::string &boundary) {
  8613. size_t total = 0;
  8614. for (const auto &item : items) {
  8615. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8616. total += item.content.size();
  8617. total += serialize_multipart_formdata_item_end().size();
  8618. }
  8619. total += serialize_multipart_formdata_finish(boundary).size();
  8620. return total;
  8621. }
  8622. struct MultipartSegment {
  8623. const char *data;
  8624. size_t size;
  8625. };
  8626. // NOTE: items must outlive the returned ContentProvider
  8627. // (safe for synchronous use inside Post/Put/Patch)
  8628. inline ContentProvider
  8629. make_multipart_content_provider(const UploadFormDataItems &items,
  8630. const std::string &boundary) {
  8631. // Own the per-item header strings and the finish string
  8632. std::vector<std::string> owned;
  8633. owned.reserve(items.size() + 1);
  8634. for (const auto &item : items)
  8635. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8636. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8637. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8638. std::vector<MultipartSegment> segs;
  8639. segs.reserve(items.size() * 3 + 1);
  8640. static const char crlf[] = "\r\n";
  8641. for (size_t i = 0; i < items.size(); i++) {
  8642. segs.push_back({owned[i].data(), owned[i].size()});
  8643. segs.push_back({items[i].content.data(), items[i].content.size()});
  8644. segs.push_back({crlf, 2});
  8645. }
  8646. segs.push_back({owned.back().data(), owned.back().size()});
  8647. struct MultipartState {
  8648. std::vector<std::string> owned;
  8649. std::vector<MultipartSegment> segs;
  8650. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8651. };
  8652. auto state = std::make_shared<MultipartState>();
  8653. state->owned = std::move(owned);
  8654. // `segs` holds raw pointers into owned strings; std::string move preserves
  8655. // the data pointer, so these pointers remain valid after the move above.
  8656. state->segs = std::move(segs);
  8657. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8658. // Buffer multiple small segments into fewer, larger writes to avoid
  8659. // excessive TCP packets when there are many form data items (#2410)
  8660. auto &buf = state->buf;
  8661. auto buf_size = buf.size();
  8662. size_t buf_len = 0;
  8663. size_t remaining = length;
  8664. // Find the first segment containing 'offset'
  8665. size_t pos = 0;
  8666. size_t seg_idx = 0;
  8667. for (; seg_idx < state->segs.size(); seg_idx++) {
  8668. const auto &seg = state->segs[seg_idx];
  8669. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8670. pos += seg.size;
  8671. }
  8672. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8673. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8674. const auto &seg = state->segs[seg_idx];
  8675. size_t available = seg.size - seg_offset;
  8676. size_t to_copy = (std::min)(available, remaining);
  8677. const char *src = seg.data + seg_offset;
  8678. seg_offset = 0; // only the first segment has a non-zero offset
  8679. while (to_copy > 0) {
  8680. size_t space = buf_size - buf_len;
  8681. size_t chunk = (std::min)(to_copy, space);
  8682. std::memcpy(buf.data() + buf_len, src, chunk);
  8683. buf_len += chunk;
  8684. src += chunk;
  8685. to_copy -= chunk;
  8686. remaining -= chunk;
  8687. if (buf_len == buf_size) {
  8688. if (!sink.write(buf.data(), buf_len)) { return false; }
  8689. buf_len = 0;
  8690. }
  8691. }
  8692. }
  8693. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8694. return true;
  8695. };
  8696. }
  8697. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8698. if (ranges.size() <= 1) return;
  8699. // Sort ranges by start position
  8700. std::sort(ranges.begin(), ranges.end(),
  8701. [](const Range &a, const Range &b) { return a.first < b.first; });
  8702. Ranges coalesced;
  8703. coalesced.reserve(ranges.size());
  8704. for (auto &r : ranges) {
  8705. auto first_pos = r.first;
  8706. auto last_pos = r.second;
  8707. // Handle special cases like in range_error
  8708. if (first_pos == -1 && last_pos == -1) {
  8709. first_pos = 0;
  8710. last_pos = static_cast<ssize_t>(content_length);
  8711. }
  8712. if (first_pos == -1) {
  8713. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8714. last_pos = static_cast<ssize_t>(content_length) - 1;
  8715. }
  8716. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8717. last_pos = static_cast<ssize_t>(content_length) - 1;
  8718. }
  8719. // Skip invalid ranges
  8720. if (!(0 <= first_pos && first_pos <= last_pos &&
  8721. last_pos < static_cast<ssize_t>(content_length))) {
  8722. continue;
  8723. }
  8724. // Coalesce with previous range if overlapping or adjacent (but not
  8725. // identical)
  8726. if (!coalesced.empty()) {
  8727. auto &prev = coalesced.back();
  8728. // Check if current range overlaps or is adjacent to previous range
  8729. // but don't coalesce identical ranges (allow duplicates)
  8730. if (first_pos <= prev.second + 1 &&
  8731. !(first_pos == prev.first && last_pos == prev.second)) {
  8732. // Extend the previous range
  8733. prev.second = (std::max)(prev.second, last_pos);
  8734. continue;
  8735. }
  8736. }
  8737. // Add new range
  8738. coalesced.emplace_back(first_pos, last_pos);
  8739. }
  8740. ranges = std::move(coalesced);
  8741. }
  8742. inline bool range_error(Request &req, Response &res) {
  8743. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8744. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8745. req.ranges.clear();
  8746. if (res.status == StatusCode::PartialContent_206) {
  8747. res.status = StatusCode::OK_200;
  8748. }
  8749. return false;
  8750. }
  8751. ssize_t content_len = static_cast<ssize_t>(
  8752. res.content_length_ ? res.content_length_ : res.body.size());
  8753. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8754. size_t overwrapping_count = 0;
  8755. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8756. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8757. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8758. // Too many ranges
  8759. if (CPPHTTPLIB_RANGE_MAX_COUNT > 0 &&
  8760. req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) {
  8761. return true;
  8762. }
  8763. for (auto &r : req.ranges) {
  8764. auto &first_pos = r.first;
  8765. auto &last_pos = r.second;
  8766. if (first_pos == -1 && last_pos == -1) {
  8767. first_pos = 0;
  8768. last_pos = content_len;
  8769. }
  8770. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8771. // selects the entire representation.
  8772. if (first_pos == -1) {
  8773. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8774. last_pos = content_len - 1;
  8775. }
  8776. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8777. // A client can limit the number of bytes requested without knowing the
  8778. // size of the selected representation. If the last-pos value is absent,
  8779. // or if the value is greater than or equal to the current length of the
  8780. // representation data, the byte range is interpreted as the remainder of
  8781. // the representation (i.e., the server replaces the value of last-pos
  8782. // with a value that is one less than the current length of the selected
  8783. // representation).
  8784. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8785. if (last_pos == -1 || last_pos >= content_len) {
  8786. last_pos = content_len - 1;
  8787. }
  8788. // Range must be within content length
  8789. if (!(0 <= first_pos && first_pos <= last_pos &&
  8790. last_pos <= content_len - 1)) {
  8791. return true;
  8792. }
  8793. // Request must not have more than two overlapping ranges
  8794. for (const auto &processed_range : processed_ranges) {
  8795. if (!(last_pos < processed_range.first ||
  8796. first_pos > processed_range.second)) {
  8797. overwrapping_count++;
  8798. if (overwrapping_count > 2) { return true; }
  8799. break; // Only count once per range
  8800. }
  8801. }
  8802. processed_ranges.emplace_back(first_pos, last_pos);
  8803. }
  8804. // After validation, coalesce overlapping ranges as per RFC 9110
  8805. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8806. }
  8807. return false;
  8808. }
  8809. inline std::pair<size_t, size_t>
  8810. get_range_offset_and_length(Range r, size_t content_length) {
  8811. assert(r.first != -1 && r.second != -1);
  8812. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8813. assert(r.first <= r.second &&
  8814. r.second < static_cast<ssize_t>(content_length));
  8815. (void)(content_length);
  8816. return std::make_pair(static_cast<size_t>(r.first),
  8817. static_cast<size_t>(r.second - r.first) + 1);
  8818. }
  8819. inline std::string make_content_range_header_field(
  8820. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8821. auto st = offset_and_length.first;
  8822. auto ed = st + offset_and_length.second - 1;
  8823. std::string field = "bytes ";
  8824. field += std::to_string(st);
  8825. field += '-';
  8826. field += std::to_string(ed);
  8827. field += '/';
  8828. field += std::to_string(content_length);
  8829. return field;
  8830. }
  8831. template <typename SToken, typename CToken, typename Content>
  8832. bool process_multipart_ranges_data(const Request &req,
  8833. const std::string &boundary,
  8834. const std::string &content_type,
  8835. size_t content_length, SToken stoken,
  8836. CToken ctoken, Content content) {
  8837. for (size_t i = 0; i < req.ranges.size(); i++) {
  8838. ctoken("--");
  8839. stoken(boundary);
  8840. ctoken("\r\n");
  8841. if (!content_type.empty()) {
  8842. ctoken("Content-Type: ");
  8843. stoken(content_type);
  8844. ctoken("\r\n");
  8845. }
  8846. auto offset_and_length =
  8847. get_range_offset_and_length(req.ranges[i], content_length);
  8848. ctoken("Content-Range: ");
  8849. stoken(make_content_range_header_field(offset_and_length, content_length));
  8850. ctoken("\r\n");
  8851. ctoken("\r\n");
  8852. if (!content(offset_and_length.first, offset_and_length.second)) {
  8853. return false;
  8854. }
  8855. ctoken("\r\n");
  8856. }
  8857. ctoken("--");
  8858. stoken(boundary);
  8859. ctoken("--");
  8860. return true;
  8861. }
  8862. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8863. const std::string &boundary,
  8864. const std::string &content_type,
  8865. size_t content_length,
  8866. std::string &data) {
  8867. process_multipart_ranges_data(
  8868. req, boundary, content_type, content_length,
  8869. [&](const std::string &token) { data += token; },
  8870. [&](const std::string &token) { data += token; },
  8871. [&](size_t offset, size_t length) {
  8872. assert(offset + length <= content_length);
  8873. data += res.body.substr(offset, length);
  8874. return true;
  8875. });
  8876. }
  8877. inline size_t get_multipart_ranges_data_length(const Request &req,
  8878. const std::string &boundary,
  8879. const std::string &content_type,
  8880. size_t content_length) {
  8881. size_t data_length = 0;
  8882. process_multipart_ranges_data(
  8883. req, boundary, content_type, content_length,
  8884. [&](const std::string &token) { data_length += token.size(); },
  8885. [&](const std::string &token) { data_length += token.size(); },
  8886. [&](size_t /*offset*/, size_t length) {
  8887. data_length += length;
  8888. return true;
  8889. });
  8890. return data_length;
  8891. }
  8892. template <typename T>
  8893. inline bool
  8894. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8895. const std::string &boundary,
  8896. const std::string &content_type,
  8897. size_t content_length, const T &is_shutting_down) {
  8898. return process_multipart_ranges_data(
  8899. req, boundary, content_type, content_length,
  8900. [&](const std::string &token) { strm.write(token); },
  8901. [&](const std::string &token) { strm.write(token); },
  8902. [&](size_t offset, size_t length) {
  8903. return write_content(strm, res.content_provider_, offset, length,
  8904. is_shutting_down);
  8905. });
  8906. }
  8907. inline bool has_framed_body(const Request &req) {
  8908. return is_chunked_transfer_encoding(req.headers) ||
  8909. req.get_header_value_u64("Content-Length") > 0;
  8910. }
  8911. inline bool expect_content(const Request &req) {
  8912. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8913. req.method == "DELETE") {
  8914. return true;
  8915. }
  8916. return has_framed_body(req);
  8917. }
  8918. #ifdef _WIN32
  8919. class WSInit {
  8920. public:
  8921. WSInit() {
  8922. WSADATA wsaData;
  8923. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8924. }
  8925. ~WSInit() {
  8926. if (is_valid_) WSACleanup();
  8927. }
  8928. bool is_valid_ = false;
  8929. };
  8930. static WSInit wsinit_;
  8931. #endif
  8932. inline std::string unescape_quoted_pairs(const std::string &s) {
  8933. std::string out;
  8934. out.reserve(s.size());
  8935. for (size_t i = 0; i < s.size(); i++) {
  8936. if (s[i] == '\\' && i + 1 < s.size()) {
  8937. out += s[++i];
  8938. } else {
  8939. out += s[i];
  8940. }
  8941. }
  8942. return out;
  8943. }
  8944. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8945. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8946. // quoted-pair, so the recipient recovers the original value.
  8947. inline std::string escape_quoted_pairs(const std::string &s) {
  8948. std::string out;
  8949. out.reserve(s.size());
  8950. for (auto c : s) {
  8951. if (c == '\\' || c == '"') { out += '\\'; }
  8952. out += c;
  8953. }
  8954. return out;
  8955. }
  8956. // RFC 9110 Section 11.6.1 defines a challenge list as
  8957. // WWW-Authenticate = #challenge
  8958. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8959. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8960. // so a server may offer several schemes, each with its own comma-separated
  8961. // auth-param list, in either order and either as separate field lines or
  8962. // packed into one. Splitting on every comma would break apart a challenge's
  8963. // own param list; splitting only on the first space would miss a Digest
  8964. // challenge that isn't first. Split on commas that aren't inside a
  8965. // quoted-string instead (split_unquoted), then track which scheme each
  8966. // resulting segment belongs to: a segment whose text before "=" contains
  8967. // whitespace (or that has no "=" at all) starts a new challenge named by its
  8968. // leading token.
  8969. inline bool parse_www_authenticate(const Response &res,
  8970. std::map<std::string, std::string> &auth,
  8971. bool is_proxy) {
  8972. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8973. auto combined = get_combined_header_value(res.headers, auth_key);
  8974. if (combined.empty()) { return false; }
  8975. auto found_digest = false;
  8976. auto in_digest_challenge = false;
  8977. split_unquoted(
  8978. combined.data(), combined.data() + combined.size(), ',',
  8979. [&](const char *b, const char *e) {
  8980. std::string segment(b, e);
  8981. auto eq_pos = segment.find('=');
  8982. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8983. // for the first segment of a challenge, "<scheme> <key>") must be
  8984. // trimmed before its boundaries are inspected.
  8985. auto key_part = trim_copy(
  8986. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8987. auto space_pos = key_part.find_last_of(" \t");
  8988. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8989. // "<scheme>[ <key>]" starts a new challenge.
  8990. auto scheme_end =
  8991. space_pos == std::string::npos ? key_part.size() : space_pos;
  8992. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8993. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8994. // from one challenge is never paired with another's algorithm.
  8995. in_digest_challenge =
  8996. !found_digest &&
  8997. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8998. if (in_digest_challenge) { found_digest = true; }
  8999. if (space_pos == std::string::npos) {
  9000. // Bare scheme (or a token68), no auth-param on this segment.
  9001. return;
  9002. }
  9003. key_part = key_part.substr(space_pos + 1);
  9004. }
  9005. if (!in_digest_challenge) { return; }
  9006. auto val = trim_copy(segment.substr(eq_pos + 1));
  9007. auto unquoted = trim_double_quotes_copy(val);
  9008. if (unquoted.size() != val.size()) {
  9009. unquoted = unescape_quoted_pairs(unquoted);
  9010. }
  9011. auth[std::move(key_part)] = std::move(unquoted);
  9012. });
  9013. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  9014. // make_digest_authentication_header() dereferences both unconditionally, so
  9015. // a challenge missing either can't produce a usable Authorization header.
  9016. // Treat it the same as no Digest challenge at all.
  9017. return found_digest && auth.find("realm") != auth.end() &&
  9018. auth.find("nonce") != auth.end();
  9019. }
  9020. class ContentProviderAdapter {
  9021. public:
  9022. explicit ContentProviderAdapter(
  9023. ContentProviderWithoutLength &&content_provider)
  9024. : content_provider_(std::move(content_provider)) {}
  9025. bool operator()(size_t offset, size_t, DataSink &sink) {
  9026. return content_provider_(offset, sink);
  9027. }
  9028. private:
  9029. ContentProviderWithoutLength content_provider_;
  9030. };
  9031. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  9032. namespace fields {
  9033. inline bool is_token_char(char c) {
  9034. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  9035. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  9036. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  9037. }
  9038. inline bool is_token(const std::string &s) {
  9039. if (s.empty()) { return false; }
  9040. for (auto c : s) {
  9041. if (!is_token_char(c)) { return false; }
  9042. }
  9043. return true;
  9044. }
  9045. inline bool is_field_name(const std::string &s) { return is_token(s); }
  9046. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  9047. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  9048. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  9049. inline bool is_field_content(const std::string &s) {
  9050. if (s.empty()) { return true; }
  9051. if (s.size() == 1) {
  9052. return is_field_vchar(s[0]);
  9053. } else if (s.size() == 2) {
  9054. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  9055. } else {
  9056. size_t i = 0;
  9057. if (!is_field_vchar(s[i])) { return false; }
  9058. i++;
  9059. while (i < s.size() - 1) {
  9060. auto c = s[i++];
  9061. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  9062. } else {
  9063. return false;
  9064. }
  9065. }
  9066. return is_field_vchar(s[i]);
  9067. }
  9068. }
  9069. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  9070. inline bool is_field_valid(const std::string &name, const std::string &value) {
  9071. return is_field_name(name) && is_field_value(value);
  9072. }
  9073. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  9074. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  9075. inline bool is_request_target(const std::string &s) {
  9076. return std::all_of(s.begin(), s.end(), is_field_vchar);
  9077. }
  9078. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  9079. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  9080. inline bool is_host(const std::string &s) {
  9081. return std::all_of(s.begin(), s.end(), [](char c) {
  9082. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  9083. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9084. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9085. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  9086. });
  9087. }
  9088. } // namespace fields
  9089. // Built in memory first, like ClientImpl::write_request, so a rejected header
  9090. // never leaves a partial request on the wire.
  9091. inline bool write_request_head(Stream &strm, Request &req, Error &error) {
  9092. BufferStream bstrm;
  9093. if (write_request_line(bstrm, req.method, req.path) < 0) {
  9094. error = Error::Write;
  9095. return false;
  9096. }
  9097. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  9098. return false;
  9099. }
  9100. const auto &data = bstrm.get_buffer();
  9101. if (!write_data(strm, data.data(), data.size())) {
  9102. error = Error::Write;
  9103. return false;
  9104. }
  9105. return true;
  9106. }
  9107. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  9108. WebSocketUpgradeResponse &upgrade) {
  9109. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  9110. std::string key_bytes(16, '\0');
  9111. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  9112. key_bytes.size());
  9113. auto client_key = base64_encode(key_bytes);
  9114. req.headers.erase("Upgrade");
  9115. req.headers.erase("Connection");
  9116. req.headers.erase("Sec-WebSocket-Key");
  9117. req.headers.erase("Sec-WebSocket-Version");
  9118. req.headers.emplace("Upgrade", "websocket");
  9119. req.headers.emplace("Connection", "Upgrade");
  9120. req.headers.emplace("Sec-WebSocket-Key", client_key);
  9121. req.headers.emplace("Sec-WebSocket-Version", "13");
  9122. if (!write_request_head(strm, req, upgrade.error)) { return false; }
  9123. // Verify 101 response and Sec-WebSocket-Accept header
  9124. auto expected_accept = websocket_accept_key(client_key);
  9125. auto offered_subprotocols =
  9126. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  9127. return read_websocket_upgrade_response(strm, expected_accept,
  9128. offered_subprotocols, upgrade);
  9129. }
  9130. inline bool is_ip_address(const std::string &host) {
  9131. struct in_addr addr4;
  9132. struct in6_addr addr6;
  9133. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  9134. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  9135. }
  9136. // One spelling for an IPv6 address, and the IPv4 one for an IPv4-mapped IPv6
  9137. // address, which is how a dual-stack socket reports an IPv4 peer. Anything
  9138. // else, including an address with a zone ID, is returned as it is.
  9139. inline std::string canonical_ip(const std::string &addr) {
  9140. struct in6_addr addr6;
  9141. if (addr.find('%') != std::string::npos ||
  9142. inet_pton(AF_INET6, addr.c_str(), &addr6) != 1) {
  9143. return addr;
  9144. }
  9145. char buf[INET6_ADDRSTRLEN];
  9146. if (IN6_IS_ADDR_V4MAPPED(&addr6)) {
  9147. return inet_ntop(AF_INET, &addr6.s6_addr[12], buf, sizeof(buf)) ? buf
  9148. : addr;
  9149. }
  9150. return inet_ntop(AF_INET6, &addr6, buf, sizeof(buf)) ? buf : addr;
  9151. }
  9152. // `trusted_proxies` holds canonical_ip() spellings.
  9153. inline bool is_trusted_proxy(const std::string &addr,
  9154. const std::vector<std::string> &trusted_proxies) {
  9155. if (trusted_proxies.empty()) { return false; }
  9156. return std::find(trusted_proxies.begin(), trusted_proxies.end(),
  9157. canonical_ip(addr)) != trusted_proxies.end();
  9158. }
  9159. // Resolve where a client should connect for `host`, honoring a user-supplied
  9160. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  9161. // supplying the Host header and SNI; only the connection target changes.
  9162. //
  9163. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  9164. // path. Anything else goes to `connect_host`, which create_socket resolves as
  9165. // a name, or uses as the socket path when the address family is AF_UNIX. An
  9166. // absent or empty mapping leaves `host` as the connection target; without the
  9167. // empty check the value would reach getaddrinfo as a null node and silently
  9168. // resolve to loopback.
  9169. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  9170. const std::string &host, std::string &connect_host,
  9171. std::string &ip) {
  9172. connect_host = host;
  9173. ip.clear();
  9174. auto it = addr_map.find(host);
  9175. if (it == addr_map.end() || it->second.empty()) { return; }
  9176. if (is_ip_address(it->second)) {
  9177. ip = it->second;
  9178. } else {
  9179. connect_host = it->second;
  9180. }
  9181. }
  9182. } // namespace detail
  9183. /*
  9184. * Group 2: detail namespace - SSL common utilities
  9185. */
  9186. #ifdef CPPHTTPLIB_SSL_ENABLED
  9187. namespace detail {
  9188. class SSLSocketStream final : public Stream {
  9189. public:
  9190. SSLSocketStream(
  9191. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  9192. time_t read_timeout_usec, time_t write_timeout_sec,
  9193. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  9194. std::chrono::time_point<std::chrono::steady_clock> start_time =
  9195. (std::chrono::steady_clock::time_point::min)());
  9196. ~SSLSocketStream() override;
  9197. bool is_readable() const override;
  9198. bool wait_readable() const override;
  9199. bool wait_writable() const override;
  9200. bool is_peer_alive() const override;
  9201. ssize_t read(char *ptr, size_t size) override;
  9202. ssize_t write(const char *ptr, size_t size) override;
  9203. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9204. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9205. socket_t socket() const override;
  9206. time_t duration() const override;
  9207. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9208. void set_max_timeout(time_t msec) override;
  9209. void set_read_interrupt(std::function<bool()> interrupted) override;
  9210. // See SocketStream::set_readable_hint().
  9211. void set_readable_hint() { readable_hint_ = true; }
  9212. // The error from the last read() or write() that failed in the TLS layer,
  9213. // with code Success if none did
  9214. const tls::TlsError &tls_error() const { return tls_error_; }
  9215. private:
  9216. bool ensure_readable();
  9217. socket_t sock_;
  9218. tls::session_t session_;
  9219. time_t read_timeout_sec_;
  9220. time_t read_timeout_usec_;
  9221. time_t write_timeout_sec_;
  9222. time_t write_timeout_usec_;
  9223. time_t max_timeout_msec_;
  9224. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9225. std::function<bool()> read_interrupted_;
  9226. bool readable_hint_ = false;
  9227. tls::TlsError tls_error_;
  9228. };
  9229. // A TLS stream for WebSocket connections, where the receive path and the
  9230. // send path (application send() plus the heartbeat ping thread) run on
  9231. // different threads. A single TLS session must never be entered
  9232. // concurrently, so every call into the session is serialized by one mutex.
  9233. //
  9234. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  9235. // whole lifetime and each read()/write() performs a single non-blocking TLS
  9236. // call under the lock, then waits for readiness with select() outside the
  9237. // lock. The lock is therefore held only for CPU-bound work, so a reader
  9238. // blocked waiting for data never stalls a concurrent sender.
  9239. //
  9240. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  9241. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  9242. class WebSocketSSLStream final : public Stream {
  9243. public:
  9244. WebSocketSSLStream(socket_t sock, tls::session_t session,
  9245. time_t read_timeout_sec, time_t read_timeout_usec,
  9246. time_t write_timeout_sec, time_t write_timeout_usec);
  9247. ~WebSocketSSLStream() override;
  9248. bool is_readable() const override;
  9249. bool wait_readable() const override;
  9250. bool wait_writable() const override;
  9251. ssize_t read(char *ptr, size_t size) override;
  9252. ssize_t write(const char *ptr, size_t size) override;
  9253. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9254. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9255. socket_t socket() const override;
  9256. time_t duration() const override;
  9257. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9258. void set_max_timeout(time_t msec) override;
  9259. void set_read_interrupt(std::function<bool()> interrupted) override;
  9260. private:
  9261. mutable std::mutex session_mutex_;
  9262. socket_t sock_;
  9263. tls::session_t session_;
  9264. // May change while another thread is in wait_readable(); write timeouts don't
  9265. std::atomic<time_t> read_timeout_sec_;
  9266. std::atomic<time_t> read_timeout_usec_;
  9267. time_t write_timeout_sec_;
  9268. time_t write_timeout_usec_;
  9269. std::atomic<time_t> max_timeout_msec_{0};
  9270. std::atomic<std::chrono::steady_clock::rep> start_time_;
  9271. std::function<bool()> read_interrupted_;
  9272. };
  9273. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9274. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9275. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9276. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9277. unsigned int hash_length = 0;
  9278. unsigned char hash[EVP_MAX_MD_SIZE];
  9279. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9280. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9281. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9282. std::stringstream ss;
  9283. for (auto i = 0u; i < hash_length; ++i) {
  9284. ss << std::hex << std::setw(2) << std::setfill('0')
  9285. << static_cast<unsigned int>(hash[i]);
  9286. }
  9287. return ss.str();
  9288. }
  9289. inline std::string MD5(const std::string &s) {
  9290. return message_digest(s, EVP_md5());
  9291. }
  9292. inline std::string SHA_256(const std::string &s) {
  9293. return message_digest(s, EVP_sha256());
  9294. }
  9295. inline std::string SHA_512(const std::string &s) {
  9296. return message_digest(s, EVP_sha512());
  9297. }
  9298. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9299. namespace {
  9300. template <size_t N>
  9301. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9302. std::stringstream ss;
  9303. for (size_t i = 0; i < N; ++i) {
  9304. ss << std::hex << std::setw(2) << std::setfill('0')
  9305. << static_cast<unsigned int>(hash[i]);
  9306. }
  9307. return ss.str();
  9308. }
  9309. } // namespace
  9310. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9311. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9312. // initialized once. PSA state is process-global; do not free it.
  9313. inline bool ensure_mbedtls_psa_crypto() {
  9314. static std::once_flag once;
  9315. static bool ok = false;
  9316. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9317. return ok;
  9318. }
  9319. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9320. unsigned char *out, size_t out_size) {
  9321. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9322. size_t olen = 0;
  9323. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9324. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9325. olen == out_size;
  9326. }
  9327. #endif
  9328. inline std::string MD5(const std::string &s) {
  9329. unsigned char hash[16];
  9330. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9331. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9332. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9333. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9334. hash);
  9335. #else
  9336. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9337. hash);
  9338. #endif
  9339. return hash_to_hex(hash);
  9340. }
  9341. inline std::string SHA_256(const std::string &s) {
  9342. unsigned char hash[32];
  9343. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9344. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9345. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9346. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9347. hash, 0);
  9348. #else
  9349. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9350. s.size(), hash, 0);
  9351. #endif
  9352. return hash_to_hex(hash);
  9353. }
  9354. inline std::string SHA_512(const std::string &s) {
  9355. unsigned char hash[64];
  9356. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9357. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9358. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9359. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9360. hash, 0);
  9361. #else
  9362. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9363. s.size(), hash, 0);
  9364. #endif
  9365. return hash_to_hex(hash);
  9366. }
  9367. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9368. namespace {
  9369. template <size_t N>
  9370. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9371. std::stringstream ss;
  9372. for (size_t i = 0; i < N; ++i) {
  9373. ss << std::hex << std::setw(2) << std::setfill('0')
  9374. << static_cast<unsigned int>(hash[i]);
  9375. }
  9376. return ss.str();
  9377. }
  9378. } // namespace
  9379. inline std::string MD5(const std::string &s) {
  9380. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9381. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9382. static_cast<word32>(s.size()), hash);
  9383. return hash_to_hex(hash);
  9384. }
  9385. inline std::string SHA_256(const std::string &s) {
  9386. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9387. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9388. static_cast<word32>(s.size()), hash);
  9389. return hash_to_hex(hash);
  9390. }
  9391. inline std::string SHA_512(const std::string &s) {
  9392. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9393. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9394. static_cast<word32>(s.size()), hash);
  9395. return hash_to_hex(hash);
  9396. }
  9397. #endif
  9398. template <typename T>
  9399. inline bool process_server_socket_ssl(
  9400. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9401. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9402. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9403. time_t write_timeout_usec, T callback) {
  9404. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9405. // of a pipelined request, which keep_alive() cannot see on the socket.
  9406. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9407. write_timeout_sec, write_timeout_usec);
  9408. return process_server_socket_core(
  9409. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9410. [&]() { return strm.is_readable(); },
  9411. [&](bool socket_readable, bool close_connection,
  9412. bool &connection_closed) {
  9413. if (socket_readable) { strm.set_readable_hint(); }
  9414. return callback(strm, close_connection, connection_closed);
  9415. });
  9416. }
  9417. template <typename T>
  9418. inline bool process_client_socket_ssl(
  9419. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9420. time_t read_timeout_usec, time_t write_timeout_sec,
  9421. time_t write_timeout_usec, time_t max_timeout_msec,
  9422. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9423. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9424. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9425. start_time);
  9426. return callback(strm);
  9427. }
  9428. // `uri` is req's request-target in origin form, as curl sends it, also when
  9429. // the request line carries the absolute form for a proxy.
  9430. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9431. const Request &req, const std::string &uri,
  9432. const std::map<std::string, std::string> &auth, size_t cnonce_count,
  9433. const std::string &cnonce, const std::string &username,
  9434. const std::string &password, bool is_proxy = false) {
  9435. std::string nc;
  9436. {
  9437. std::stringstream ss;
  9438. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9439. nc = ss.str();
  9440. }
  9441. std::string qop;
  9442. if (auth.find("qop") != auth.end()) {
  9443. qop = auth.at("qop");
  9444. if (qop.find("auth-int") != std::string::npos) {
  9445. qop = "auth-int";
  9446. } else if (qop.find("auth") != std::string::npos) {
  9447. qop = "auth";
  9448. } else {
  9449. qop.clear();
  9450. }
  9451. }
  9452. std::string algo = "MD5";
  9453. if (auth.find("algorithm") != auth.end()) {
  9454. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9455. // not a token would otherwise be emitted verbatim and could carry commas
  9456. // or quotes that inject further auth-params into the header below.
  9457. const auto &a = auth.at("algorithm");
  9458. if (fields::is_token(a)) { algo = a; }
  9459. }
  9460. std::string response;
  9461. {
  9462. auto H = algo == "SHA-256" ? detail::SHA_256
  9463. : algo == "SHA-512" ? detail::SHA_512
  9464. : detail::MD5;
  9465. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9466. auto A2 = req.method + ":" + uri;
  9467. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9468. if (qop.empty()) {
  9469. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9470. } else {
  9471. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9472. ":" + qop + ":" + H(A2));
  9473. }
  9474. }
  9475. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9476. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9477. // close the string early. realm, nonce and opaque come straight from the
  9478. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9479. // without this a crafted challenge injects extra auth-params into the header.
  9480. auto field =
  9481. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9482. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9483. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9484. "\", uri=\"" + detail::escape_quoted_pairs(uri) +
  9485. "\", algorithm=" + algo +
  9486. (qop.empty() ? ", response=\""
  9487. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9488. "\", response=\"") +
  9489. response + "\"" +
  9490. (opaque.empty()
  9491. ? ""
  9492. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9493. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9494. return std::make_pair(key, field);
  9495. }
  9496. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9497. // backend accepts the same names.
  9498. inline bool match_hostname(const std::string &pattern,
  9499. const std::string &hostname) {
  9500. // A trailing dot on the host is ignored
  9501. auto host = hostname;
  9502. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9503. // Exact match (case-insensitive)
  9504. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9505. // Split both pattern and hostname into components by '.', keeping any empty
  9506. // one, which no name may have
  9507. auto labels = [](const std::string &s) {
  9508. std::vector<std::string> v;
  9509. size_t b = 0;
  9510. while (true) {
  9511. auto e = s.find('.', b);
  9512. v.push_back(s.substr(b, e - b));
  9513. if (e == std::string::npos) { return v; }
  9514. b = e + 1;
  9515. }
  9516. };
  9517. auto pattern_components = labels(pattern);
  9518. auto host_components = labels(host);
  9519. auto has_empty_label = [](const std::vector<std::string> &v) {
  9520. return std::any_of(v.begin(), v.end(),
  9521. [](const std::string &l) { return l.empty(); });
  9522. };
  9523. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9524. return false;
  9525. }
  9526. // Component count must match
  9527. if (host_components.size() != pattern_components.size()) { return false; }
  9528. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9529. // and an IDNA label may not have one
  9530. const auto &leftmost = pattern_components.front();
  9531. if (leftmost.find('*') != std::string::npos &&
  9532. (pattern_components.size() < 3 ||
  9533. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9534. return false;
  9535. }
  9536. // Compare each component with wildcard support
  9537. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9538. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9539. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9540. auto itr = pattern_components.begin();
  9541. for (const auto &h : host_components) {
  9542. auto &p = *itr;
  9543. auto is_leftmost = itr == pattern_components.begin();
  9544. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9545. bool partial_match = false;
  9546. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9547. const auto prefix_length = p.size() - 1;
  9548. if (prefix_length == 0) {
  9549. partial_match = true;
  9550. } else if (h.size() >= prefix_length) {
  9551. partial_match =
  9552. std::equal(p.begin(),
  9553. p.begin() + static_cast<std::string::difference_type>(
  9554. prefix_length),
  9555. h.begin(), [](const char ca, const char cb) {
  9556. return detail::case_ignore::to_lower(ca) ==
  9557. detail::case_ignore::to_lower(cb);
  9558. });
  9559. }
  9560. }
  9561. if (!partial_match) { return false; }
  9562. }
  9563. ++itr;
  9564. }
  9565. return true;
  9566. }
  9567. #ifdef _WIN32
  9568. // Verify certificate using Windows CertGetCertificateChain API.
  9569. // This provides real-time certificate validation with Windows Update
  9570. // integration, independent of the TLS backend.
  9571. inline bool verify_cert_with_windows_schannel(
  9572. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9573. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9574. if (der_cert.empty()) { return false; }
  9575. out_error = 0;
  9576. // Create Windows certificate context from DER data
  9577. auto cert_context = CertCreateCertificateContext(
  9578. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9579. static_cast<DWORD>(der_cert.size()));
  9580. if (!cert_context) {
  9581. out_error = GetLastError();
  9582. return false;
  9583. }
  9584. auto cert_guard =
  9585. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9586. // Give CryptoAPI the certificates the server sent. Without them it follows
  9587. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9588. std::vector<tls::cert_t> peer_certs;
  9589. tls::get_peer_certs(session, peer_certs);
  9590. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9591. auto store_guard = scope_exit([&] {
  9592. for (auto cert : peer_certs) {
  9593. tls::free_cert(cert);
  9594. }
  9595. if (store) { CertCloseStore(store, 0); }
  9596. });
  9597. for (auto cert : peer_certs) {
  9598. std::vector<unsigned char> der;
  9599. if (store && tls::get_cert_der(cert, der)) {
  9600. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9601. static_cast<DWORD>(der.size()),
  9602. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9603. }
  9604. }
  9605. // Setup chain parameters
  9606. CERT_CHAIN_PARA chain_para = {};
  9607. chain_para.cbSize = sizeof(chain_para);
  9608. // Require the server authentication usage along the chain, which also
  9609. // rejects roots that Windows trusts only for other purposes.
  9610. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9611. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9612. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9613. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9614. // Build certificate chain with revocation checking
  9615. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9616. auto chain_result = CertGetCertificateChain(
  9617. nullptr, cert_context, nullptr, store, &chain_para,
  9618. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9619. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9620. nullptr, &chain_context);
  9621. if (!chain_result || !chain_context) {
  9622. out_error = GetLastError();
  9623. return false;
  9624. }
  9625. auto chain_guard =
  9626. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9627. // Verify SSL policy
  9628. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9629. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9630. #ifdef AUTHTYPE_SERVER
  9631. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9632. #endif
  9633. std::wstring whost;
  9634. if (verify_hostname) {
  9635. whost = u8string_to_wstring(hostname.c_str());
  9636. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9637. }
  9638. CERT_CHAIN_POLICY_PARA policy_para = {};
  9639. policy_para.cbSize = sizeof(policy_para);
  9640. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9641. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9642. #else
  9643. policy_para.dwFlags = 0;
  9644. #endif
  9645. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9646. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9647. policy_status.cbSize = sizeof(policy_status);
  9648. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9649. &policy_para, &policy_status)) {
  9650. out_error = GetLastError();
  9651. return false;
  9652. }
  9653. if (policy_status.dwError != 0) {
  9654. out_error = policy_status.dwError;
  9655. return false;
  9656. }
  9657. return true;
  9658. }
  9659. #endif // _WIN32
  9660. // Loads CA file/dir configuration and applies the system CA policy to a
  9661. // client TLS context. PEM data and native stores are applied to the context
  9662. // directly at set time; has_custom_store reflects them for the Auto policy
  9663. // decision.
  9664. inline bool load_client_ca_config(tls::ctx_t ctx,
  9665. const std::string &ca_cert_file_path,
  9666. const std::string &ca_cert_dir_path,
  9667. bool has_custom_store, SystemCAMode mode,
  9668. uint64_t &backend_error) {
  9669. auto ret = true;
  9670. if (!ca_cert_file_path.empty()) {
  9671. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9672. backend_error = tls::get_error();
  9673. ret = false;
  9674. }
  9675. } else if (!ca_cert_dir_path.empty()) {
  9676. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9677. backend_error = tls::get_error();
  9678. ret = false;
  9679. }
  9680. }
  9681. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9682. !ca_cert_dir_path.empty() || has_custom_store;
  9683. if (mode == SystemCAMode::Enabled ||
  9684. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9685. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9686. }
  9687. return ret;
  9688. }
  9689. // Serializes the CA certificates installed in ctx as PEM, so they can be
  9690. // loaded into another context.
  9691. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9692. std::string pem;
  9693. std::vector<tls::cert_t> certs;
  9694. tls::get_ca_certs(ctx, certs);
  9695. for (auto cert : certs) {
  9696. std::vector<unsigned char> der;
  9697. if (tls::get_cert_der(cert, der)) {
  9698. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9699. pem += "-----BEGIN CERTIFICATE-----\n";
  9700. for (size_t i = 0; i < b64.size(); i += 64) {
  9701. pem += b64.substr(i, 64);
  9702. pem += '\n';
  9703. }
  9704. pem += "-----END CERTIFICATE-----\n";
  9705. }
  9706. tls::free_cert(cert);
  9707. }
  9708. return pem;
  9709. }
  9710. // Returns a PemMemory field as a NUL-terminated string: its first len bytes,
  9711. // copied to buf, or pem itself when len is 0.
  9712. inline const char *pem_c_str(const char *pem, size_t len, std::string &buf) {
  9713. if (!pem || len == 0) { return pem; }
  9714. buf.assign(pem, len);
  9715. return buf.c_str();
  9716. }
  9717. // The parts of session setup that only SSLClient needs, plus the handful
  9718. // WebSocketClient also exposes; everything else takes the defaults, which is
  9719. // what keeps the two clients on one implementation.
  9720. struct ClientTlsSessionOptions {
  9721. // Both SSLClient and WebSocketClient expose this independently of
  9722. // certificate verification.
  9723. bool server_hostname_verification = true;
  9724. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9725. // When set, ends the handshake as a timeout does once it returns true
  9726. std::function<bool()> interrupted;
  9727. // When non-null, guards session creation against concurrent use of the
  9728. // context. A WebSocketClient is not safe to use from several threads to
  9729. // begin with, so it passes nothing.
  9730. std::mutex *ctx_mutex = nullptr;
  9731. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9732. // The caller decides whether Schannel has anything to say about this
  9733. // connection; see SSLClient::initialize_ssl().
  9734. bool windows_cert_verification = false;
  9735. // A server certificate verifier works on the backend's chain verification,
  9736. // so the backend keeps deciding and Schannel only adds its own check.
  9737. bool server_certificate_verifier_set = false;
  9738. #endif
  9739. };
  9740. // Filled in on failure for callers that report error details.
  9741. struct ClientTlsSessionError {
  9742. Error error = Error::Success;
  9743. int ssl_error = 0;
  9744. uint64_t backend_error = 0;
  9745. };
  9746. // Establishes a client TLS session on an already connected socket. On failure
  9747. // the session is left for the caller to free: SSLClient frees it right away,
  9748. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9749. inline bool setup_client_tls_session(
  9750. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9751. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9752. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9753. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9754. using namespace tls;
  9755. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9756. if (out_error) {
  9757. out_error->error = error;
  9758. out_error->ssl_error = ssl_error;
  9759. out_error->backend_error = backend_error;
  9760. }
  9761. return false;
  9762. };
  9763. // A TLS failure, whose verification codes name the Error too
  9764. auto fail_tls = [&](ErrorCode code, uint64_t backend_error) {
  9765. auto error = Error::SSLConnection;
  9766. if (code == ErrorCode::CertVerifyFailed) {
  9767. error = Error::SSLServerVerification;
  9768. } else if (code == ErrorCode::HostnameMismatch) {
  9769. error = Error::SSLServerHostnameVerification;
  9770. }
  9771. return fail(error, static_cast<int>(code), backend_error);
  9772. };
  9773. if (!ctx) {
  9774. session = nullptr;
  9775. return fail(Error::SSLConnection, 0, 0);
  9776. }
  9777. // With Windows verification on and no server certificate verifier set,
  9778. // Schannel is the only chain verifier. The backend's trust store is a
  9779. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9780. // demand, so the backend's verdict is not used.
  9781. auto windows_verifies_chain = false;
  9782. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9783. windows_verifies_chain = options.windows_cert_verification &&
  9784. !options.server_certificate_verifier_set;
  9785. #endif
  9786. // The chain, and a host name, are verified during the handshake, so that a
  9787. // server failing them never gets to see a client certificate. Unless
  9788. // Schannel verifies the chain instead, this holds for IP hosts too, whose
  9789. // identity is checked after the handshake by verify_hostname().
  9790. auto verify_in_handshake =
  9791. server_certificate_verification && !windows_verifies_chain;
  9792. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9793. // A session verifier may accept a certificate the built-in check rejects,
  9794. // and runs only after the handshake
  9795. verify_in_handshake = verify_in_handshake && !options.session_verifier;
  9796. #endif
  9797. {
  9798. std::unique_lock<std::mutex> guard;
  9799. if (options.ctx_mutex) {
  9800. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9801. }
  9802. // The mode is set on the context, so under the same lock
  9803. set_verify_client(ctx, verify_in_handshake);
  9804. session = create_session(ctx, sock);
  9805. }
  9806. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9807. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9808. // their identity is checked post-handshake below instead.
  9809. if (!is_ip_address(host)) {
  9810. if (!set_sni(session, host.c_str(),
  9811. verify_in_handshake && options.server_hostname_verification)) {
  9812. return fail(Error::SSLConnection, 0, get_error());
  9813. }
  9814. }
  9815. TlsError tls_err;
  9816. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec, &tls_err,
  9817. options.interrupted)) {
  9818. return fail_tls(tls_err.code, tls_err.backend_code);
  9819. }
  9820. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9821. if (options.session_verifier) {
  9822. verification_status = options.session_verifier(session);
  9823. }
  9824. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9825. return fail(Error::SSLServerVerification, 0, get_error());
  9826. }
  9827. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9828. server_certificate_verification) {
  9829. if (!windows_verifies_chain) {
  9830. auto verify_result = get_verify_result(session);
  9831. if (verify_result != 0) {
  9832. return fail_tls(ErrorCode::CertVerifyFailed,
  9833. static_cast<uint64_t>(verify_result));
  9834. }
  9835. }
  9836. auto server_cert = get_peer_cert(session);
  9837. if (!server_cert) {
  9838. return fail_tls(ErrorCode::CertVerifyFailed, get_error());
  9839. }
  9840. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9841. // Identity check against the peer certificate, post-handshake for all
  9842. // backends. For IP hosts this is the only identity verification, since no
  9843. // hostname is bound during the handshake.
  9844. if (options.server_hostname_verification) {
  9845. if (!verify_hostname(server_cert, host.c_str())) {
  9846. return fail_tls(ErrorCode::HostnameMismatch, hostname_mismatch_code());
  9847. }
  9848. }
  9849. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9850. // Windows Schannel verification, which lets Windows fetch missing roots
  9851. // and intermediates on demand. It must not be skipped: unless a server
  9852. // certificate verifier is set, it is the only chain check.
  9853. if (options.windows_cert_verification) {
  9854. std::vector<unsigned char> der;
  9855. uint64_t wincrypt_error = 0;
  9856. if (!get_cert_der(server_cert, der) ||
  9857. !verify_cert_with_windows_schannel(
  9858. der, host, options.server_hostname_verification, wincrypt_error,
  9859. session)) {
  9860. return fail_tls(ErrorCode::CertVerifyFailed, wincrypt_error);
  9861. }
  9862. }
  9863. #endif
  9864. }
  9865. return true;
  9866. }
  9867. } // namespace detail
  9868. #endif // CPPHTTPLIB_SSL_ENABLED
  9869. /*
  9870. * Group 3: httplib namespace - Non-SSL public API implementations
  9871. */
  9872. inline void default_socket_options(socket_t sock) {
  9873. set_socket_opt(sock, SOL_SOCKET,
  9874. #ifdef SO_REUSEPORT
  9875. SO_REUSEPORT,
  9876. #else
  9877. SO_REUSEADDR,
  9878. #endif
  9879. 1);
  9880. }
  9881. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9882. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9883. sizeof(optval));
  9884. }
  9885. inline std::string get_bearer_token_auth(const Request &req) {
  9886. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9887. // than the prefix carries no token.
  9888. constexpr const char bearer_prefix[] = "Bearer ";
  9889. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9890. auto value = req.get_header_value("Authorization");
  9891. if (value.size() >= bearer_prefix_len &&
  9892. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9893. bearer_prefix)) {
  9894. return value.substr(bearer_prefix_len);
  9895. }
  9896. return "";
  9897. }
  9898. inline const char *status_message(int status) {
  9899. switch (status) {
  9900. case StatusCode::Continue_100: return "Continue";
  9901. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9902. case StatusCode::Processing_102: return "Processing";
  9903. case StatusCode::EarlyHints_103: return "Early Hints";
  9904. case StatusCode::OK_200: return "OK";
  9905. case StatusCode::Created_201: return "Created";
  9906. case StatusCode::Accepted_202: return "Accepted";
  9907. case StatusCode::NonAuthoritativeInformation_203:
  9908. return "Non-Authoritative Information";
  9909. case StatusCode::NoContent_204: return "No Content";
  9910. case StatusCode::ResetContent_205: return "Reset Content";
  9911. case StatusCode::PartialContent_206: return "Partial Content";
  9912. case StatusCode::MultiStatus_207: return "Multi-Status";
  9913. case StatusCode::AlreadyReported_208: return "Already Reported";
  9914. case StatusCode::IMUsed_226: return "IM Used";
  9915. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9916. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9917. case StatusCode::Found_302: return "Found";
  9918. case StatusCode::SeeOther_303: return "See Other";
  9919. case StatusCode::NotModified_304: return "Not Modified";
  9920. case StatusCode::UseProxy_305: return "Use Proxy";
  9921. case StatusCode::unused_306: return "unused";
  9922. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9923. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9924. case StatusCode::BadRequest_400: return "Bad Request";
  9925. case StatusCode::Unauthorized_401: return "Unauthorized";
  9926. case StatusCode::PaymentRequired_402: return "Payment Required";
  9927. case StatusCode::Forbidden_403: return "Forbidden";
  9928. case StatusCode::NotFound_404: return "Not Found";
  9929. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9930. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9931. case StatusCode::ProxyAuthenticationRequired_407:
  9932. return "Proxy Authentication Required";
  9933. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9934. case StatusCode::Conflict_409: return "Conflict";
  9935. case StatusCode::Gone_410: return "Gone";
  9936. case StatusCode::LengthRequired_411: return "Length Required";
  9937. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9938. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9939. case StatusCode::UriTooLong_414: return "URI Too Long";
  9940. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9941. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9942. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9943. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9944. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9945. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9946. case StatusCode::Locked_423: return "Locked";
  9947. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9948. case StatusCode::TooEarly_425: return "Too Early";
  9949. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9950. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9951. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9952. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9953. return "Request Header Fields Too Large";
  9954. case StatusCode::UnavailableForLegalReasons_451:
  9955. return "Unavailable For Legal Reasons";
  9956. case StatusCode::NotImplemented_501: return "Not Implemented";
  9957. case StatusCode::BadGateway_502: return "Bad Gateway";
  9958. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9959. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9960. case StatusCode::HttpVersionNotSupported_505:
  9961. return "HTTP Version Not Supported";
  9962. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9963. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9964. case StatusCode::LoopDetected_508: return "Loop Detected";
  9965. case StatusCode::NotExtended_510: return "Not Extended";
  9966. case StatusCode::NetworkAuthenticationRequired_511:
  9967. return "Network Authentication Required";
  9968. default:
  9969. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9970. }
  9971. }
  9972. inline std::string to_string(const Error error) {
  9973. switch (error) {
  9974. case Error::Success: return "Success (no error)";
  9975. case Error::Unknown: return "Unknown";
  9976. case Error::Connection: return "Could not establish connection";
  9977. case Error::BindIPAddress: return "Failed to bind IP address";
  9978. case Error::Read: return "Failed to read connection";
  9979. case Error::Write: return "Failed to write connection";
  9980. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9981. case Error::Canceled: return "Connection handling canceled";
  9982. case Error::SSLConnection: return "SSL connection failed";
  9983. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9984. case Error::SSLServerVerification: return "SSL server verification failed";
  9985. case Error::SSLServerHostnameVerification:
  9986. return "SSL server hostname verification failed";
  9987. case Error::UnsupportedMultipartBoundaryChars:
  9988. return "Unsupported HTTP multipart boundary characters";
  9989. case Error::Compression: return "Compression failed";
  9990. case Error::ConnectionTimeout: return "Connection timed out";
  9991. case Error::ProxyConnection: return "Proxy connection failed";
  9992. case Error::ConnectionClosed: return "Connection closed by server";
  9993. case Error::Timeout: return "Read timeout";
  9994. case Error::ResourceExhaustion: return "Resource exhaustion";
  9995. case Error::TooManyFormDataFiles: return "Too many form data files";
  9996. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9997. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9998. case Error::ExceedMaxSocketDescriptorCount:
  9999. return "Exceeded maximum socket descriptor count";
  10000. case Error::InvalidRequestLine: return "Invalid request line";
  10001. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  10002. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  10003. case Error::InvalidHeaders: return "Invalid headers";
  10004. case Error::MultipartParsing: return "Multipart parsing failed";
  10005. case Error::OpenFile: return "Failed to open file";
  10006. case Error::Listen: return "Failed to listen on socket";
  10007. case Error::GetSockName: return "Failed to get socket name";
  10008. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  10009. case Error::HTTPParsing: return "HTTP parsing failed";
  10010. case Error::InvalidRangeHeader: return "Invalid Range header";
  10011. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  10012. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  10013. case Error::UserCallbackException: return "User callback threw an exception";
  10014. default: break;
  10015. }
  10016. return "Invalid";
  10017. }
  10018. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  10019. os << to_string(obj);
  10020. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  10021. return os;
  10022. }
  10023. inline std::string hosted_at(const std::string &hostname) {
  10024. std::vector<std::string> addrs;
  10025. hosted_at(hostname, addrs);
  10026. if (addrs.empty()) { return std::string(); }
  10027. return addrs[0];
  10028. }
  10029. inline void hosted_at(const std::string &hostname,
  10030. std::vector<std::string> &addrs) {
  10031. struct addrinfo hints;
  10032. struct addrinfo *result;
  10033. memset(&hints, 0, sizeof(struct addrinfo));
  10034. hints.ai_family = AF_UNSPEC;
  10035. hints.ai_socktype = SOCK_STREAM;
  10036. hints.ai_protocol = 0;
  10037. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  10038. &result, 0)) {
  10039. #if defined __linux__ && !defined __ANDROID__
  10040. res_init();
  10041. #endif
  10042. return;
  10043. }
  10044. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  10045. for (auto rp = result; rp; rp = rp->ai_next) {
  10046. const auto &addr =
  10047. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  10048. std::string ip;
  10049. auto dummy = -1;
  10050. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  10051. dummy)) {
  10052. addrs.emplace_back(std::move(ip));
  10053. }
  10054. }
  10055. }
  10056. inline std::string encode_uri_component(const std::string &value) {
  10057. std::ostringstream escaped;
  10058. escaped.fill('0');
  10059. escaped << std::hex;
  10060. for (auto c : value) {
  10061. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  10062. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  10063. escaped << c;
  10064. } else {
  10065. escaped << std::uppercase;
  10066. escaped << '%' << std::setw(2)
  10067. << static_cast<int>(static_cast<unsigned char>(c));
  10068. escaped << std::nouppercase;
  10069. }
  10070. }
  10071. return escaped.str();
  10072. }
  10073. inline std::string encode_uri(const std::string &value) {
  10074. std::ostringstream escaped;
  10075. escaped.fill('0');
  10076. escaped << std::hex;
  10077. for (auto c : value) {
  10078. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  10079. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  10080. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  10081. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  10082. escaped << c;
  10083. } else {
  10084. escaped << std::uppercase;
  10085. escaped << '%' << std::setw(2)
  10086. << static_cast<int>(static_cast<unsigned char>(c));
  10087. escaped << std::nouppercase;
  10088. }
  10089. }
  10090. return escaped.str();
  10091. }
  10092. inline std::string decode_uri_component(const std::string &value) {
  10093. std::string result;
  10094. for (size_t i = 0; i < value.size(); i++) {
  10095. if (value[i] == '%' && i + 2 < value.size()) {
  10096. auto val = 0;
  10097. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  10098. result += static_cast<char>(val);
  10099. i += 2;
  10100. } else {
  10101. result += value[i];
  10102. }
  10103. } else {
  10104. result += value[i];
  10105. }
  10106. }
  10107. return result;
  10108. }
  10109. inline std::string decode_uri(const std::string &value) {
  10110. std::string result;
  10111. for (size_t i = 0; i < value.size(); i++) {
  10112. if (value[i] == '%' && i + 2 < value.size()) {
  10113. auto val = 0;
  10114. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  10115. auto c = static_cast<char>(val);
  10116. // Keep escapes of the reserved characters that encode_uri leaves
  10117. // literal, so decode_uri is the inverse of encode_uri and an escaped
  10118. // delimiter is not promoted into a real one (as with JS decodeURI).
  10119. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  10120. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  10121. c == '#') {
  10122. result += value[i];
  10123. result += value[i + 1];
  10124. result += value[i + 2];
  10125. } else {
  10126. result += c;
  10127. }
  10128. i += 2;
  10129. } else {
  10130. result += value[i];
  10131. }
  10132. } else {
  10133. result += value[i];
  10134. }
  10135. }
  10136. return result;
  10137. }
  10138. inline std::string encode_path_component(const std::string &component) {
  10139. std::string result;
  10140. result.reserve(component.size() * 3);
  10141. for (size_t i = 0; i < component.size(); i++) {
  10142. auto c = static_cast<unsigned char>(component[i]);
  10143. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  10144. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10145. c == '_' || c == '~') {
  10146. result += static_cast<char>(c);
  10147. }
  10148. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  10149. // "," / ";" / "="
  10150. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  10151. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  10152. c == '=') {
  10153. result += static_cast<char>(c);
  10154. }
  10155. // Colon is allowed in path segments except first segment
  10156. else if (c == ':') {
  10157. result += static_cast<char>(c);
  10158. }
  10159. // @ is allowed in path
  10160. else if (c == '@') {
  10161. result += static_cast<char>(c);
  10162. } else {
  10163. result += '%';
  10164. char hex[3];
  10165. snprintf(hex, sizeof(hex), "%02X", c);
  10166. result.append(hex, 2);
  10167. }
  10168. }
  10169. return result;
  10170. }
  10171. inline std::string decode_path_component(const std::string &component) {
  10172. std::string result;
  10173. result.reserve(component.size());
  10174. for (size_t i = 0; i < component.size(); i++) {
  10175. if (component[i] == '%' && i + 1 < component.size()) {
  10176. if (component[i + 1] == 'u') {
  10177. // Unicode %uXXXX encoding
  10178. auto val = 0;
  10179. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  10180. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  10181. char buff[4];
  10182. size_t len = 0;
  10183. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  10184. (len = detail::to_utf8(val, buff)) > 0) {
  10185. result.append(buff, len);
  10186. i += 5; // 'u0000'
  10187. } else {
  10188. // Not 4 hex digits, or a surrogate, which is no character: the
  10189. // escape is kept as it is rather than joining its neighbours
  10190. result += component[i];
  10191. }
  10192. } else {
  10193. // Standard %XX encoding
  10194. auto val = 0;
  10195. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10196. // 2 digits hex codes
  10197. result += static_cast<char>(val);
  10198. i += 2; // 'XX'
  10199. } else {
  10200. result += component[i];
  10201. }
  10202. }
  10203. } else {
  10204. result += component[i];
  10205. }
  10206. }
  10207. return result;
  10208. }
  10209. inline std::string encode_query_component(const std::string &component,
  10210. bool space_as_plus) {
  10211. std::string result;
  10212. result.reserve(component.size() * 3);
  10213. for (size_t i = 0; i < component.size(); i++) {
  10214. auto c = static_cast<unsigned char>(component[i]);
  10215. // Unreserved characters per RFC 3986
  10216. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10217. c == '_' || c == '~') {
  10218. result += static_cast<char>(c);
  10219. }
  10220. // Space handling
  10221. else if (c == ' ') {
  10222. if (space_as_plus) {
  10223. result += '+';
  10224. } else {
  10225. result += "%20";
  10226. }
  10227. }
  10228. // Plus sign handling
  10229. else if (c == '+') {
  10230. if (space_as_plus) {
  10231. result += "%2B";
  10232. } else {
  10233. result += static_cast<char>(c);
  10234. }
  10235. }
  10236. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  10237. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  10238. c == '*' || c == ',' || c == ';') {
  10239. result += static_cast<char>(c);
  10240. }
  10241. // Colon and @ are allowed in query
  10242. else if (c == ':' || c == '@') {
  10243. result += static_cast<char>(c);
  10244. }
  10245. // Forward slash is allowed in query values
  10246. else if (c == '/') {
  10247. result += static_cast<char>(c);
  10248. }
  10249. // Question mark is allowed in query values (after first ?)
  10250. else if (c == '?') {
  10251. result += static_cast<char>(c);
  10252. } else {
  10253. result += '%';
  10254. char hex[3];
  10255. snprintf(hex, sizeof(hex), "%02X", c);
  10256. result.append(hex, 2);
  10257. }
  10258. }
  10259. return result;
  10260. }
  10261. inline std::string decode_query_component(const std::string &component,
  10262. bool plus_as_space) {
  10263. std::string result;
  10264. result.reserve(component.size());
  10265. for (size_t i = 0; i < component.size(); i++) {
  10266. if (component[i] == '%' && i + 2 < component.size()) {
  10267. auto val = 0;
  10268. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10269. result += static_cast<char>(val);
  10270. i += 2;
  10271. } else {
  10272. result += component[i];
  10273. }
  10274. } else if (component[i] == '+' && plus_as_space) {
  10275. result += ' '; // + becomes space in form-urlencoded
  10276. } else {
  10277. result += component[i];
  10278. }
  10279. }
  10280. return result;
  10281. }
  10282. inline std::string sanitize_filename(const std::string &filename) {
  10283. // Extract basename: find the last path separator (/ or \) and, on Windows,
  10284. // ':', which ends a drive prefix ("C:..") or names an NTFS stream ("a:b")
  10285. #ifdef _WIN32
  10286. auto pos = filename.find_last_of("/\\:");
  10287. #else
  10288. auto pos = filename.find_last_of("/\\");
  10289. #endif
  10290. auto result =
  10291. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10292. // Strip null bytes
  10293. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10294. // Trim whitespace
  10295. {
  10296. auto start = result.find_first_not_of(" \t");
  10297. auto end = result.find_last_not_of(" \t");
  10298. result = (start == std::string::npos)
  10299. ? ""
  10300. : result.substr(start, end - start + 1);
  10301. }
  10302. // Reject . and ..
  10303. if (result == "." || result == "..") { return ""; }
  10304. return result;
  10305. }
  10306. inline std::string append_query_params(const std::string &path,
  10307. const Params &params) {
  10308. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10309. auto fragment_pos = path.find('#');
  10310. auto path_with_query = path.substr(0, fragment_pos);
  10311. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10312. path_with_query += detail::params_to_query_str(params);
  10313. if (fragment_pos != std::string::npos) {
  10314. path_with_query.append(path, fragment_pos, std::string::npos);
  10315. }
  10316. return path_with_query;
  10317. }
  10318. // Header utilities
  10319. inline std::pair<std::string, std::string>
  10320. make_range_header(const Ranges &ranges) {
  10321. std::string field = "bytes=";
  10322. auto i = 0;
  10323. for (const auto &r : ranges) {
  10324. if (i != 0) { field += ", "; }
  10325. if (r.first != -1) { field += std::to_string(r.first); }
  10326. field += '-';
  10327. if (r.second != -1) { field += std::to_string(r.second); }
  10328. i++;
  10329. }
  10330. return std::make_pair("Range", std::move(field));
  10331. }
  10332. inline std::pair<std::string, std::string>
  10333. make_basic_authentication_header(const std::string &username,
  10334. const std::string &password, bool is_proxy) {
  10335. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10336. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10337. return std::make_pair(key, std::move(field));
  10338. }
  10339. inline std::pair<std::string, std::string>
  10340. make_bearer_token_authentication_header(const std::string &token,
  10341. bool is_proxy = false) {
  10342. auto field = "Bearer " + token;
  10343. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10344. return std::make_pair(key, std::move(field));
  10345. }
  10346. namespace detail {
  10347. // Basic auth when a username or password is set, otherwise a bearer token,
  10348. // unless the request already carries the header.
  10349. inline void add_authorization_header(Request &req, const std::string &username,
  10350. const std::string &password,
  10351. const std::string &token, bool is_proxy) {
  10352. if (req.has_header(is_proxy ? "Proxy-Authorization" : "Authorization")) {
  10353. return;
  10354. }
  10355. if (!username.empty() || !password.empty()) {
  10356. req.headers.insert(
  10357. make_basic_authentication_header(username, password, is_proxy));
  10358. } else if (!token.empty()) {
  10359. req.headers.insert(
  10360. make_bearer_token_authentication_header(token, is_proxy));
  10361. }
  10362. }
  10363. } // namespace detail
  10364. // Request implementation
  10365. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10366. size_t id) const {
  10367. return detail::get_header_value_u64(headers, key, def, id);
  10368. }
  10369. inline bool Request::has_header(const std::string &key) const {
  10370. return detail::has_header(headers, key);
  10371. }
  10372. inline std::string Request::get_header_value(const std::string &key,
  10373. const char *def, size_t id) const {
  10374. return detail::get_header_value(headers, key, def, id);
  10375. }
  10376. inline size_t Request::get_header_value_count(const std::string &key) const {
  10377. return detail::get_header_value_count(headers, key);
  10378. }
  10379. inline void Request::set_header(const std::string &key,
  10380. const std::string &val) {
  10381. detail::set_header(headers, key, val);
  10382. }
  10383. inline bool Request::has_trailer(const std::string &key) const {
  10384. return trailers.find(key) != trailers.end();
  10385. }
  10386. inline std::string Request::get_trailer_value(const std::string &key,
  10387. size_t id) const {
  10388. return detail::get_multimap_value(trailers, key, id);
  10389. }
  10390. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10391. return trailers.count(key);
  10392. }
  10393. inline bool Request::has_param(const std::string &key) const {
  10394. return params.find(key) != params.end();
  10395. }
  10396. inline std::string Request::get_param_value(const std::string &key,
  10397. size_t id) const {
  10398. return detail::get_multimap_value(params, key, id);
  10399. }
  10400. inline std::vector<std::string>
  10401. Request::get_param_values(const std::string &key) const {
  10402. auto rng = params.equal_range(key);
  10403. std::vector<std::string> values;
  10404. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10405. for (auto it = rng.first; it != rng.second; ++it) {
  10406. values.push_back(it->second);
  10407. }
  10408. return values;
  10409. }
  10410. inline size_t Request::get_param_value_count(const std::string &key) const {
  10411. return params.count(key);
  10412. }
  10413. inline bool Request::is_multipart_form_data() const {
  10414. const auto &content_type = get_header_value("Content-Type");
  10415. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10416. "multipart/form-data");
  10417. }
  10418. // Multipart FormData implementation
  10419. inline std::string MultipartFormData::get_field(const std::string &key,
  10420. size_t id) const {
  10421. auto rng = fields.equal_range(key);
  10422. auto it = detail::bounded_next(rng.first, id, rng.second);
  10423. if (it != rng.second) { return it->second.content; }
  10424. return std::string();
  10425. }
  10426. inline std::vector<std::string>
  10427. MultipartFormData::get_fields(const std::string &key) const {
  10428. std::vector<std::string> values;
  10429. auto rng = fields.equal_range(key);
  10430. for (auto it = rng.first; it != rng.second; it++) {
  10431. values.push_back(it->second.content);
  10432. }
  10433. return values;
  10434. }
  10435. inline bool MultipartFormData::has_field(const std::string &key) const {
  10436. return fields.find(key) != fields.end();
  10437. }
  10438. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10439. return fields.count(key);
  10440. }
  10441. inline FormData MultipartFormData::get_file(const std::string &key,
  10442. size_t id) const {
  10443. return detail::get_multimap_value(files, key, id);
  10444. }
  10445. inline std::vector<FormData>
  10446. MultipartFormData::get_files(const std::string &key) const {
  10447. std::vector<FormData> values;
  10448. auto rng = files.equal_range(key);
  10449. for (auto it = rng.first; it != rng.second; it++) {
  10450. values.push_back(it->second);
  10451. }
  10452. return values;
  10453. }
  10454. inline bool MultipartFormData::has_file(const std::string &key) const {
  10455. return files.find(key) != files.end();
  10456. }
  10457. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10458. return files.count(key);
  10459. }
  10460. // Multipart FormData writer implementation
  10461. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10462. return detail::is_multipart_boundary_chars_valid(boundary);
  10463. }
  10464. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10465. : boundary_(detail::make_multipart_data_boundary()) {}
  10466. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10467. : boundary_(std::move(boundary)) {}
  10468. inline const std::string &MultipartFormDataWriter::boundary() const {
  10469. return boundary_;
  10470. }
  10471. inline std::string MultipartFormDataWriter::content_type() const {
  10472. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10473. }
  10474. inline std::string
  10475. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10476. return detail::serialize_multipart_formdata(items, boundary_);
  10477. }
  10478. inline size_t MultipartFormDataWriter::content_length(
  10479. const UploadFormDataItems &items) const {
  10480. return detail::get_multipart_content_length(items, boundary_);
  10481. }
  10482. inline std::string
  10483. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10484. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10485. }
  10486. inline std::string MultipartFormDataWriter::item_end() {
  10487. return detail::serialize_multipart_formdata_item_end();
  10488. }
  10489. inline std::string MultipartFormDataWriter::finish() const {
  10490. return detail::serialize_multipart_formdata_finish(boundary_);
  10491. }
  10492. // Response implementation
  10493. namespace detail {
  10494. // A response has one content source: `body`, a content provider, or a file.
  10495. // Each content setter calls this so that the one called last wins.
  10496. inline void clear_content_provider(Response &res) {
  10497. auto releaser = std::move(res.content_provider_resource_releaser_);
  10498. auto success = res.content_provider_success_;
  10499. res.content_length_ = 0;
  10500. res.content_provider_ = nullptr;
  10501. res.content_provider_resource_releaser_ = nullptr;
  10502. res.is_chunked_content_provider_ = false;
  10503. res.is_file_content_provider_ = false;
  10504. res.content_provider_success_ = false;
  10505. res.content_coding_ = EncodingType::None;
  10506. res.file_content_path_.clear();
  10507. res.file_content_content_type_.clear();
  10508. if (releaser) { releaser(success); }
  10509. }
  10510. inline void clear_content(Response &res) {
  10511. res.body.clear();
  10512. clear_content_provider(res);
  10513. }
  10514. // The Content-Type of the old content goes with it.
  10515. inline void set_content_type(Response &res, const std::string &content_type) {
  10516. res.headers.erase("Content-Type");
  10517. res.set_header("Content-Type", content_type);
  10518. }
  10519. // `body` is public, so it can be assigned directly after a provider or a file
  10520. // was set. It came last, so it wins.
  10521. inline void prefer_assigned_body(Response &res) {
  10522. if (!res.body.empty() &&
  10523. (res.content_provider_ || !res.file_content_path_.empty())) {
  10524. clear_content_provider(res);
  10525. }
  10526. }
  10527. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10528. inline bool body_allowed_for_status(int status) {
  10529. return status >= 200 && status != StatusCode::NoContent_204 &&
  10530. status != StatusCode::NotModified_304;
  10531. }
  10532. // Only a 206 response is served as a partial representation. range_error()
  10533. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10534. // status would start from an unchecked offset.
  10535. inline bool is_partial_content(const Request &req, const Response &res) {
  10536. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10537. }
  10538. // Sets the Content-Length or Transfer-Encoding framing the body that
  10539. // Server::write_response_core() writes, or closes the connection after a body
  10540. // that has neither. Only the library sets them: one from a handler would go
  10541. // out next to it, or describe some other body.
  10542. inline void set_framing_headers(const Request &req, Response &res,
  10543. const std::string &boundary,
  10544. const std::string &content_type) {
  10545. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10546. auto head_length = req.method == "HEAD"
  10547. ? res.get_header_value("Content-Length")
  10548. : std::string();
  10549. res.headers.erase("Content-Length");
  10550. res.headers.erase("Transfer-Encoding");
  10551. if (!body_allowed_for_status(res.status)) { return; }
  10552. if (res.content_provider_) {
  10553. if (res.content_length_ == 0) {
  10554. if (res.is_chunked_content_provider_) {
  10555. res.set_header("Transfer-Encoding", "chunked");
  10556. } else if (req.method != "HEAD") {
  10557. // RFC 9112 6.3: a body with neither ends where the connection does.
  10558. res.headers.erase("Keep-Alive");
  10559. if (!has_header_token(res.headers, "Connection", "close")) {
  10560. res.set_header("Connection", "close");
  10561. }
  10562. }
  10563. return;
  10564. }
  10565. // The part Server::write_content_with_provider() writes.
  10566. auto length = res.content_length_;
  10567. if (is_partial_content(req, res)) {
  10568. length = req.ranges.size() == 1
  10569. ? get_range_offset_and_length(req.ranges[0], length).second
  10570. : get_multipart_ranges_data_length(req, boundary,
  10571. content_type, length);
  10572. }
  10573. res.set_header("Content-Length", std::to_string(length));
  10574. } else if (!res.body.empty()) {
  10575. res.set_header("Content-Length", std::to_string(res.body.size()));
  10576. } else {
  10577. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  10578. }
  10579. }
  10580. } // namespace detail
  10581. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10582. size_t id) const {
  10583. return detail::get_header_value_u64(headers, key, def, id);
  10584. }
  10585. inline bool Response::has_header(const std::string &key) const {
  10586. return headers.find(key) != headers.end();
  10587. }
  10588. inline std::string Response::get_header_value(const std::string &key,
  10589. const char *def,
  10590. size_t id) const {
  10591. return detail::get_header_value(headers, key, def, id);
  10592. }
  10593. inline size_t Response::get_header_value_count(const std::string &key) const {
  10594. return detail::get_header_value_count(headers, key);
  10595. }
  10596. inline void Response::set_header(const std::string &key,
  10597. const std::string &val) {
  10598. detail::set_header(headers, key, val);
  10599. }
  10600. inline bool Response::has_trailer(const std::string &key) const {
  10601. return trailers.find(key) != trailers.end();
  10602. }
  10603. inline std::string Response::get_trailer_value(const std::string &key,
  10604. size_t id) const {
  10605. return detail::get_multimap_value(trailers, key, id);
  10606. }
  10607. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10608. return trailers.count(key);
  10609. }
  10610. inline void Response::set_redirect(const std::string &url, int stat) {
  10611. if (detail::fields::is_field_value(url)) {
  10612. set_header("Location", url);
  10613. if (300 <= stat && stat < 400) {
  10614. this->status = stat;
  10615. } else {
  10616. this->status = StatusCode::Found_302;
  10617. }
  10618. }
  10619. }
  10620. inline void Response::set_content(const char *s, size_t n,
  10621. const std::string &content_type) {
  10622. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10623. detail::clear_content_provider(*this);
  10624. detail::set_content_type(*this, content_type);
  10625. }
  10626. inline void Response::set_content(const std::string &s,
  10627. const std::string &content_type) {
  10628. set_content(s.data(), s.size(), content_type);
  10629. }
  10630. inline void Response::set_content(std::string &&s,
  10631. const std::string &content_type) {
  10632. body = std::move(s);
  10633. detail::clear_content_provider(*this);
  10634. detail::set_content_type(*this, content_type);
  10635. }
  10636. inline void Response::set_content_provider(
  10637. size_t in_length, const std::string &content_type, ContentProvider provider,
  10638. ContentProviderResourceReleaser resource_releaser) {
  10639. detail::clear_content(*this);
  10640. detail::set_content_type(*this, content_type);
  10641. content_length_ = in_length;
  10642. if (in_length > 0) { content_provider_ = std::move(provider); }
  10643. content_provider_resource_releaser_ = std::move(resource_releaser);
  10644. }
  10645. inline void Response::set_content_provider(
  10646. const std::string &content_type, ContentProviderWithoutLength provider,
  10647. ContentProviderResourceReleaser resource_releaser) {
  10648. detail::clear_content(*this);
  10649. detail::set_content_type(*this, content_type);
  10650. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10651. content_provider_resource_releaser_ = std::move(resource_releaser);
  10652. }
  10653. inline void Response::set_chunked_content_provider(
  10654. const std::string &content_type, ContentProviderWithoutLength provider,
  10655. ContentProviderResourceReleaser resource_releaser) {
  10656. set_content_provider(content_type, std::move(provider),
  10657. std::move(resource_releaser));
  10658. is_chunked_content_provider_ = true;
  10659. }
  10660. inline void Response::set_file_content(const std::string &path,
  10661. const std::string &content_type) {
  10662. detail::clear_content(*this);
  10663. headers.erase("Content-Type");
  10664. file_content_path_ = path;
  10665. file_content_content_type_ = content_type;
  10666. }
  10667. inline void Response::set_file_content(const std::string &path) {
  10668. set_file_content(path, std::string());
  10669. }
  10670. // Result implementation
  10671. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10672. size_t def,
  10673. size_t id) const {
  10674. return detail::get_header_value_u64(request_headers_, key, def, id);
  10675. }
  10676. inline bool Result::has_request_header(const std::string &key) const {
  10677. return request_headers_.find(key) != request_headers_.end();
  10678. }
  10679. inline std::string Result::get_request_header_value(const std::string &key,
  10680. const char *def,
  10681. size_t id) const {
  10682. return detail::get_header_value(request_headers_, key, def, id);
  10683. }
  10684. inline size_t
  10685. Result::get_request_header_value_count(const std::string &key) const {
  10686. return request_headers_.count(key);
  10687. }
  10688. // Stream implementation
  10689. inline ssize_t Stream::write(const char *ptr) {
  10690. return write(ptr, strlen(ptr));
  10691. }
  10692. inline ssize_t Stream::write(const std::string &s) {
  10693. return write(s.data(), s.size());
  10694. }
  10695. // BodyReader implementation
  10696. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10697. if (!stream) {
  10698. last_error = Error::Connection;
  10699. return -1;
  10700. }
  10701. if (eof) { return 0; }
  10702. if (!chunked) {
  10703. // Content-Length based reading
  10704. if (has_content_length && bytes_read >= content_length) {
  10705. eof = true;
  10706. return 0;
  10707. }
  10708. auto to_read = len;
  10709. if (has_content_length) {
  10710. auto remaining = content_length - bytes_read;
  10711. to_read = (std::min)(len, remaining);
  10712. }
  10713. auto n = stream->read(buf, to_read);
  10714. // Without Content-Length the body ends when the connection closes
  10715. // (RFC 9112 §6.3); with one, an EOF here came too early
  10716. if (n < 0 || (n == 0 && has_content_length)) {
  10717. last_error = stream->get_error();
  10718. if (last_error == Error::Success) { last_error = Error::Read; }
  10719. }
  10720. if (n <= 0) {
  10721. eof = true;
  10722. return n;
  10723. }
  10724. bytes_read += static_cast<size_t>(n);
  10725. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10726. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10727. last_error = Error::ExceedMaxPayloadSize;
  10728. eof = true;
  10729. return -1;
  10730. }
  10731. return n;
  10732. }
  10733. // Chunked transfer encoding: delegate to shared decoder instance.
  10734. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10735. size_t chunk_offset = 0;
  10736. size_t chunk_total = 0;
  10737. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10738. if (n < 0) {
  10739. last_error = stream->get_error();
  10740. if (last_error == Error::Success) { last_error = Error::Read; }
  10741. eof = true;
  10742. return n;
  10743. }
  10744. if (n == 0) {
  10745. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10746. eof = true;
  10747. return 0;
  10748. }
  10749. bytes_read += static_cast<size_t>(n);
  10750. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10751. last_error = Error::ExceedMaxPayloadSize;
  10752. eof = true;
  10753. return -1;
  10754. }
  10755. return n;
  10756. }
  10757. // ThreadPool implementation
  10758. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10759. time_t idle_timeout_sec)
  10760. : base_thread_count_(n), max_queued_requests_(mqr),
  10761. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10762. shutdown_(false) {
  10763. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10764. if (max_n != 0 && max_n < n) {
  10765. std::string msg = "max_threads must be >= base_threads";
  10766. throw std::invalid_argument(msg);
  10767. }
  10768. #endif
  10769. max_thread_count_ = max_n == 0 ? n : max_n;
  10770. threads_.reserve(base_thread_count_);
  10771. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10772. try {
  10773. #endif
  10774. for (size_t i = 0; i < base_thread_count_; i++) {
  10775. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10776. }
  10777. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10778. } catch (...) {
  10779. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10780. // signal the workers we already spawned to exit and join them so the
  10781. // vector destructor does not see joinable threads (which would call
  10782. // std::terminate). Then rethrow so the caller learns of the failure.
  10783. {
  10784. std::unique_lock<std::mutex> lock(mutex_);
  10785. shutdown_ = true;
  10786. }
  10787. cond_.notify_all();
  10788. for (auto &t : threads_) {
  10789. if (t.joinable()) { t.join(); }
  10790. }
  10791. throw;
  10792. }
  10793. #endif
  10794. }
  10795. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10796. {
  10797. std::unique_lock<std::mutex> lock(mutex_);
  10798. if (shutdown_) { return false; }
  10799. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10800. return false;
  10801. }
  10802. jobs_.push_back(std::move(fn));
  10803. // Spawn a dynamic thread if jobs outnumber idle threads and under max
  10804. if (jobs_.size() > idle_thread_count_ &&
  10805. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10806. cleanup_finished_threads();
  10807. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10808. try {
  10809. #endif
  10810. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10811. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10812. } catch (const std::system_error &) {
  10813. // No thread budget left: keep the job queued for an existing worker
  10814. // instead of letting the exception escape the accept loop.
  10815. }
  10816. #endif
  10817. }
  10818. }
  10819. cond_.notify_one();
  10820. return true;
  10821. }
  10822. inline void ThreadPool::shutdown() {
  10823. {
  10824. std::unique_lock<std::mutex> lock(mutex_);
  10825. shutdown_ = true;
  10826. }
  10827. cond_.notify_all();
  10828. for (auto &t : threads_) {
  10829. if (t.joinable()) { t.join(); }
  10830. }
  10831. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10832. // with worker threads that call move_to_finished() concurrently.
  10833. std::list<std::thread> remaining_dynamic;
  10834. {
  10835. std::unique_lock<std::mutex> lock(mutex_);
  10836. remaining_dynamic = std::move(dynamic_threads_);
  10837. }
  10838. for (auto &t : remaining_dynamic) {
  10839. if (t.joinable()) { t.join(); }
  10840. }
  10841. std::unique_lock<std::mutex> lock(mutex_);
  10842. cleanup_finished_threads();
  10843. }
  10844. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10845. // Must be called with mutex_ held
  10846. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10847. if (it->get_id() == id) {
  10848. finished_threads_.push_back(std::move(*it));
  10849. dynamic_threads_.erase(it);
  10850. return;
  10851. }
  10852. }
  10853. }
  10854. inline void ThreadPool::cleanup_finished_threads() {
  10855. // Must be called with mutex_ held
  10856. for (auto &t : finished_threads_) {
  10857. if (t.joinable()) { t.join(); }
  10858. }
  10859. finished_threads_.clear();
  10860. }
  10861. inline void ThreadPool::worker(bool is_dynamic) {
  10862. for (;;) {
  10863. std::function<void()> fn;
  10864. {
  10865. std::unique_lock<std::mutex> lock(mutex_);
  10866. idle_thread_count_++;
  10867. if (is_dynamic) {
  10868. auto has_work =
  10869. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10870. [&] { return !jobs_.empty() || shutdown_; });
  10871. if (!has_work) {
  10872. // Timed out with no work - exit this dynamic thread
  10873. idle_thread_count_--;
  10874. move_to_finished(std::this_thread::get_id());
  10875. break;
  10876. }
  10877. } else {
  10878. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10879. }
  10880. idle_thread_count_--;
  10881. if (shutdown_ && jobs_.empty()) { break; }
  10882. fn = std::move(jobs_.front());
  10883. jobs_.pop_front();
  10884. }
  10885. assert(true == static_cast<bool>(fn));
  10886. fn();
  10887. }
  10888. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10889. !defined(LIBRESSL_VERSION_NUMBER)
  10890. OPENSSL_thread_stop();
  10891. #endif
  10892. }
  10893. /*
  10894. * Group 1 (continued): detail namespace - Stream implementations
  10895. */
  10896. namespace detail {
  10897. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10898. time_t timeout_sec, time_t timeout_usec,
  10899. time_t &actual_timeout_sec,
  10900. time_t &actual_timeout_usec) {
  10901. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10902. auto actual_timeout_msec =
  10903. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10904. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10905. actual_timeout_sec = actual_timeout_msec / 1000;
  10906. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10907. }
  10908. // Socket stream implementation
  10909. inline SocketStream::SocketStream(
  10910. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10911. time_t write_timeout_sec, time_t write_timeout_usec,
  10912. time_t max_timeout_msec,
  10913. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10914. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10915. read_timeout_usec_(read_timeout_usec),
  10916. write_timeout_sec_(write_timeout_sec),
  10917. write_timeout_usec_(write_timeout_usec),
  10918. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10919. read_buff_(read_buff_size_, 0) {}
  10920. inline SocketStream::~SocketStream() = default;
  10921. inline bool SocketStream::is_readable() const {
  10922. return read_buff_off_ < read_buff_content_size_;
  10923. }
  10924. inline bool SocketStream::wait_readable() const {
  10925. if (max_timeout_msec_ <= 0) {
  10926. return select_read_interruptible(sock_, read_timeout_sec_,
  10927. read_timeout_usec_, read_interrupted_) > 0;
  10928. }
  10929. time_t read_timeout_sec;
  10930. time_t read_timeout_usec;
  10931. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10932. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10933. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  10934. read_interrupted_) > 0;
  10935. }
  10936. inline bool SocketStream::wait_writable() const {
  10937. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10938. }
  10939. inline bool SocketStream::ensure_readable() {
  10940. if (readable_hint_) {
  10941. readable_hint_ = false;
  10942. return true;
  10943. }
  10944. return wait_readable();
  10945. }
  10946. inline const char *SocketStream::buffered_data(size_t &size) const {
  10947. size = read_buff_content_size_ - read_buff_off_;
  10948. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10949. }
  10950. inline void SocketStream::consume_buffered(size_t size) {
  10951. assert(size <= read_buff_content_size_ - read_buff_off_);
  10952. read_buff_off_ += size;
  10953. }
  10954. inline bool SocketStream::is_peer_alive() const {
  10955. return detail::is_socket_alive(sock_);
  10956. }
  10957. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10958. #ifdef _WIN32
  10959. size =
  10960. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10961. #else
  10962. size = (std::min)(size,
  10963. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10964. #endif
  10965. if (read_buff_off_ < read_buff_content_size_) {
  10966. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10967. if (size <= remaining_size) {
  10968. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10969. read_buff_off_ += size;
  10970. return static_cast<ssize_t>(size);
  10971. } else {
  10972. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10973. read_buff_off_ += remaining_size;
  10974. return static_cast<ssize_t>(remaining_size);
  10975. }
  10976. }
  10977. if (!ensure_readable()) {
  10978. error_ = Error::Timeout;
  10979. return -1;
  10980. }
  10981. read_buff_off_ = 0;
  10982. read_buff_content_size_ = 0;
  10983. if (size < read_buff_size_) {
  10984. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10985. CPPHTTPLIB_RECV_FLAGS);
  10986. if (n <= 0) {
  10987. if (n == 0) {
  10988. error_ = Error::ConnectionClosed;
  10989. } else {
  10990. error_ = Error::Read;
  10991. }
  10992. return n;
  10993. } else if (n <= static_cast<ssize_t>(size)) {
  10994. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10995. return n;
  10996. } else {
  10997. memcpy(ptr, read_buff_.data(), size);
  10998. read_buff_off_ = size;
  10999. read_buff_content_size_ = static_cast<size_t>(n);
  11000. return static_cast<ssize_t>(size);
  11001. }
  11002. } else {
  11003. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  11004. if (n <= 0) {
  11005. if (n == 0) {
  11006. error_ = Error::ConnectionClosed;
  11007. } else {
  11008. error_ = Error::Read;
  11009. }
  11010. }
  11011. return n;
  11012. }
  11013. }
  11014. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  11015. if (!wait_writable()) { return -1; }
  11016. // Winsock's send() takes an int length, even on 64-bit Windows
  11017. #ifdef _WIN32
  11018. size =
  11019. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  11020. #endif
  11021. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  11022. }
  11023. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  11024. int &port) const {
  11025. return detail::get_remote_ip_and_port(sock_, ip, port);
  11026. }
  11027. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  11028. int &port) const {
  11029. return detail::get_local_ip_and_port(sock_, ip, port);
  11030. }
  11031. inline socket_t SocketStream::socket() const { return sock_; }
  11032. inline time_t SocketStream::duration() const {
  11033. return static_cast<time_t>(
  11034. std::chrono::duration_cast<std::chrono::milliseconds>(
  11035. std::chrono::steady_clock::now() - start_time_)
  11036. .count());
  11037. }
  11038. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  11039. read_timeout_sec_ = sec;
  11040. read_timeout_usec_ = usec;
  11041. }
  11042. inline void SocketStream::set_max_timeout(time_t msec) {
  11043. max_timeout_msec_ = msec;
  11044. start_time_ = std::chrono::steady_clock::now();
  11045. }
  11046. inline void
  11047. SocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11048. read_interrupted_ = std::move(interrupted);
  11049. }
  11050. // Buffer stream implementation
  11051. inline bool BufferStream::is_readable() const { return true; }
  11052. inline bool BufferStream::wait_readable() const { return true; }
  11053. inline bool BufferStream::wait_writable() const { return true; }
  11054. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  11055. #if defined(_MSC_VER) && _MSC_VER < 1910
  11056. auto len_read = buffer._Copy_s(ptr, size, size, position);
  11057. #else
  11058. auto len_read = buffer.copy(ptr, size, position);
  11059. #endif
  11060. position += static_cast<size_t>(len_read);
  11061. return static_cast<ssize_t>(len_read);
  11062. }
  11063. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  11064. buffer.append(ptr, size);
  11065. return static_cast<ssize_t>(size);
  11066. }
  11067. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  11068. int & /*port*/) const {}
  11069. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  11070. int & /*port*/) const {}
  11071. inline socket_t BufferStream::socket() const { return 0; }
  11072. inline time_t BufferStream::duration() const { return 0; }
  11073. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  11074. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  11075. : MatcherBase(pattern) {
  11076. constexpr const char marker[] = "/:";
  11077. // One past the last ending position of a path param substring
  11078. std::size_t last_param_end = 0;
  11079. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11080. // Needed to ensure that parameter names are unique during matcher
  11081. // construction
  11082. // If exceptions are disabled, only last duplicate path
  11083. // parameter will be set
  11084. std::unordered_set<std::string> param_name_set;
  11085. #endif
  11086. while (true) {
  11087. const auto marker_pos = pattern.find(
  11088. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  11089. if (marker_pos == std::string::npos) { break; }
  11090. static_fragments_.push_back(
  11091. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  11092. const auto param_name_start = marker_pos + str_len(marker);
  11093. auto sep_pos = pattern.find(separator, param_name_start);
  11094. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  11095. auto param_name =
  11096. pattern.substr(param_name_start, sep_pos - param_name_start);
  11097. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11098. if (param_name_set.find(param_name) != param_name_set.cend()) {
  11099. std::string msg = "Encountered path parameter '" + param_name +
  11100. "' multiple times in route pattern '" + pattern + "'.";
  11101. throw std::invalid_argument(msg);
  11102. }
  11103. #endif
  11104. param_names_.push_back(std::move(param_name));
  11105. last_param_end = sep_pos + 1;
  11106. }
  11107. if (last_param_end < pattern.length()) {
  11108. static_fragments_.push_back(pattern.substr(last_param_end));
  11109. }
  11110. }
  11111. inline bool PathParamsMatcher::match(Request &request) const {
  11112. request.matches = std::smatch();
  11113. request.path_params.clear();
  11114. // A pattern without parameters is just a literal path to compare against
  11115. if (param_names_.empty()) { return request.path == pattern(); }
  11116. request.path_params.reserve(param_names_.size());
  11117. // One past the position at which the path matched the pattern last time
  11118. std::size_t starting_pos = 0;
  11119. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  11120. const auto &fragment = static_fragments_[i];
  11121. if (starting_pos + fragment.length() > request.path.length()) {
  11122. return false;
  11123. }
  11124. // Avoid unnecessary allocation by using strncmp instead of substr +
  11125. // comparison
  11126. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  11127. fragment.length()) != 0) {
  11128. return false;
  11129. }
  11130. starting_pos += fragment.length();
  11131. // Should only happen when we have a static fragment after a param
  11132. // Example: '/users/:id/subscriptions'
  11133. // The 'subscriptions' fragment here does not have a corresponding param
  11134. if (i >= param_names_.size()) { continue; }
  11135. auto sep_pos = request.path.find(separator, starting_pos);
  11136. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  11137. const auto &param_name = param_names_[i];
  11138. request.path_params.emplace(
  11139. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  11140. // Mark everything up to '/' as matched
  11141. starting_pos = sep_pos + 1;
  11142. }
  11143. // Returns false if the path is longer than the pattern
  11144. return starting_pos >= request.path.length();
  11145. }
  11146. inline bool RegexMatcher::match(Request &request) const {
  11147. request.path_params.clear();
  11148. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  11149. // a non-match rather than risking a stack overflow in std::regex_match.
  11150. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  11151. return false;
  11152. }
  11153. return std::regex_match(request.path, request.matches, regex_);
  11154. }
  11155. // Enclose IPv6 address in brackets if needed
  11156. inline std::string prepare_host_string(const std::string &host) {
  11157. // Enclose IPv6 address in brackets (but not if already enclosed)
  11158. if (host.find(':') == std::string::npos ||
  11159. (!host.empty() && host[0] == '[')) {
  11160. // IPv4, hostname, or already bracketed IPv6
  11161. return host;
  11162. } else {
  11163. // IPv6 address without brackets
  11164. return "[" + host + "]";
  11165. }
  11166. }
  11167. inline std::string make_host_and_port_string(const std::string &host, int port,
  11168. bool is_ssl) {
  11169. auto result = prepare_host_string(host);
  11170. // Append port if not default
  11171. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  11172. ; // do nothing
  11173. } else {
  11174. result += ":" + std::to_string(port);
  11175. }
  11176. return result;
  11177. }
  11178. // Create "host:port" string always including port number (for CONNECT method)
  11179. inline std::string
  11180. make_host_and_port_string_always_port(const std::string &host, int port) {
  11181. return prepare_host_string(host) + ":" + std::to_string(port);
  11182. }
  11183. // Where a client connects for `host`, as one string: the mapped address or
  11184. // name, or `host` itself.
  11185. inline std::string
  11186. addr_map_target(const std::map<std::string, std::string> &addr_map,
  11187. const std::string &host) {
  11188. std::string connect_host;
  11189. std::string ip;
  11190. apply_addr_map(addr_map, host, connect_host, ip);
  11191. return ip.empty() ? connect_host : ip;
  11192. }
  11193. // Request target of a CONNECT for `host`, with `addr_map` applied.
  11194. inline std::string
  11195. make_connect_request_target(const std::map<std::string, std::string> &addr_map,
  11196. const std::string &host, int port) {
  11197. return make_host_and_port_string_always_port(addr_map_target(addr_map, host),
  11198. port);
  11199. }
  11200. // Value for the Host header a client sends when the caller supplied none.
  11201. // Only the value: callers decide where in their header list it goes.
  11202. inline std::string make_default_host_header_value(const std::string &host,
  11203. int port, bool is_ssl,
  11204. int address_family) {
  11205. if (address_family == AF_UNIX) { return "localhost"; }
  11206. return make_host_and_port_string(host, port, is_ssl);
  11207. }
  11208. inline void add_default_user_agent_header(Request &req) {
  11209. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  11210. if (!req.has_header("User-Agent")) {
  11211. req.set_header("User-Agent",
  11212. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  11213. }
  11214. #else
  11215. (void)req;
  11216. #endif
  11217. }
  11218. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  11219. NormalizedTarget normalize_target(const std::string &host);
  11220. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  11221. bool host_matches_no_proxy(const NormalizedTarget &target,
  11222. const std::vector<NoProxyEntry> &entries);
  11223. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  11224. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  11225. if (prefix_bits == 0) { return true; }
  11226. int full_bytes = prefix_bits / 8;
  11227. int rem_bits = prefix_bits % 8;
  11228. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  11229. static_cast<size_t>(full_bytes)) != 0) {
  11230. return false;
  11231. }
  11232. if (rem_bits == 0) { return true; }
  11233. auto i = static_cast<size_t>(full_bytes);
  11234. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  11235. return (ip[i] & mask) == (net[i] & mask);
  11236. }
  11237. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  11238. if (token.empty()) { return false; }
  11239. if (token == "*") {
  11240. out.kind = NoProxyKind::Wildcard;
  11241. return true;
  11242. }
  11243. auto slash = token.find('/');
  11244. std::string addr_part =
  11245. (slash == std::string::npos) ? token : token.substr(0, slash);
  11246. std::string prefix_part =
  11247. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  11248. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  11249. // don't silently treat it as a /32 (or /128).
  11250. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  11251. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  11252. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  11253. // when brackets are present.
  11254. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  11255. addr_part.back() == ']';
  11256. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  11257. if (!bracketed) {
  11258. struct in_addr v4;
  11259. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  11260. int prefix = 32;
  11261. if (!prefix_part.empty() &&
  11262. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  11263. prefix)) {
  11264. return false;
  11265. }
  11266. out.kind = NoProxyKind::IPv4Cidr;
  11267. std::memcpy(out.net.data(), &v4, sizeof(v4));
  11268. out.prefix_bits = prefix;
  11269. return true;
  11270. }
  11271. }
  11272. struct in6_addr v6;
  11273. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  11274. int prefix = 128;
  11275. if (!prefix_part.empty() &&
  11276. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  11277. prefix)) {
  11278. return false;
  11279. }
  11280. out.kind = NoProxyKind::IPv6Cidr;
  11281. std::memcpy(out.net.data(), &v6, sizeof(v6));
  11282. out.prefix_bits = prefix;
  11283. return true;
  11284. }
  11285. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  11286. // the entry is malformed — don't fall through to the hostname branch.
  11287. if (bracketed) { return false; }
  11288. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  11289. if (slash != std::string::npos) { return false; }
  11290. // Port-specific entries (host:port) are not supported.
  11291. if (token.find(':') != std::string::npos) { return false; }
  11292. std::string hostname = case_ignore::to_lower(token);
  11293. while (!hostname.empty() && hostname.front() == '.') {
  11294. hostname.erase(hostname.begin());
  11295. }
  11296. while (!hostname.empty() && hostname.back() == '.') {
  11297. hostname.pop_back();
  11298. }
  11299. if (hostname.empty()) { return false; }
  11300. out.kind = NoProxyKind::HostnameSuffix;
  11301. out.hostname_pattern = std::move(hostname);
  11302. return true;
  11303. }
  11304. inline std::vector<NoProxyEntry>
  11305. parse_no_proxy_entries(const std::vector<std::string> &patterns) {
  11306. std::vector<NoProxyEntry> entries;
  11307. entries.reserve(patterns.size());
  11308. for (const auto &p : patterns) {
  11309. auto trimmed = trim_copy(p);
  11310. if (trimmed.empty()) { continue; }
  11311. NoProxyEntry entry;
  11312. if (parse_no_proxy_entry(trimmed, entry)) {
  11313. entries.push_back(std::move(entry));
  11314. }
  11315. }
  11316. return entries;
  11317. }
  11318. inline NormalizedTarget normalize_target(const std::string &host) {
  11319. NormalizedTarget t;
  11320. std::string h = host;
  11321. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  11322. h = h.substr(1, h.size() - 2);
  11323. }
  11324. // Strip a single trailing dot so "example.com." canonicalizes to
  11325. // "example.com".
  11326. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  11327. t.hostname = case_ignore::to_lower(h);
  11328. if (!t.hostname.empty()) {
  11329. struct in_addr v4;
  11330. struct in6_addr v6;
  11331. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  11332. t.is_ipv4 = true;
  11333. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  11334. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  11335. t.is_ipv6 = true;
  11336. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  11337. }
  11338. }
  11339. return t;
  11340. }
  11341. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  11342. const std::vector<NoProxyEntry> &entries) {
  11343. if (target.hostname.empty()) { return false; }
  11344. for (const auto &e : entries) {
  11345. switch (e.kind) {
  11346. case NoProxyKind::Wildcard: return true;
  11347. case NoProxyKind::IPv4Cidr:
  11348. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11349. return true;
  11350. }
  11351. break;
  11352. case NoProxyKind::IPv6Cidr:
  11353. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11354. return true;
  11355. }
  11356. break;
  11357. case NoProxyKind::HostnameSuffix:
  11358. if (target.is_ipv4 || target.is_ipv6) { break; }
  11359. if (target.hostname == e.hostname_pattern) { return true; }
  11360. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  11361. // an entry of "example.com".
  11362. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  11363. auto offset = target.hostname.size() - e.hostname_pattern.size();
  11364. if (target.hostname[offset - 1] == '.' &&
  11365. target.hostname.compare(offset, e.hostname_pattern.size(),
  11366. e.hostname_pattern) == 0) {
  11367. return true;
  11368. }
  11369. }
  11370. break;
  11371. }
  11372. }
  11373. return false;
  11374. }
  11375. template <typename T>
  11376. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11377. T header_writer, Error &error) {
  11378. for (const auto &h : headers) {
  11379. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11380. error = Error::InvalidHeaders;
  11381. return false;
  11382. }
  11383. }
  11384. if (header_writer(strm, headers) <= 0) {
  11385. error = Error::Write;
  11386. return false;
  11387. }
  11388. return true;
  11389. }
  11390. } // namespace detail
  11391. /*
  11392. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11393. */
  11394. #ifdef CPPHTTPLIB_SSL_ENABLED
  11395. namespace detail {
  11396. // SSL socket stream implementation
  11397. inline SSLSocketStream::SSLSocketStream(
  11398. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11399. time_t read_timeout_usec, time_t write_timeout_sec,
  11400. time_t write_timeout_usec, time_t max_timeout_msec,
  11401. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11402. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11403. read_timeout_usec_(read_timeout_usec),
  11404. write_timeout_sec_(write_timeout_sec),
  11405. write_timeout_usec_(write_timeout_usec),
  11406. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11407. tls_error_.code = tls::ErrorCode::Success;
  11408. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11409. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11410. // Note: create_session() also clears this, but SSLClient currently
  11411. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11412. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11413. // SSL session was created.
  11414. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11415. #endif
  11416. }
  11417. inline SSLSocketStream::~SSLSocketStream() = default;
  11418. inline bool SSLSocketStream::is_readable() const {
  11419. return tls::pending(session_) > 0;
  11420. }
  11421. inline bool SSLSocketStream::wait_readable() const {
  11422. if (max_timeout_msec_ <= 0) {
  11423. return select_read_interruptible(sock_, read_timeout_sec_,
  11424. read_timeout_usec_, read_interrupted_) > 0;
  11425. }
  11426. time_t read_timeout_sec;
  11427. time_t read_timeout_usec;
  11428. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11429. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11430. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11431. read_interrupted_) > 0;
  11432. }
  11433. inline bool SSLSocketStream::wait_writable() const {
  11434. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11435. !tls::is_peer_closed(session_, sock_);
  11436. }
  11437. inline bool SSLSocketStream::ensure_readable() {
  11438. if (readable_hint_) {
  11439. readable_hint_ = false;
  11440. return true;
  11441. }
  11442. return wait_readable();
  11443. }
  11444. inline bool SSLSocketStream::is_peer_alive() const {
  11445. return !tls::is_peer_closed(session_, sock_);
  11446. }
  11447. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11448. if (tls::pending(session_) > 0) {
  11449. tls::TlsError err;
  11450. auto ret = tls::read(session_, ptr, size, err);
  11451. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11452. error_ = Error::ConnectionClosed;
  11453. } else if (ret < 0) {
  11454. tls_error_ = err;
  11455. }
  11456. return ret;
  11457. } else if (ensure_readable()) {
  11458. tls::TlsError err;
  11459. auto ret = tls::read(session_, ptr, size, err);
  11460. if (ret < 0) {
  11461. auto n = 1000;
  11462. #ifdef _WIN32
  11463. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11464. (err.code == tls::ErrorCode::SyscallError &&
  11465. WSAGetLastError() == WSAETIMEDOUT))) {
  11466. #else
  11467. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11468. #endif
  11469. if (tls::pending(session_) > 0) {
  11470. ret = tls::read(session_, ptr, size, err);
  11471. if (ret >= 0) { return ret; }
  11472. break;
  11473. } else if (wait_readable()) {
  11474. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11475. ret = tls::read(session_, ptr, size, err);
  11476. if (ret >= 0) { return ret; }
  11477. } else {
  11478. break;
  11479. }
  11480. }
  11481. assert(ret < 0);
  11482. tls_error_ = err;
  11483. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11484. error_ = Error::ConnectionClosed;
  11485. }
  11486. return ret;
  11487. } else {
  11488. error_ = Error::Timeout;
  11489. return -1;
  11490. }
  11491. }
  11492. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11493. if (wait_writable()) {
  11494. auto handle_size =
  11495. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11496. tls::TlsError err;
  11497. auto ret = tls::write(session_, ptr, handle_size, err);
  11498. if (ret < 0) {
  11499. auto n = 1000;
  11500. #ifdef _WIN32
  11501. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11502. (err.code == tls::ErrorCode::SyscallError &&
  11503. WSAGetLastError() == WSAETIMEDOUT))) {
  11504. #else
  11505. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11506. #endif
  11507. if (wait_writable()) {
  11508. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11509. ret = tls::write(session_, ptr, handle_size, err);
  11510. if (ret >= 0) { return ret; }
  11511. } else {
  11512. break;
  11513. }
  11514. }
  11515. assert(ret < 0);
  11516. tls_error_ = err;
  11517. }
  11518. return ret;
  11519. }
  11520. return -1;
  11521. }
  11522. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11523. int &port) const {
  11524. detail::get_remote_ip_and_port(sock_, ip, port);
  11525. }
  11526. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11527. int &port) const {
  11528. detail::get_local_ip_and_port(sock_, ip, port);
  11529. }
  11530. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11531. inline time_t SSLSocketStream::duration() const {
  11532. return static_cast<time_t>(
  11533. std::chrono::duration_cast<std::chrono::milliseconds>(
  11534. std::chrono::steady_clock::now() - start_time_)
  11535. .count());
  11536. }
  11537. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11538. read_timeout_sec_ = sec;
  11539. read_timeout_usec_ = usec;
  11540. }
  11541. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11542. max_timeout_msec_ = msec;
  11543. start_time_ = std::chrono::steady_clock::now();
  11544. }
  11545. inline void
  11546. SSLSocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11547. read_interrupted_ = std::move(interrupted);
  11548. }
  11549. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11550. tls::session_t session,
  11551. time_t read_timeout_sec,
  11552. time_t read_timeout_usec,
  11553. time_t write_timeout_sec,
  11554. time_t write_timeout_usec)
  11555. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11556. read_timeout_usec_(read_timeout_usec),
  11557. write_timeout_sec_(write_timeout_sec),
  11558. write_timeout_usec_(write_timeout_usec),
  11559. start_time_(std::chrono::steady_clock::now().time_since_epoch().count()) {
  11560. // The receive and send paths run on different threads, so each TLS call is
  11561. // driven in non-blocking mode and readiness is awaited with select()
  11562. // outside the session lock. Set the socket non-blocking once here; it is
  11563. // never flipped back, so no thread races on the flag.
  11564. detail::set_nonblocking(sock_, true);
  11565. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11566. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11567. #endif
  11568. }
  11569. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11570. inline bool WebSocketSSLStream::is_readable() const {
  11571. std::lock_guard<std::mutex> guard(session_mutex_);
  11572. return tls::pending(session_) > 0;
  11573. }
  11574. inline bool WebSocketSSLStream::wait_readable() const {
  11575. auto max_timeout_msec = max_timeout_msec_.load();
  11576. if (max_timeout_msec <= 0) {
  11577. return select_read_interruptible(sock_, read_timeout_sec_,
  11578. read_timeout_usec_, read_interrupted_) > 0;
  11579. }
  11580. time_t read_timeout_sec;
  11581. time_t read_timeout_usec;
  11582. calc_actual_timeout(max_timeout_msec, duration(), read_timeout_sec_,
  11583. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11584. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11585. read_interrupted_) > 0;
  11586. }
  11587. inline bool WebSocketSSLStream::wait_writable() const {
  11588. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11589. // that probe toggles the socket's blocking flag, which would race with the
  11590. // concurrent reader on a permanently non-blocking socket.
  11591. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11592. }
  11593. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11594. tls::TlsError err;
  11595. auto n = 1000;
  11596. while (--n >= 0) {
  11597. {
  11598. std::lock_guard<std::mutex> guard(session_mutex_);
  11599. auto ret = tls::read(session_, ptr, size, err);
  11600. if (ret > 0) { return ret; }
  11601. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11602. error_ = Error::ConnectionClosed;
  11603. return ret;
  11604. }
  11605. }
  11606. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11607. // direction: the send path shares this session, so output it left pending
  11608. // has to be flushed before more input can be decrypted. Anything else is
  11609. // a hard error.
  11610. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11611. #ifdef _WIN32
  11612. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11613. needs_readable =
  11614. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11615. WSAGetLastError() == WSAETIMEDOUT);
  11616. #endif
  11617. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11618. error_ = Error::Read;
  11619. return -1;
  11620. }
  11621. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11622. error_ = Error::Timeout;
  11623. return -1;
  11624. }
  11625. }
  11626. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11627. // to tell a timeout from a close would otherwise see whatever the previous
  11628. // failure left behind (error_ is never cleared on success).
  11629. error_ = Error::Read;
  11630. return -1;
  11631. }
  11632. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11633. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11634. tls::TlsError err;
  11635. auto n = 1000;
  11636. while (--n >= 0) {
  11637. {
  11638. std::lock_guard<std::mutex> guard(session_mutex_);
  11639. auto ret = tls::write(session_, ptr, handle_size, err);
  11640. if (ret >= 0) { return ret; }
  11641. }
  11642. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11643. // or a post-handshake message must be consumed before the record goes
  11644. // out. Anything else is a hard error.
  11645. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11646. #ifdef _WIN32
  11647. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11648. needs_writable =
  11649. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11650. WSAGetLastError() == WSAETIMEDOUT);
  11651. #endif
  11652. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11653. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11654. }
  11655. return -1;
  11656. }
  11657. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11658. int &port) const {
  11659. detail::get_remote_ip_and_port(sock_, ip, port);
  11660. }
  11661. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11662. int &port) const {
  11663. detail::get_local_ip_and_port(sock_, ip, port);
  11664. }
  11665. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11666. inline time_t WebSocketSSLStream::duration() const {
  11667. auto start = std::chrono::steady_clock::time_point(
  11668. std::chrono::steady_clock::duration(start_time_.load()));
  11669. return static_cast<time_t>(
  11670. std::chrono::duration_cast<std::chrono::milliseconds>(
  11671. std::chrono::steady_clock::now() - start)
  11672. .count());
  11673. }
  11674. // Start time first: a reader that sees the new bound also sees its start
  11675. inline void WebSocketSSLStream::set_max_timeout(time_t msec) {
  11676. start_time_ = std::chrono::steady_clock::now().time_since_epoch().count();
  11677. max_timeout_msec_ = msec;
  11678. }
  11679. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11680. read_timeout_sec_ = sec;
  11681. read_timeout_usec_ = usec;
  11682. }
  11683. inline void
  11684. WebSocketSSLStream::set_read_interrupt(std::function<bool()> interrupted) {
  11685. read_interrupted_ = std::move(interrupted);
  11686. }
  11687. } // namespace detail
  11688. #endif // CPPHTTPLIB_SSL_ENABLED
  11689. /*
  11690. * Group 4: Server implementation
  11691. */
  11692. // HTTP server implementation
  11693. inline Server::Server()
  11694. : new_task_queue([] {
  11695. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11696. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11697. }) {
  11698. #ifndef _WIN32
  11699. signal(SIGPIPE, SIG_IGN);
  11700. #endif
  11701. }
  11702. inline Server::~Server() = default;
  11703. inline std::unique_ptr<detail::MatcherBase>
  11704. Server::make_matcher(const std::string &pattern) {
  11705. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11706. // a path params pattern
  11707. if (pattern.find("/:") != std::string::npos) {
  11708. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11709. }
  11710. // A pattern with no regex metacharacter only has to be compared literally,
  11711. // which is what PathParamsMatcher already does when it captures no
  11712. // parameter, so std::regex is only worth building for the patterns that
  11713. // actually need it
  11714. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11715. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11716. }
  11717. return detail::make_unique<detail::RegexMatcher>(pattern);
  11718. }
  11719. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11720. return add_handler(get_handlers_, pattern, std::move(handler));
  11721. }
  11722. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11723. return add_handler(post_handlers_, pattern, std::move(handler));
  11724. }
  11725. inline Server &Server::Post(const std::string &pattern,
  11726. HandlerWithContentReader handler) {
  11727. return add_handler(post_handlers_for_content_reader_, pattern,
  11728. std::move(handler));
  11729. }
  11730. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11731. return add_handler(put_handlers_, pattern, std::move(handler));
  11732. }
  11733. inline Server &Server::Put(const std::string &pattern,
  11734. HandlerWithContentReader handler) {
  11735. return add_handler(put_handlers_for_content_reader_, pattern,
  11736. std::move(handler));
  11737. }
  11738. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11739. return add_handler(patch_handlers_, pattern, std::move(handler));
  11740. }
  11741. inline Server &Server::Patch(const std::string &pattern,
  11742. HandlerWithContentReader handler) {
  11743. return add_handler(patch_handlers_for_content_reader_, pattern,
  11744. std::move(handler));
  11745. }
  11746. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11747. return add_handler(delete_handlers_, pattern, std::move(handler));
  11748. }
  11749. inline Server &Server::Delete(const std::string &pattern,
  11750. HandlerWithContentReader handler) {
  11751. return add_handler(delete_handlers_for_content_reader_, pattern,
  11752. std::move(handler));
  11753. }
  11754. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11755. return add_handler(options_handlers_, pattern, std::move(handler));
  11756. }
  11757. inline const std::set<std::string> &Server::builtin_methods() {
  11758. thread_local const std::set<std::string> methods{
  11759. "GET", "HEAD", "POST", "PUT", "DELETE",
  11760. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11761. return methods;
  11762. }
  11763. inline Server::CustomHandlerEntry *
  11764. Server::custom_entry_for_registration(const std::string &method) {
  11765. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11766. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11767. // routing() before the custom tables are consulted, so a route registered
  11768. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11769. // there and would be reachable, but they carry protocol-level meaning
  11770. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11771. // library does not route.
  11772. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11773. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11774. has_invalid_registration_ = true;
  11775. return nullptr;
  11776. }
  11777. return &custom_handlers_[method];
  11778. }
  11779. inline Server &Server::CustomRoute(const std::string &method,
  11780. const std::string &pattern,
  11781. Handler handler) {
  11782. auto *entry = custom_entry_for_registration(method);
  11783. if (!entry) { return *this; }
  11784. return add_handler(entry->handlers, pattern, std::move(handler));
  11785. }
  11786. inline Server &Server::CustomRoute(const std::string &method,
  11787. const std::string &pattern,
  11788. HandlerWithContentReader handler) {
  11789. auto *entry = custom_entry_for_registration(method);
  11790. if (!entry) { return *this; }
  11791. return add_handler(entry->handlers_for_content_reader, pattern,
  11792. std::move(handler));
  11793. }
  11794. inline const Server::CustomHandlerEntry *
  11795. Server::find_custom_entry(const std::string &method) const {
  11796. // find() alone would be correct here. The empty() check is what keeps the
  11797. // per-request cost off servers that never call CustomRoute(), which is the
  11798. // overwhelmingly common case; keep it rather than walking into the tree.
  11799. if (custom_handlers_.empty()) { return nullptr; }
  11800. auto it = custom_handlers_.find(method);
  11801. return it == custom_handlers_.end() ? nullptr : &it->second;
  11802. }
  11803. inline Server &Server::WebSocket(const std::string &pattern,
  11804. WebSocketHandler handler) {
  11805. websocket_handlers_.push_back(
  11806. {make_matcher(pattern), std::move(handler), nullptr});
  11807. return *this;
  11808. }
  11809. inline Server &Server::WebSocket(const std::string &pattern,
  11810. WebSocketHandler handler,
  11811. SubProtocolSelector sub_protocol_selector) {
  11812. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11813. std::move(sub_protocol_selector)});
  11814. return *this;
  11815. }
  11816. inline bool Server::set_base_dir(const std::string &dir,
  11817. const std::string &mount_point) {
  11818. return set_mount_point(mount_point, dir);
  11819. }
  11820. inline bool Server::set_mount_point(const std::string &mount_point,
  11821. const std::string &dir, Headers headers) {
  11822. detail::FileStat stat(dir);
  11823. if (stat.is_dir()) {
  11824. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11825. if (!mnt.empty() && mnt[0] == '/') {
  11826. // Without the resolved directory, a file could not be checked to be
  11827. // inside it.
  11828. std::string resolved_base;
  11829. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11830. return false;
  11831. }
  11832. #if defined(_WIN32)
  11833. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11834. resolved_base += '\\';
  11835. }
  11836. #else
  11837. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11838. #endif
  11839. base_dirs_.push_back(
  11840. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11841. return true;
  11842. }
  11843. }
  11844. return false;
  11845. }
  11846. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11847. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11848. if (it->mount_point == mount_point) {
  11849. base_dirs_.erase(it);
  11850. return true;
  11851. }
  11852. }
  11853. return false;
  11854. }
  11855. inline Server &
  11856. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11857. const std::string &mime) {
  11858. // Keyed as find_content_type() looks it up
  11859. auto key = detail::case_ignore::to_lower(ext);
  11860. if (!key.empty() && key[0] == '.') { key.erase(0, 1); }
  11861. file_extension_and_mimetype_map_[key] = mime;
  11862. return *this;
  11863. }
  11864. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11865. default_file_mimetype_ = mime;
  11866. return *this;
  11867. }
  11868. inline Server &Server::set_file_request_handler(Handler handler) {
  11869. file_request_handler_ = std::move(handler);
  11870. return *this;
  11871. }
  11872. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11873. std::true_type) {
  11874. error_handler_ = std::move(handler);
  11875. return *this;
  11876. }
  11877. inline Server &Server::set_error_handler_core(Handler handler,
  11878. std::false_type) {
  11879. error_handler_ = [handler](const Request &req, Response &res) {
  11880. handler(req, res);
  11881. return HandlerResponse::Handled;
  11882. };
  11883. return *this;
  11884. }
  11885. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11886. exception_handler_ = std::move(handler);
  11887. return *this;
  11888. }
  11889. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11890. pre_routing_handler_ = std::move(handler);
  11891. return *this;
  11892. }
  11893. inline Server &Server::set_post_routing_handler(Handler handler) {
  11894. post_routing_handler_ = std::move(handler);
  11895. return *this;
  11896. }
  11897. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11898. pre_request_handler_ = std::move(handler);
  11899. return *this;
  11900. }
  11901. inline Server &Server::set_logger(Logger logger) {
  11902. logger_ = std::move(logger);
  11903. return *this;
  11904. }
  11905. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11906. error_logger_ = std::move(error_logger);
  11907. return *this;
  11908. }
  11909. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11910. pre_compression_logger_ = std::move(logger);
  11911. return *this;
  11912. }
  11913. inline Server &
  11914. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11915. expect_100_continue_handler_ = std::move(handler);
  11916. return *this;
  11917. }
  11918. inline Server &Server::set_start_handler(StartHandler handler) {
  11919. start_handler_ = std::move(handler);
  11920. return *this;
  11921. }
  11922. inline Server &Server::set_address_family(int family) {
  11923. address_family_ = family;
  11924. return *this;
  11925. }
  11926. inline Server &Server::set_tcp_nodelay(bool on) {
  11927. tcp_nodelay_ = on;
  11928. return *this;
  11929. }
  11930. inline Server &Server::set_ipv6_v6only(bool on) {
  11931. ipv6_v6only_ = on;
  11932. return *this;
  11933. }
  11934. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11935. socket_options_ = std::move(socket_options);
  11936. return *this;
  11937. }
  11938. inline Server &Server::set_default_headers(Headers headers) {
  11939. default_headers_ = std::move(headers);
  11940. return *this;
  11941. }
  11942. inline Server &Server::set_header_writer(
  11943. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11944. header_writer_ = writer;
  11945. return *this;
  11946. }
  11947. inline Server &
  11948. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11949. trusted_proxies_.clear();
  11950. trusted_proxies_.reserve(proxies.size());
  11951. for (const auto &proxy : proxies) {
  11952. trusted_proxies_.push_back(detail::canonical_ip(proxy));
  11953. }
  11954. return *this;
  11955. }
  11956. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11957. keep_alive_max_count_ = count;
  11958. return *this;
  11959. }
  11960. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11961. keep_alive_timeout_sec_ = sec;
  11962. return *this;
  11963. }
  11964. template <class Rep, class Period>
  11965. inline Server &Server::set_keep_alive_timeout(
  11966. const std::chrono::duration<Rep, Period> &duration) {
  11967. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11968. set_keep_alive_timeout(sec);
  11969. });
  11970. return *this;
  11971. }
  11972. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11973. read_timeout_sec_ = sec;
  11974. read_timeout_usec_ = usec;
  11975. return *this;
  11976. }
  11977. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11978. write_timeout_sec_ = sec;
  11979. write_timeout_usec_ = usec;
  11980. return *this;
  11981. }
  11982. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11983. idle_interval_sec_ = sec;
  11984. idle_interval_usec_ = usec;
  11985. return *this;
  11986. }
  11987. inline Server &Server::set_payload_max_length(size_t length) {
  11988. payload_max_length_ = length;
  11989. return *this;
  11990. }
  11991. inline Server &Server::set_compress(bool on) {
  11992. compress_ = on;
  11993. return *this;
  11994. }
  11995. inline Server &Server::set_static_file_compression(bool on) {
  11996. static_file_compression_ = on;
  11997. return *this;
  11998. }
  11999. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  12000. static_file_compression_min_length_ = length;
  12001. return *this;
  12002. }
  12003. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  12004. static_file_compression_max_length_ = length;
  12005. return *this;
  12006. }
  12007. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  12008. websocket_max_missed_pongs_ = count;
  12009. return *this;
  12010. }
  12011. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  12012. websocket_ping_interval_sec_ = sec;
  12013. return *this;
  12014. }
  12015. template <class Rep, class Period>
  12016. inline Server &Server::set_websocket_ping_interval(
  12017. const std::chrono::duration<Rep, Period> &duration) {
  12018. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  12019. set_websocket_ping_interval(sec);
  12020. });
  12021. return *this;
  12022. }
  12023. inline bool Server::bind_to_port(const std::string &host, int port,
  12024. int socket_flags) {
  12025. auto ret = bind_internal(host, port, socket_flags);
  12026. if (ret == -1) { is_decommissioned = true; }
  12027. return ret >= 0;
  12028. }
  12029. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  12030. auto ret = bind_internal(host, 0, socket_flags);
  12031. if (ret == -1) { is_decommissioned = true; }
  12032. return ret;
  12033. }
  12034. inline bool Server::listen_after_bind() { return listen_internal(); }
  12035. inline bool Server::listen(const std::string &host, int port,
  12036. int socket_flags) {
  12037. return bind_to_port(host, port, socket_flags) && listen_internal();
  12038. }
  12039. inline bool Server::is_running() const { return is_running_; }
  12040. inline void Server::wait_until_ready() const {
  12041. while (!is_running_ && !is_decommissioned) {
  12042. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12043. }
  12044. }
  12045. inline void Server::stop() noexcept {
  12046. // Release the listening socket whether or not the accept loop is running:
  12047. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  12048. // exchange is what makes this safe to call concurrently with the accept loop.
  12049. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  12050. if (sock != INVALID_SOCKET) {
  12051. detail::shutdown_socket(sock);
  12052. detail::close_socket(sock);
  12053. }
  12054. is_decommissioned = false;
  12055. }
  12056. inline void Server::decommission() { is_decommissioned = true; }
  12057. inline bool Server::parse_request_line(const char *s, Request &req) const {
  12058. auto len = strlen(s);
  12059. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  12060. len -= 2;
  12061. {
  12062. // RFC 9112 §3: exactly one SP between the method, the target and the
  12063. // version. Taking other whitespace as a separator too lets recipients
  12064. // that parse more strictly see a different request.
  12065. auto end = s + len;
  12066. if (std::count(s, end, ' ') != 2) { return false; }
  12067. auto sp1 = std::find(s, end, ' ');
  12068. auto sp2 = std::find(sp1 + 1, end, ' ');
  12069. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  12070. req.method.assign(s, sp1);
  12071. req.target.assign(sp1 + 1, sp2);
  12072. req.version.assign(sp2 + 1, end);
  12073. }
  12074. // A method outside the built-in set is accepted only when a handler has been
  12075. // registered for it with CustomRoute().
  12076. const auto &methods = builtin_methods();
  12077. if (methods.find(req.method) == methods.end() &&
  12078. !find_custom_entry(req.method)) {
  12079. output_error_log(Error::InvalidHTTPMethod, &req);
  12080. return false;
  12081. }
  12082. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  12083. output_error_log(Error::InvalidHTTPVersion, &req);
  12084. return false;
  12085. }
  12086. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  12087. // would leave this server routing a different path than a cache or a
  12088. // filter in front of it sees.
  12089. if (!detail::fields::is_request_target(req.target) ||
  12090. req.target.find('#') != std::string::npos) {
  12091. return false;
  12092. }
  12093. {
  12094. detail::divide(req.target, '?',
  12095. [&](const char *lhs_data, std::size_t lhs_size,
  12096. const char *rhs_data, std::size_t rhs_size) {
  12097. req.path =
  12098. decode_path_component(std::string(lhs_data, lhs_size));
  12099. detail::parse_query_text(rhs_data, rhs_size, req.params);
  12100. });
  12101. }
  12102. return true;
  12103. }
  12104. inline bool Server::write_response(Stream &strm, bool close_connection,
  12105. Request &req, Response &res) {
  12106. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  12107. // incorrectly to the error content.
  12108. req.ranges.clear();
  12109. return write_response_core(strm, close_connection, req, res, false);
  12110. }
  12111. inline bool Server::write_response_with_content(Stream &strm,
  12112. bool close_connection,
  12113. const Request &req,
  12114. Response &res) {
  12115. return write_response_core(strm, close_connection, req, res, true);
  12116. }
  12117. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  12118. const Request &req, Response &res,
  12119. bool need_apply_ranges) {
  12120. assert(res.status != -1);
  12121. if (400 <= res.status && error_handler_ &&
  12122. error_handler_(req, res) == HandlerResponse::Handled) {
  12123. need_apply_ranges = true;
  12124. }
  12125. // Before anything below reads res.headers, which the handlers may have
  12126. // filled directly
  12127. detail::erase_invalid_fields(res.headers);
  12128. if (!detail::body_allowed_for_status(res.status)) {
  12129. detail::clear_content(res);
  12130. }
  12131. detail::prefer_assigned_body(res);
  12132. std::string content_type;
  12133. std::string boundary;
  12134. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  12135. // Prepare additional headers
  12136. if (close_connection ||
  12137. detail::has_header_token(req.headers, "Connection", "close") ||
  12138. 400 <= res.status || // Don't leave connections open after errors
  12139. // The client withholds the body until `100 Continue`, which was never
  12140. // sent, so whether and when the body follows is unknown.
  12141. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  12142. // The body was left partway, e.g. by a content receiver that returned
  12143. // false, so the rest of it cannot be told from the next request.
  12144. (req.body_read_started_ && !req.body_consumed_)) {
  12145. res.set_header("Connection", "close");
  12146. } else {
  12147. std::string s = "timeout=";
  12148. s += std::to_string(keep_alive_timeout_sec_);
  12149. if (keep_alive_max_count_ > 0) {
  12150. s += ", max=";
  12151. s += std::to_string(keep_alive_max_count_);
  12152. }
  12153. res.set_header("Keep-Alive", s);
  12154. }
  12155. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  12156. !res.has_header("Content-Type")) {
  12157. res.set_header("Content-Type", "text/plain");
  12158. }
  12159. detail::set_framing_headers(req, res, boundary, content_type);
  12160. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  12161. res.set_header("Accept-Ranges", "bytes");
  12162. }
  12163. if (post_routing_handler_) {
  12164. post_routing_handler_(req, res);
  12165. detail::erase_invalid_fields(res.headers);
  12166. // Again, for a body or framing headers the handler changed.
  12167. detail::set_framing_headers(req, res, boundary, content_type);
  12168. }
  12169. // Response line and headers
  12170. detail::BufferStream bstrm;
  12171. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  12172. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  12173. // Combine a small body with the headers so the whole response leaves in a
  12174. // single write. A large body is written on its own instead: a copy of it
  12175. // costs more than the extra write saves.
  12176. auto send_body =
  12177. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  12178. auto body_is_separate = false;
  12179. auto provider_done = false;
  12180. if (send_body && !res.body.empty() && !res.content_provider_) {
  12181. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  12182. bstrm.write(res.body.data(), res.body.size());
  12183. } else {
  12184. body_is_separate = true;
  12185. }
  12186. } else if (send_body && res.content_provider_ &&
  12187. res.is_file_content_provider_ &&
  12188. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  12189. // A small file is read into the same buffer. Other providers may produce
  12190. // their data over time, so they are never held back.
  12191. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  12192. return false;
  12193. }
  12194. provider_done = true;
  12195. }
  12196. // Log before writing to avoid race condition with client-side code that
  12197. // accesses logger-captured data immediately after receiving the response.
  12198. output_log(req, res);
  12199. // Flush buffer
  12200. auto &data = bstrm.get_buffer();
  12201. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  12202. if (body_is_separate) {
  12203. return detail::write_data(strm, res.body.data(), res.body.size());
  12204. }
  12205. // Streaming body
  12206. if (send_body && res.content_provider_) {
  12207. if (!provider_done &&
  12208. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  12209. return false;
  12210. }
  12211. res.content_provider_success_ = true;
  12212. }
  12213. return true;
  12214. }
  12215. inline bool
  12216. Server::write_content_with_provider(Stream &strm, const Request &req,
  12217. Response &res, const std::string &boundary,
  12218. const std::string &content_type) {
  12219. auto is_shutting_down = [this]() { return is_stopping(); };
  12220. if (res.content_length_ > 0) {
  12221. if (!detail::is_partial_content(req, res)) {
  12222. return detail::write_content(strm, res.content_provider_, 0,
  12223. res.content_length_, is_shutting_down);
  12224. } else if (req.ranges.size() == 1) {
  12225. auto offset_and_length = detail::get_range_offset_and_length(
  12226. req.ranges[0], res.content_length_);
  12227. return detail::write_content(strm, res.content_provider_,
  12228. offset_and_length.first,
  12229. offset_and_length.second, is_shutting_down);
  12230. } else {
  12231. return detail::write_multipart_ranges_data(
  12232. strm, req, res, boundary, content_type, res.content_length_,
  12233. is_shutting_down);
  12234. }
  12235. } else {
  12236. if (res.is_chunked_content_provider_) {
  12237. // Use the coding `apply_ranges()` chose when it wrote the headers;
  12238. // re-negotiating here would disagree with them, e.g. once a handler's
  12239. // own Content-Encoding header suppresses the negotiation.
  12240. auto compressor = detail::make_compressor(res.content_coding_);
  12241. if (!compressor) {
  12242. compressor = detail::make_unique<detail::nocompressor>();
  12243. }
  12244. return detail::write_content_chunked(strm, res.content_provider_,
  12245. is_shutting_down, *compressor);
  12246. } else {
  12247. return detail::write_content_without_length(strm, res.content_provider_,
  12248. is_shutting_down);
  12249. }
  12250. }
  12251. }
  12252. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  12253. FormFields::iterator cur_field;
  12254. FormFiles::iterator cur_file;
  12255. auto is_text_field = false;
  12256. size_t count = 0;
  12257. if (read_content_core(
  12258. strm, req, res,
  12259. // Regular
  12260. [&](const char *buf, size_t n) {
  12261. // Prevent arithmetic overflow when checking sizes.
  12262. // Avoid computing (req.body.size() + n) directly because
  12263. // adding two unsigned `size_t` values can wrap around and
  12264. // produce a small result instead of indicating overflow.
  12265. // Instead, check using subtraction: ensure `n` does not
  12266. // exceed the remaining capacity `max_size() - size()`.
  12267. if (req.body.size() >= req.body.max_size() ||
  12268. n > req.body.max_size() - req.body.size()) {
  12269. return false;
  12270. }
  12271. // Limit decompressed body size to payload_max_length_ to protect
  12272. // against "zip bomb" attacks where a small compressed payload
  12273. // decompresses to a massive size.
  12274. if (payload_max_length_ > 0 &&
  12275. (req.body.size() >= payload_max_length_ ||
  12276. n > payload_max_length_ - req.body.size())) {
  12277. return false;
  12278. }
  12279. req.body.append(buf, n);
  12280. return true;
  12281. },
  12282. // Multipart FormData
  12283. [&](const FormData &file) {
  12284. if (CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT > 0 &&
  12285. count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  12286. output_error_log(Error::TooManyFormDataFiles, &req);
  12287. return false;
  12288. }
  12289. if (file.filename.empty()) {
  12290. cur_field = req.form.fields.emplace(
  12291. file.name, FormField{file.name, file.content, file.headers});
  12292. is_text_field = true;
  12293. } else {
  12294. cur_file = req.form.files.emplace(file.name, file);
  12295. is_text_field = false;
  12296. }
  12297. return true;
  12298. },
  12299. [&](const char *buf, size_t n) {
  12300. if (is_text_field) {
  12301. auto &content = cur_field->second.content;
  12302. if (content.size() + n > content.max_size()) { return false; }
  12303. content.append(buf, n);
  12304. } else {
  12305. auto &content = cur_file->second.content;
  12306. if (content.size() + n > content.max_size()) { return false; }
  12307. content.append(buf, n);
  12308. }
  12309. return true;
  12310. })) {
  12311. const auto &content_type = req.get_header_value("Content-Type");
  12312. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  12313. "application/x-www-form-urlencoded")) {
  12314. if (CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH > 0 &&
  12315. req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  12316. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  12317. output_error_log(Error::ExceedMaxPayloadSize, &req);
  12318. return false;
  12319. }
  12320. detail::parse_query_text(req.body, req.params);
  12321. }
  12322. return true;
  12323. }
  12324. return false;
  12325. }
  12326. inline bool Server::read_content_with_content_receiver(
  12327. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12328. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  12329. return read_content_core(strm, req, res, std::move(receiver),
  12330. std::move(multipart_header),
  12331. std::move(multipart_receiver));
  12332. }
  12333. inline bool Server::read_content_core(
  12334. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12335. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  12336. detail::FormDataParser multipart_form_data_parser;
  12337. ContentReceiverWithProgress out;
  12338. if (req.is_multipart_form_data()) {
  12339. const auto &content_type = req.get_header_value("Content-Type");
  12340. std::string boundary;
  12341. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  12342. res.status = StatusCode::BadRequest_400;
  12343. output_error_log(Error::MultipartParsing, &req);
  12344. return false;
  12345. }
  12346. multipart_form_data_parser.set_boundary(std::move(boundary));
  12347. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  12348. return multipart_form_data_parser.parse(buf, n, multipart_header,
  12349. multipart_receiver);
  12350. };
  12351. } else {
  12352. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  12353. size_t /*len*/) { return receiver(buf, n); };
  12354. }
  12355. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  12356. if (!req.has_header("Content-Length") &&
  12357. !detail::is_chunked_transfer_encoding(req.headers)) {
  12358. return true;
  12359. }
  12360. // A second read would start where the first one stopped, or in the next
  12361. // request.
  12362. if (req.body_read_started_) { return false; }
  12363. // The client is waiting for this before it sends the body.
  12364. if (req.expect_100_continue_pending_) {
  12365. req.expect_100_continue_pending_ = false;
  12366. detail::write_response_line(strm, StatusCode::Continue_100);
  12367. strm.write("\r\n");
  12368. }
  12369. // Set before reading, since a receiver may also stop by throwing.
  12370. req.body_read_started_ = true;
  12371. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  12372. out, true)) {
  12373. return false;
  12374. }
  12375. req.body_consumed_ = true;
  12376. if (req.is_multipart_form_data()) {
  12377. if (!multipart_form_data_parser.is_valid()) {
  12378. res.status = StatusCode::BadRequest_400;
  12379. output_error_log(Error::MultipartParsing, &req);
  12380. return false;
  12381. }
  12382. }
  12383. return true;
  12384. }
  12385. inline bool Server::handle_file_request(Request &req, Response &res) {
  12386. if (!detail::is_valid_path(req.path)) { return false; }
  12387. for (const auto &entry : base_dirs_) {
  12388. // Prefix match, on a path segment boundary. A mount point of "/mount"
  12389. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  12390. // One that already ends in '/' (the root mount among them) carries its own
  12391. // boundary; set_mount_point() guarantees the mount point is not empty.
  12392. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  12393. (entry.mount_point.back() == '/' ||
  12394. req.path.size() == entry.mount_point.size() ||
  12395. req.path[entry.mount_point.size()] == '/')) {
  12396. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  12397. auto path = entry.base_dir + sub_path;
  12398. if (path.back() == '/') { path += "index.html"; }
  12399. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12400. // but symlinks/junctions can still escape the base directory. A path
  12401. // that cannot be resolved, which includes one that does not exist, is
  12402. // not served from here.
  12403. std::string resolved_path;
  12404. if (!detail::canonicalize_path(path.c_str(), resolved_path)) { continue; }
  12405. if (!detail::is_path_within_base(resolved_path,
  12406. entry.resolved_base_dir)) {
  12407. res.status = StatusCode::Forbidden_403;
  12408. return true;
  12409. }
  12410. detail::FileStat stat(path);
  12411. if (stat.is_dir()) {
  12412. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12413. // in the name from reading as a scheme.
  12414. auto name = req.path.substr(req.path.rfind('/') + 1);
  12415. res.set_redirect("./" + encode_path_component(name) + "/",
  12416. StatusCode::MovedPermanently_301);
  12417. return true;
  12418. }
  12419. if (stat.is_file()) {
  12420. for (const auto &kv : entry.headers) {
  12421. res.set_header(kv.first, kv.second);
  12422. }
  12423. auto content_type = detail::find_content_type(
  12424. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12425. auto encoding = detail::EncodingType::None;
  12426. if (static_file_compression_) {
  12427. encoding = static_file_encoding(req, res, content_type, stat.size());
  12428. }
  12429. // The ETag names the representation actually sent, so a client that
  12430. // cached the compressed form revalidates against the compressed ETag
  12431. // and still gets a 304, while one that took identity keeps the plain
  12432. // ETag.
  12433. auto etag = detail::compute_etag(
  12434. stat, encoding == detail::EncodingType::None
  12435. ? std::string()
  12436. : std::string("-") + detail::encoding_name(encoding));
  12437. if (!etag.empty()) { res.set_header("ETag", etag); }
  12438. auto mtime = stat.mtime();
  12439. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12440. if (!last_modified.empty()) {
  12441. res.set_header("Last-Modified", last_modified);
  12442. }
  12443. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12444. check_if_range(req, etag, mtime);
  12445. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12446. if (!mm->is_open()) {
  12447. output_error_log(Error::OpenFile, &req);
  12448. return false;
  12449. }
  12450. detail::set_file_content_provider(res, mm, content_type, encoding);
  12451. if (req.method != "HEAD" && file_request_handler_) {
  12452. file_request_handler_(req, res);
  12453. }
  12454. return true;
  12455. } else {
  12456. output_error_log(Error::OpenFile, &req);
  12457. }
  12458. }
  12459. }
  12460. return false;
  12461. }
  12462. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12463. const std::string &etag,
  12464. time_t mtime) const {
  12465. // Handle conditional GET:
  12466. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12467. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12468. if (req.has_header("If-None-Match")) {
  12469. if (!etag.empty()) {
  12470. auto val =
  12471. detail::get_combined_header_value(req.headers, "If-None-Match");
  12472. // NOTE: We use exact string matching here. This works correctly
  12473. // because our server always generates weak ETags (W/"..."), and
  12474. // clients typically send back the same ETag they received.
  12475. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12476. // If-None-Match, where W/"x" and "x" would match, but this
  12477. // simplified implementation requires exact matches.
  12478. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12479. [&](const char *b, const char *e) {
  12480. auto seg_len = static_cast<size_t>(e - b);
  12481. return (seg_len == 1 && *b == '*') ||
  12482. (seg_len == etag.size() &&
  12483. std::equal(b, e, etag.begin()));
  12484. });
  12485. if (ret) {
  12486. res.status = StatusCode::NotModified_304;
  12487. return true;
  12488. }
  12489. }
  12490. } else if (req.has_header("If-Modified-Since")) {
  12491. auto val = req.get_header_value("If-Modified-Since");
  12492. auto t = detail::parse_http_date(val);
  12493. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12494. res.status = StatusCode::NotModified_304;
  12495. return true;
  12496. }
  12497. }
  12498. return false;
  12499. }
  12500. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12501. time_t mtime) const {
  12502. // Handle If-Range for partial content requests (RFC 9110
  12503. // Section 13.1.5). If-Range is only evaluated when Range header is
  12504. // present. If the validator matches, serve partial content; otherwise
  12505. // serve full content.
  12506. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12507. auto val = req.get_header_value("If-Range");
  12508. auto is_valid_range = [&]() {
  12509. if (detail::is_strong_etag(val)) {
  12510. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12511. // comparison.
  12512. return (!etag.empty() && val == etag);
  12513. } else if (detail::is_weak_etag(val)) {
  12514. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12515. return false;
  12516. } else {
  12517. // HTTP-date comparison
  12518. auto t = detail::parse_http_date(val);
  12519. return (t != static_cast<time_t>(-1) && mtime <= t);
  12520. }
  12521. };
  12522. if (!is_valid_range()) {
  12523. // Validator doesn't match: ignore Range and serve full content
  12524. req.ranges.clear();
  12525. return false;
  12526. }
  12527. }
  12528. return true;
  12529. }
  12530. inline socket_t
  12531. Server::create_server_socket(const std::string &host, int port,
  12532. int socket_flags,
  12533. SocketOptions socket_options) const {
  12534. return detail::create_socket(
  12535. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12536. ipv6_v6only_, std::move(socket_options),
  12537. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12538. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12539. output_error_log(Error::BindIPAddress, nullptr);
  12540. return false;
  12541. }
  12542. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12543. output_error_log(Error::Listen, nullptr);
  12544. return false;
  12545. }
  12546. return true;
  12547. });
  12548. }
  12549. inline int Server::bind_internal(const std::string &host, int port,
  12550. int socket_flags) {
  12551. if (is_decommissioned) { return -1; }
  12552. if (!is_valid()) { return -1; }
  12553. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12554. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12555. if (port == 0) {
  12556. struct sockaddr_storage addr;
  12557. socklen_t addr_len = sizeof(addr);
  12558. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12559. &addr_len) == -1) {
  12560. output_error_log(Error::GetSockName, nullptr);
  12561. return -1;
  12562. }
  12563. if (addr.ss_family == AF_INET) {
  12564. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12565. } else if (addr.ss_family == AF_INET6) {
  12566. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12567. } else {
  12568. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12569. return -1;
  12570. }
  12571. } else {
  12572. return port;
  12573. }
  12574. }
  12575. inline bool Server::listen_internal() {
  12576. // A stop() between bind and listen leaves nothing to accept on. Report
  12577. // failure instead of returning success without ever serving, and mark the
  12578. // server decommissioned the way any failed listen does so that a concurrent
  12579. // wait_until_ready() wakes up instead of spinning forever.
  12580. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12581. is_decommissioned = true;
  12582. return false;
  12583. }
  12584. auto ret = true;
  12585. is_running_ = true;
  12586. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12587. if (start_handler_) { start_handler_(); }
  12588. {
  12589. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12590. while (svr_sock_ != INVALID_SOCKET) {
  12591. #ifndef _WIN32
  12592. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12593. #endif
  12594. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12595. idle_interval_usec_);
  12596. if (val == 0) { // Timeout
  12597. task_queue->on_idle();
  12598. continue;
  12599. }
  12600. #ifndef _WIN32
  12601. }
  12602. #endif
  12603. #if defined _WIN32
  12604. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12605. // OVERLAPPED
  12606. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12607. #elif defined SOCK_CLOEXEC
  12608. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12609. #else
  12610. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12611. #endif
  12612. if (sock == INVALID_SOCKET) {
  12613. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12614. // touches the CRT errno, so the two have to be asked platform by
  12615. // platform rather than by testing errno here.
  12616. if (detail::is_accept_resource_error()) {
  12617. // The per-process descriptor limit or the network stack's buffer
  12618. // space has been reached. Try to accept new connections after a
  12619. // short sleep.
  12620. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12621. continue;
  12622. } else if (detail::is_accept_transient_error()) {
  12623. continue;
  12624. }
  12625. // Take the descriptor out of svr_sock_ before closing it: a later
  12626. // stop() would otherwise shutdown()/close() a value the OS may have
  12627. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12628. // gone. The exchange also settles the race with a concurrent stop(),
  12629. // since whichever side takes the descriptor closes it exactly once.
  12630. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12631. if (listen_sock != INVALID_SOCKET) {
  12632. detail::close_socket(listen_sock);
  12633. ret = false;
  12634. output_error_log(Error::Connection, nullptr);
  12635. } else {
  12636. ; // The server socket was closed by user.
  12637. }
  12638. break;
  12639. }
  12640. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12641. read_timeout_sec_, read_timeout_usec_);
  12642. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12643. write_timeout_sec_, write_timeout_usec_);
  12644. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12645. if (!task_queue->enqueue(
  12646. [this, sock]() { process_and_close_socket(sock); })) {
  12647. output_error_log(Error::ResourceExhaustion, nullptr);
  12648. detail::shutdown_socket(sock);
  12649. detail::close_socket(sock);
  12650. }
  12651. }
  12652. task_queue->shutdown();
  12653. }
  12654. is_decommissioned = !ret;
  12655. return ret;
  12656. }
  12657. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  12658. // Call from a catch block. The response is a 500 unless the exception handler
  12659. // sets another status. Returns whether the exception handler ran.
  12660. inline bool Server::handle_exception(Request &req, Response &res) {
  12661. res.status = StatusCode::InternalServerError_500;
  12662. if (!exception_handler_) { return false; }
  12663. exception_handler_(req, res, std::current_exception());
  12664. return true;
  12665. }
  12666. #endif
  12667. inline bool Server::routing(Request &req, Response &res, Stream &strm,
  12668. bool skip_pre_routing) {
  12669. if (!skip_pre_routing && pre_routing_handler_ &&
  12670. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12671. return true;
  12672. }
  12673. // File handler
  12674. if ((req.method == "GET" || req.method == "HEAD") &&
  12675. handle_file_request(req, res)) {
  12676. return true;
  12677. }
  12678. const auto *custom = find_custom_entry(req.method);
  12679. // The second clause mirrors what expect_content() does unconditionally for
  12680. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12681. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12682. // `allprop`) would skip its handler and fall through to 404.
  12683. if (detail::expect_content(req) ||
  12684. (custom && !custom->handlers_for_content_reader.empty())) {
  12685. // Content reader handler
  12686. {
  12687. // Track whether the ContentReader was aborted due to the decompressed
  12688. // payload exceeding `payload_max_length_`.
  12689. // The user handler runs after the lambda returns, so we must restore the
  12690. // 413 status if the handler overwrites it.
  12691. bool content_reader_payload_too_large = false;
  12692. ContentReader reader(
  12693. [&](ContentReceiver receiver) {
  12694. auto result = read_content_with_content_receiver(
  12695. strm, req, res, std::move(receiver), nullptr, nullptr);
  12696. if (!result) {
  12697. output_error_log(Error::Read, &req);
  12698. if (res.status == StatusCode::PayloadTooLarge_413) {
  12699. content_reader_payload_too_large = true;
  12700. }
  12701. }
  12702. return result;
  12703. },
  12704. [&](FormDataHeader header, ContentReceiver receiver) {
  12705. auto result = read_content_with_content_receiver(
  12706. strm, req, res, nullptr, std::move(header),
  12707. std::move(receiver));
  12708. if (!result) {
  12709. output_error_log(Error::Read, &req);
  12710. if (res.status == StatusCode::PayloadTooLarge_413) {
  12711. content_reader_payload_too_large = true;
  12712. }
  12713. }
  12714. return result;
  12715. });
  12716. bool dispatched = false;
  12717. if (req.method == "POST") {
  12718. dispatched = dispatch_request_for_content_reader(
  12719. req, res, std::move(reader), post_handlers_for_content_reader_);
  12720. } else if (req.method == "PUT") {
  12721. dispatched = dispatch_request_for_content_reader(
  12722. req, res, std::move(reader), put_handlers_for_content_reader_);
  12723. } else if (req.method == "PATCH") {
  12724. dispatched = dispatch_request_for_content_reader(
  12725. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12726. } else if (req.method == "DELETE") {
  12727. dispatched = dispatch_request_for_content_reader(
  12728. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12729. } else if (custom) {
  12730. dispatched = dispatch_request_for_content_reader(
  12731. req, res, std::move(reader), custom->handlers_for_content_reader);
  12732. }
  12733. if (dispatched) {
  12734. if (content_reader_payload_too_large) {
  12735. // Enforce the limit: override any status the handler may have set
  12736. // and return false so the error path sends a plain 413 response.
  12737. res.status = StatusCode::PayloadTooLarge_413;
  12738. detail::clear_content(res);
  12739. return false;
  12740. }
  12741. return true;
  12742. }
  12743. }
  12744. // NOTE: `req.body` is not read here. For a regular handler the body is
  12745. // read inside dispatch_request(), after the route has matched and the
  12746. // pre-request handler has approved the request, so that a rejected
  12747. // request (e.g. failed authentication) never forces us to buffer a
  12748. // potentially large body.
  12749. }
  12750. // Regular handler
  12751. if (req.method == "GET" || req.method == "HEAD") {
  12752. return dispatch_request(req, res, get_handlers_, strm);
  12753. } else if (req.method == "POST") {
  12754. return dispatch_request(req, res, post_handlers_, strm);
  12755. } else if (req.method == "PUT") {
  12756. return dispatch_request(req, res, put_handlers_, strm);
  12757. } else if (req.method == "DELETE") {
  12758. return dispatch_request(req, res, delete_handlers_, strm);
  12759. } else if (req.method == "OPTIONS") {
  12760. return dispatch_request(req, res, options_handlers_, strm);
  12761. } else if (req.method == "PATCH") {
  12762. return dispatch_request(req, res, patch_handlers_, strm);
  12763. } else if (custom) {
  12764. return dispatch_request(req, res, custom->handlers, strm);
  12765. }
  12766. res.status = StatusCode::BadRequest_400;
  12767. return false;
  12768. }
  12769. inline bool Server::dispatch_request(Request &req, Response &res,
  12770. const Handlers &handlers, Stream &strm) {
  12771. for (const auto &x : handlers) {
  12772. const auto &matcher = x.first;
  12773. const auto &handler = x.second;
  12774. if (matcher->match(req)) {
  12775. req.matched_route = matcher->pattern();
  12776. // Run the pre-request handler before reading the body so a rejected
  12777. // request (e.g. failed authentication) never forces us to buffer a
  12778. // potentially large body. `req.matched_route` is available here.
  12779. if (pre_request_handler_ &&
  12780. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12781. return true;
  12782. }
  12783. // The route matched and the request was approved; read the body now.
  12784. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12785. output_error_log(Error::Read, &req);
  12786. return false;
  12787. }
  12788. handler(req, res);
  12789. return true;
  12790. }
  12791. }
  12792. return false;
  12793. }
  12794. // Decides the content coding for a response served straight from a file. Both
  12795. // the ETag, which has to name the representation actually sent, and
  12796. // `apply_static_file_compression()` go through this, so the two cannot drift
  12797. // apart.
  12798. inline detail::EncodingType
  12799. Server::static_file_encoding(const Request &req, const Response &res,
  12800. const std::string &content_type,
  12801. size_t length) const {
  12802. if (!static_file_compression_) { return detail::EncodingType::None; }
  12803. // Nothing to compress, and an empty file already answers with
  12804. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12805. // turn an empty body into a 20-byte gzip stream.
  12806. if (length == 0) { return detail::EncodingType::None; }
  12807. // A file that already fits in a single packet gains nothing from being made
  12808. // smaller, since it still travels in that one segment, and a file of a few
  12809. // bytes comes out larger than it went in.
  12810. if (length < static_file_compression_min_length_) {
  12811. return detail::EncodingType::None;
  12812. }
  12813. // RFC 9110 applies Range to the representation after content coding, so a
  12814. // compressed 206 would mean compressing the whole file and then slicing it.
  12815. // Serve ranges from the identity representation instead.
  12816. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12817. if (static_file_compression_max_length_ > 0 &&
  12818. length > static_file_compression_max_length_) {
  12819. return detail::EncodingType::None;
  12820. }
  12821. return detail::encoding_type(req, res, content_type);
  12822. }
  12823. // Compresses a file-backed content provider into `res.body`. Returns false when
  12824. // the response is left untouched.
  12825. inline bool Server::apply_static_file_compression(const Request &req,
  12826. Response &res) const {
  12827. auto type = res.content_coding_;
  12828. if (type == detail::EncodingType::None || !res.content_provider_) {
  12829. return false;
  12830. }
  12831. auto compressor = detail::make_compressor(type);
  12832. if (!compressor) { return false; }
  12833. output_pre_compression_log(req, res);
  12834. std::string compressed;
  12835. if (!detail::compress_content_provider(res.content_provider_,
  12836. res.content_length_, *compressor,
  12837. compressed)) {
  12838. return false;
  12839. }
  12840. res.body.swap(compressed);
  12841. // The provider was consumed in full, so its releaser hears about a success.
  12842. res.content_provider_success_ = true;
  12843. detail::clear_content_provider(res);
  12844. res.set_header("Content-Encoding", detail::encoding_name(type));
  12845. res.set_header("Vary", "Accept-Encoding");
  12846. return true;
  12847. }
  12848. inline void Server::apply_ranges(const Request &req, Response &res,
  12849. std::string &content_type,
  12850. std::string &boundary) const {
  12851. // A known-length content provider leaves `res.body` empty, so the compressor
  12852. // at the end of this function never runs for one (issue #2545). A file-backed
  12853. // provider is fully readable right here, so compress it and answer with an
  12854. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12855. // takes the same path as `set_content()` from here on. Range requests never
  12856. // get a content coding, so `Content-Range` still names identity bytes and
  12857. // none of the range handling below applies.
  12858. if (apply_static_file_compression(req, res)) { return; }
  12859. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12860. auto it = res.headers.find("Content-Type");
  12861. if (it != res.headers.end()) {
  12862. content_type = it->second;
  12863. res.headers.erase(it);
  12864. }
  12865. boundary = detail::make_multipart_data_boundary();
  12866. res.set_header("Content-Type",
  12867. "multipart/byteranges; boundary=" + boundary);
  12868. }
  12869. auto type =
  12870. compress_ ? detail::encoding_type(req, res) : detail::EncodingType::None;
  12871. if (res.body.empty()) {
  12872. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  12873. res.status == StatusCode::PartialContent_206) {
  12874. auto offset_and_length = detail::get_range_offset_and_length(
  12875. req.ranges[0], res.content_length_);
  12876. auto content_range = detail::make_content_range_header_field(
  12877. offset_and_length, res.content_length_);
  12878. res.set_header("Content-Range", content_range);
  12879. } else if (res.is_chunked_content_provider_) {
  12880. res.content_coding_ = type;
  12881. if (type != detail::EncodingType::None) {
  12882. res.set_header("Content-Encoding", detail::encoding_name(type));
  12883. res.set_header("Vary", "Accept-Encoding");
  12884. }
  12885. }
  12886. } else {
  12887. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12888. ;
  12889. } else if (req.ranges.size() == 1) {
  12890. auto offset_and_length =
  12891. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12892. auto offset = offset_and_length.first;
  12893. auto length = offset_and_length.second;
  12894. auto content_range = detail::make_content_range_header_field(
  12895. offset_and_length, res.body.size());
  12896. res.set_header("Content-Range", content_range);
  12897. assert(offset + length <= res.body.size());
  12898. res.body = res.body.substr(offset, length);
  12899. } else {
  12900. std::string data;
  12901. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12902. res.body.size(), data);
  12903. res.body.swap(data);
  12904. }
  12905. if (type != detail::EncodingType::None) {
  12906. output_pre_compression_log(req, res);
  12907. if (auto compressor = detail::make_compressor(type)) {
  12908. std::string compressed;
  12909. if (compressor->compress(res.body.data(), res.body.size(), true,
  12910. [&](const char *data, size_t data_len) {
  12911. compressed.append(data, data_len);
  12912. return true;
  12913. })) {
  12914. res.body.swap(compressed);
  12915. res.set_header("Content-Encoding", detail::encoding_name(type));
  12916. res.set_header("Vary", "Accept-Encoding");
  12917. }
  12918. }
  12919. }
  12920. res.content_length_ = res.body.size();
  12921. }
  12922. }
  12923. inline bool Server::dispatch_request_for_content_reader(
  12924. Request &req, Response &res, ContentReader content_reader,
  12925. const HandlersForContentReader &handlers) const {
  12926. for (const auto &x : handlers) {
  12927. const auto &matcher = x.first;
  12928. const auto &handler = x.second;
  12929. if (matcher->match(req)) {
  12930. req.matched_route = matcher->pattern();
  12931. if (!pre_request_handler_ ||
  12932. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12933. handler(req, res, content_reader);
  12934. }
  12935. return true;
  12936. }
  12937. }
  12938. return false;
  12939. }
  12940. inline std::string
  12941. get_client_ip(const std::string &x_forwarded_for,
  12942. const std::vector<std::string> &trusted_proxies) {
  12943. // X-Forwarded-For is a comma-separated list per RFC 7239
  12944. std::vector<std::string> ip_list;
  12945. detail::split(x_forwarded_for.data(),
  12946. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12947. [&](const char *b, const char *e) {
  12948. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12949. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12950. });
  12951. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12952. // no segments. Signal "no client IP derived" with an empty string so the
  12953. // caller can fall back to the connection-level remote address.
  12954. if (ip_list.empty()) { return std::string(); }
  12955. // Each hop appends the address it received the request from, so the rightmost
  12956. // entries are the ones written by our own infrastructure while the leftmost
  12957. // are whatever the original client chose to send. Walk from the right and
  12958. // skip trusted proxies; the first address that is not a trusted proxy is the
  12959. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12960. // from the left instead lets a client forge an arbitrary address by following
  12961. // it with a trusted proxy's address, which the left-to-right scan then
  12962. // returned as the client.
  12963. for (size_t i = ip_list.size(); i-- > 0;) {
  12964. const auto &ip = ip_list[i];
  12965. if (!detail::is_trusted_proxy(ip, trusted_proxies)) { return ip; }
  12966. }
  12967. // Every hop was a trusted proxy; fall back to the first entry.
  12968. return ip_list.front();
  12969. }
  12970. inline bool
  12971. Server::process_request(Stream &strm, const std::string &remote_addr,
  12972. int remote_port, const std::string &local_addr,
  12973. int local_port, bool close_connection,
  12974. bool &connection_closed,
  12975. const std::function<void(Request &)> &setup_request,
  12976. bool *websocket_upgraded) {
  12977. std::array<char, 2048> buf{};
  12978. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12979. // The read timeout bounds the request line and headers as a whole, so a
  12980. // client sending them a byte at a time cannot hold the worker any longer.
  12981. auto read_timeout_msec = read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000;
  12982. strm.set_max_timeout(read_timeout_msec);
  12983. // Connection has been closed on client
  12984. if (!line_reader.getline()) { return false; }
  12985. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12986. // clients send an extra CRLF after a request body, which would otherwise be
  12987. // parsed as the next request on a persistent connection.
  12988. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12989. return false;
  12990. }
  12991. Request req;
  12992. req.start_time_ = std::chrono::steady_clock::now();
  12993. req.remote_addr = remote_addr;
  12994. req.remote_port = remote_port;
  12995. req.local_addr = local_addr;
  12996. req.local_port = local_port;
  12997. Response res;
  12998. res.version = "HTTP/1.1";
  12999. res.headers = default_headers_;
  13000. // RFC 9112 §9.6: a server that sends the "close" connection option must
  13001. // close the connection after that response, whichever path wrote it (an
  13002. // error status, a handler, or a rejected request). Reading on would also
  13003. // parse whatever the client sent next on a connection it considers done.
  13004. auto honor_connection_close = detail::scope_exit([&] {
  13005. if (detail::has_header_token(res.headers, "Connection", "close")) {
  13006. connection_closed = true;
  13007. }
  13008. });
  13009. // Request line and headers. A rejected message leaves the rest of it (and
  13010. // any body) unread, so the connection cannot be reused: the leftover bytes
  13011. // would be parsed as the next request.
  13012. if (!parse_request_line(line_reader.ptr(), req)) {
  13013. connection_closed = true;
  13014. res.status = StatusCode::BadRequest_400;
  13015. output_error_log(Error::InvalidRequestLine, &req);
  13016. return write_response(strm, close_connection, req, res);
  13017. }
  13018. // Request headers
  13019. if (!detail::read_headers(strm, req.headers)) {
  13020. connection_closed = true;
  13021. res.status = StatusCode::BadRequest_400;
  13022. output_error_log(Error::InvalidHeaders, &req);
  13023. return write_response(strm, close_connection, req, res);
  13024. }
  13025. strm.set_max_timeout(0);
  13026. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  13027. // which would otherwise let an intermediary and this parser disagree on
  13028. // where the body ends and enable request smuggling. Three cases: a
  13029. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  13030. // or empty), which would otherwise be read as "no body"; a non-zero
  13031. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  13032. // tolerated for compatibility with existing clients); and a
  13033. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  13034. // length undeterminable. None of them may fall through to the "no body"
  13035. // path, or the body bytes are parsed as the next request on a persistent
  13036. // connection.
  13037. auto is_invalid_content_length = false;
  13038. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  13039. is_invalid_content_length);
  13040. if (is_invalid_content_length ||
  13041. detail::has_conflicting_content_length(req.headers) ||
  13042. (req.has_header("Transfer-Encoding") &&
  13043. !detail::is_chunked_transfer_encoding(req.headers))) {
  13044. connection_closed = true;
  13045. res.status = StatusCode::BadRequest_400;
  13046. return write_response(strm, close_connection, req, res);
  13047. }
  13048. // RFC 9112 6.1: a lone "chunked" is the only transfer coding implemented
  13049. if (req.has_header("Transfer-Encoding") &&
  13050. (req.get_header_value_count("Transfer-Encoding") != 1 ||
  13051. !detail::case_ignore::equal(req.get_header_value("Transfer-Encoding"),
  13052. "chunked"))) {
  13053. connection_closed = true;
  13054. res.status = StatusCode::NotImplemented_501;
  13055. return write_response(strm, close_connection, req, res);
  13056. }
  13057. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  13058. // HTTP/1.0 request, is honoured, but the connection closes after the
  13059. // response.
  13060. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  13061. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  13062. // value, or none in HTTP/1.1, so that every recipient of the request sees
  13063. // the same authority.
  13064. auto host_count = req.get_header_value_count("Host");
  13065. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  13066. !detail::fields::is_host(req.get_header_value("Host"))) {
  13067. connection_closed = true;
  13068. res.status = StatusCode::BadRequest_400;
  13069. output_error_log(Error::InvalidHeaders, &req);
  13070. return write_response(strm, close_connection, req, res);
  13071. }
  13072. // Check if the request URI doesn't exceed the limit
  13073. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13074. connection_closed = true;
  13075. res.status = StatusCode::UriTooLong_414;
  13076. output_error_log(Error::ExceedUriMaxLength, &req);
  13077. return write_response(strm, close_connection, req, res);
  13078. }
  13079. if (detail::has_header_token(req.headers, "Connection", "close")) {
  13080. connection_closed = true;
  13081. }
  13082. if (req.version == "HTTP/1.0" &&
  13083. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  13084. connection_closed = true;
  13085. }
  13086. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  13087. // itself a trusted proxy. Otherwise any direct client could spoof
  13088. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  13089. if (detail::is_trusted_proxy(remote_addr, trusted_proxies_) &&
  13090. req.has_header("X-Forwarded-For")) {
  13091. // Some proxies append the address they observed as a separate
  13092. // X-Forwarded-For field line instead of extending the one the client sent
  13093. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  13094. // be scanned. Reading only the first occurrence would hand back the
  13095. // client-supplied, and therefore forgeable, value.
  13096. auto x_forwarded_for =
  13097. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  13098. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  13099. req.remote_addr = derived.empty() ? remote_addr : derived;
  13100. } else {
  13101. req.remote_addr = remote_addr;
  13102. }
  13103. req.remote_port = remote_port;
  13104. req.local_addr = local_addr;
  13105. req.local_port = local_port;
  13106. if (req.has_header("Accept")) {
  13107. auto accept_header =
  13108. detail::get_combined_header_value(req.headers, "Accept");
  13109. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  13110. connection_closed = true;
  13111. res.status = StatusCode::BadRequest_400;
  13112. output_error_log(Error::HTTPParsing, &req);
  13113. return write_response(strm, close_connection, req, res);
  13114. }
  13115. }
  13116. // RFC 9110 14.2: range handling is defined only for GET (and so for HEAD)
  13117. if ((req.method == "GET" || req.method == "HEAD") &&
  13118. req.has_header("Range")) {
  13119. const auto &range_header_value = req.get_header_value("Range");
  13120. // RFC 9110 14.2: a range unit other than bytes must be ignored
  13121. auto unit = range_header_value.substr(0, range_header_value.find('='));
  13122. if (detail::case_ignore::equal(unit, "bytes") &&
  13123. !detail::parse_range_header(range_header_value, req.ranges)) {
  13124. connection_closed = true;
  13125. res.status = StatusCode::RangeNotSatisfiable_416;
  13126. output_error_log(Error::InvalidRangeHeader, &req);
  13127. return write_response(strm, close_connection, req, res);
  13128. }
  13129. }
  13130. if (setup_request) { setup_request(req); }
  13131. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  13132. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  13133. // must be ignored. An expectation we do not recognize is left alone; the
  13134. // 417 the section allows for one is a MAY, not a requirement.
  13135. //
  13136. // `100 Continue` itself is deferred until the body is actually read (see
  13137. // read_content_core), so a request rejected by a later handler never
  13138. // invites the client to send a body nobody will read.
  13139. if (req.version != "HTTP/1.0" &&
  13140. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  13141. int status = StatusCode::Continue_100;
  13142. if (expect_100_continue_handler_) {
  13143. status = expect_100_continue_handler_(req, res);
  13144. }
  13145. if (status == StatusCode::Continue_100) {
  13146. req.expect_100_continue_pending_ = true;
  13147. } else {
  13148. if (res.status == -1) { res.status = status; }
  13149. connection_closed = true;
  13150. return write_response(strm, true, req, res);
  13151. }
  13152. }
  13153. // Setup `is_connection_closed` method
  13154. auto sock = strm.socket();
  13155. req.is_connection_closed = [sock]() {
  13156. return !detail::is_socket_alive(sock);
  13157. };
  13158. // WebSocket upgrade
  13159. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  13160. // that authentication and other middleware can reject the request with an
  13161. // HTTP response (e.g., 401) before the protocol switches.
  13162. // The response says so when this connection closes after it.
  13163. auto close_after_response = close_connection || connection_closed;
  13164. // An upgrade request has been through pre-routing before it reaches routing()
  13165. auto is_upgrade = detail::is_websocket_upgrade(req);
  13166. if (is_upgrade) {
  13167. // A response given here leaves the body unread, and it would be parsed as
  13168. // the next request.
  13169. auto close_if_answered =
  13170. close_after_response || detail::has_framed_body(req);
  13171. const WebSocketHandlerEntry *ws_route = nullptr;
  13172. std::string selected_subprotocol;
  13173. auto answer_before_upgrade = [&]() -> bool {
  13174. if (pre_routing_handler_ &&
  13175. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  13176. return true;
  13177. }
  13178. for (const auto &entry : websocket_handlers_) {
  13179. if (!entry.matcher->match(req)) { continue; }
  13180. req.matched_route = entry.matcher->pattern();
  13181. if (pre_request_handler_ &&
  13182. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  13183. return true;
  13184. }
  13185. ws_route = &entry;
  13186. if (entry.sub_protocol_selector) {
  13187. auto protocol_header = detail::get_combined_header_value(
  13188. req.headers, "Sec-WebSocket-Protocol");
  13189. if (!protocol_header.empty()) {
  13190. std::vector<std::string> protocols;
  13191. detail::split(protocol_header.data(),
  13192. protocol_header.data() + protocol_header.size(), ',',
  13193. [&](const char *b, const char *e) {
  13194. protocols.emplace_back(b, e);
  13195. });
  13196. selected_subprotocol = entry.sub_protocol_selector(protocols);
  13197. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  13198. if (std::find(protocols.begin(), protocols.end(),
  13199. selected_subprotocol) == protocols.end()) {
  13200. selected_subprotocol.clear();
  13201. }
  13202. }
  13203. }
  13204. return false;
  13205. }
  13206. return false;
  13207. };
  13208. auto answered = false;
  13209. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13210. answered = answer_before_upgrade();
  13211. #else
  13212. try {
  13213. answered = answer_before_upgrade();
  13214. } catch (...) {
  13215. if (!handle_exception(req, res)) {
  13216. return write_response(strm, close_if_answered, req, res);
  13217. }
  13218. answered = true;
  13219. }
  13220. #endif
  13221. if (answered) {
  13222. if (res.status == -1) { res.status = StatusCode::OK_200; }
  13223. return write_response_with_content(strm, close_if_answered, req, res);
  13224. }
  13225. if (ws_route) {
  13226. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  13227. auto accept_key = detail::websocket_accept_key(client_key);
  13228. // Send 101 Switching Protocols
  13229. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  13230. "Upgrade: websocket\r\n"
  13231. "Connection: Upgrade\r\n"
  13232. "Sec-WebSocket-Accept: " +
  13233. accept_key + "\r\n";
  13234. if (!selected_subprotocol.empty()) {
  13235. if (!detail::fields::is_field_value(selected_subprotocol)) {
  13236. return false;
  13237. }
  13238. handshake_response +=
  13239. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  13240. }
  13241. handshake_response += "\r\n";
  13242. if (strm.write(handshake_response.data(), handshake_response.size()) <
  13243. 0) {
  13244. return false;
  13245. }
  13246. connection_closed = true;
  13247. if (websocket_upgraded) { *websocket_upgraded = true; }
  13248. auto stopping = [this] { return is_stopping(); };
  13249. #ifdef CPPHTTPLIB_SSL_ENABLED
  13250. if (req.ssl) {
  13251. // wss: the heartbeat ping thread and the read path enter the same
  13252. // TLS session from different threads. Hand the WebSocket a stream
  13253. // that serializes every TLS call, so the shared SSLSocketStream on
  13254. // the plain HTTP/HTTPS paths stays untouched.
  13255. auto ws_strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  13256. strm.socket(), const_cast<tls::session_t>(req.ssl),
  13257. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  13258. write_timeout_sec_, write_timeout_usec_));
  13259. ws::WebSocket ws(std::move(ws_strm), req, true,
  13260. websocket_ping_interval_sec_,
  13261. websocket_max_missed_pongs_, stopping);
  13262. ws_route->handler(req, ws);
  13263. return true;
  13264. }
  13265. #endif
  13266. // Use WebSocket-specific read timeout instead of HTTP timeout
  13267. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0);
  13268. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  13269. websocket_max_missed_pongs_, stopping);
  13270. ws_route->handler(req, ws);
  13271. return true;
  13272. }
  13273. // No WebSocket route: route it as a plain HTTP request
  13274. }
  13275. // Routing
  13276. auto routed = false;
  13277. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13278. routed = routing(req, res, strm, is_upgrade);
  13279. #else
  13280. try {
  13281. routed = routing(req, res, strm, is_upgrade);
  13282. } catch (...) { routed = handle_exception(req, res); }
  13283. #endif
  13284. auto ret = false;
  13285. if (routed) {
  13286. if (res.status == -1) {
  13287. res.status = req.ranges.empty() ? StatusCode::OK_200
  13288. : StatusCode::PartialContent_206;
  13289. }
  13290. // Before the Range checks below, so they see the body's own length.
  13291. detail::prefer_assigned_body(res);
  13292. // Serve file content by using a content provider
  13293. auto file_open_error = false;
  13294. if (!res.file_content_path_.empty()) {
  13295. const auto &path = res.file_content_path_;
  13296. auto mm = std::make_shared<detail::mmap>(path.c_str());
  13297. if (!mm->is_open()) {
  13298. res.status = StatusCode::NotFound_404;
  13299. output_error_log(Error::OpenFile, &req);
  13300. file_open_error = true;
  13301. } else {
  13302. auto content_type = res.file_content_content_type_;
  13303. if (content_type.empty()) {
  13304. // One the handler set after set_file_content()
  13305. content_type = res.get_header_value("Content-Type");
  13306. }
  13307. if (content_type.empty()) {
  13308. content_type = detail::find_content_type(
  13309. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  13310. }
  13311. detail::set_file_content_provider(
  13312. res, mm, content_type,
  13313. static_file_encoding(req, res, content_type, mm->size()));
  13314. }
  13315. }
  13316. if (file_open_error) {
  13317. ret = write_response(strm, close_after_response, req, res);
  13318. } else if (detail::range_error(req, res)) {
  13319. detail::clear_content(res);
  13320. res.status = StatusCode::RangeNotSatisfiable_416;
  13321. ret = write_response(strm, close_after_response, req, res);
  13322. } else {
  13323. ret = write_response_with_content(strm, close_after_response, req, res);
  13324. }
  13325. } else {
  13326. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  13327. ret = write_response(strm, close_after_response, req, res);
  13328. }
  13329. // Drain any unconsumed framed body to prevent request smuggling on
  13330. // keep-alive. Without framing there is no body to drain — reading would
  13331. // consume the next request (issue #2450). If the response has committed the
  13332. // connection to close, there is no next request to protect. A body read in
  13333. // part cannot be drained from where it stopped, so the connection closes,
  13334. // as it does when the body is longer than the drain limit or does not
  13335. // arrive within the read timeout.
  13336. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  13337. !detail::has_header_token(res.headers, "Connection", "close")) {
  13338. strm.set_max_timeout(read_timeout_msec);
  13339. int dummy_status;
  13340. if (req.body_read_started_ ||
  13341. !detail::read_content(
  13342. strm, req, CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH, dummy_status,
  13343. nullptr, [](const char *, size_t, size_t, size_t) { return true; },
  13344. false)) {
  13345. connection_closed = true;
  13346. }
  13347. }
  13348. return ret;
  13349. }
  13350. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  13351. inline bool Server::process_and_close_socket(socket_t sock) {
  13352. std::string remote_addr;
  13353. int remote_port = 0;
  13354. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  13355. std::string local_addr;
  13356. int local_port = 0;
  13357. detail::get_local_ip_and_port(sock, local_addr, local_port);
  13358. bool websocket_upgraded = false;
  13359. auto ret = serve_guarded([&]() {
  13360. return detail::process_server_socket(
  13361. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  13362. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13363. write_timeout_usec_,
  13364. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  13365. return process_request(strm, remote_addr, remote_port, local_addr,
  13366. local_port, close_connection,
  13367. connection_closed, nullptr,
  13368. &websocket_upgraded);
  13369. });
  13370. });
  13371. detail::drain_and_close_socket(sock);
  13372. return ret;
  13373. }
  13374. inline void Server::output_log(const Request &req, const Response &res) const {
  13375. if (logger_) {
  13376. std::lock_guard<std::mutex> guard(logger_mutex_);
  13377. logger_(req, res);
  13378. }
  13379. }
  13380. inline void Server::output_pre_compression_log(const Request &req,
  13381. const Response &res) const {
  13382. if (pre_compression_logger_) {
  13383. std::lock_guard<std::mutex> guard(logger_mutex_);
  13384. pre_compression_logger_(req, res);
  13385. }
  13386. }
  13387. inline void Server::output_error_log(const Error &err,
  13388. const Request *req) const {
  13389. if (error_logger_) {
  13390. std::lock_guard<std::mutex> guard(logger_mutex_);
  13391. error_logger_(err, req);
  13392. }
  13393. }
  13394. /*
  13395. * Group 5: ClientImpl and Client (Universal) implementation
  13396. */
  13397. // HTTP client implementation
  13398. inline ClientImpl::ClientImpl(const std::string &host)
  13399. : ClientImpl(host, 80, std::string(), std::string()) {}
  13400. inline ClientImpl::ClientImpl(const std::string &host, int port)
  13401. : ClientImpl(host, port, std::string(), std::string()) {}
  13402. inline ClientImpl::ClientImpl(const std::string &host, int port,
  13403. const std::string &client_cert_path,
  13404. const std::string &client_key_path)
  13405. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  13406. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  13407. inline ClientImpl::~ClientImpl() {
  13408. // Wait until all the requests in flight are handled.
  13409. size_t retry_count = 10;
  13410. while (retry_count-- > 0) {
  13411. {
  13412. std::lock_guard<std::mutex> guard(socket_mutex_);
  13413. if (socket_requests_in_flight_ == 0) { break; }
  13414. }
  13415. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  13416. }
  13417. std::lock_guard<std::mutex> guard(socket_mutex_);
  13418. shutdown_socket(socket_);
  13419. close_socket(socket_);
  13420. }
  13421. inline bool ClientImpl::is_valid() const { return true; }
  13422. inline bool
  13423. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  13424. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  13425. if (no_proxy_entries_.empty()) { return true; }
  13426. // host_ is const so its normalized form is invariant; cache it. The
  13427. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  13428. if (host == host_) {
  13429. if (!host_normalized_valid_) {
  13430. host_normalized_ = detail::normalize_target(host_);
  13431. host_normalized_valid_ = true;
  13432. }
  13433. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13434. }
  13435. auto target = detail::normalize_target(host);
  13436. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13437. }
  13438. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13439. if (is_proxy_enabled_for_host(host_)) {
  13440. return detail::create_client_socket(
  13441. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13442. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13443. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13444. write_timeout_sec_, write_timeout_usec_, interface_, error,
  13445. stop_interrupt());
  13446. }
  13447. // Check is custom IP or hostname specified for host_
  13448. std::string connect_host;
  13449. std::string ip;
  13450. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13451. return detail::create_client_socket(
  13452. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13453. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13454. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13455. write_timeout_usec_, interface_, error, stop_interrupt());
  13456. }
  13457. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13458. Error &error) {
  13459. auto sock = create_client_socket(error);
  13460. if (sock == INVALID_SOCKET) { return false; }
  13461. socket.sock = sock;
  13462. return true;
  13463. }
  13464. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13465. socket_tls_settings_version_ = tls_settings_version_;
  13466. return create_and_connect_socket(socket, error);
  13467. }
  13468. inline bool ClientImpl::setup_proxy_connection(
  13469. Socket & /*socket*/,
  13470. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13471. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13472. return true;
  13473. }
  13474. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13475. bool /*shutdown_gracefully*/) {
  13476. // If there are any requests in flight from threads other than us, then it's
  13477. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13478. assert(socket_requests_in_flight_ == 0 ||
  13479. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13480. }
  13481. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13482. if (socket.sock == INVALID_SOCKET) { return; }
  13483. detail::shutdown_socket(socket.sock);
  13484. }
  13485. inline void ClientImpl::close_socket(Socket &socket) {
  13486. // If there are requests in flight in another thread, usually closing
  13487. // the socket will be fine and they will simply receive an error when
  13488. // using the closed socket, but it is still a bug since rarely the OS
  13489. // may reassign the socket id to be used for a new socket, and then
  13490. // suddenly they will be operating on a live socket that is different
  13491. // than the one they intended!
  13492. assert(socket_requests_in_flight_ == 0 ||
  13493. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13494. // It is also a bug if this happens while SSL is still active
  13495. #ifdef CPPHTTPLIB_SSL_ENABLED
  13496. assert(socket.ssl == nullptr);
  13497. #endif
  13498. if (socket.sock == INVALID_SOCKET) { return; }
  13499. detail::close_socket(socket.sock);
  13500. socket.sock = INVALID_SOCKET;
  13501. }
  13502. inline void ClientImpl::disconnect(bool gracefully) {
  13503. shutdown_ssl(socket_, gracefully);
  13504. shutdown_socket(socket_);
  13505. close_socket(socket_);
  13506. }
  13507. inline bool ClientImpl::socket_reusable() {
  13508. if (!socket_.is_open()) { return false; }
  13509. // RFC 9112 9.2: data with no request outstanding is not a response
  13510. if (detail::select_read(socket_.sock, 0, 0) != 0) {
  13511. disconnect(/*gracefully=*/false);
  13512. return false;
  13513. }
  13514. if (is_ssl() && socket_tls_settings_version_ != tls_settings_version_) {
  13515. disconnect(/*gracefully=*/true);
  13516. return false;
  13517. }
  13518. return true;
  13519. }
  13520. inline bool ClientImpl::prepare_socket(
  13521. std::unique_lock<std::mutex> &guard,
  13522. std::chrono::time_point<std::chrono::steady_clock> start_time,
  13523. Response &res, bool &success, Error &error) {
  13524. auto opened = true;
  13525. if (!socket_reusable()) {
  13526. Socket socket;
  13527. guard.unlock();
  13528. opened = ensure_socket_connection(socket, error);
  13529. if (opened) {
  13530. opened = setup_proxy_connection(socket, start_time, res, success, error);
  13531. } else {
  13532. success = false;
  13533. }
  13534. guard.lock();
  13535. socket_ = socket;
  13536. }
  13537. if (stop_requested_) {
  13538. disconnect(/*gracefully=*/false);
  13539. error = Error::Canceled;
  13540. success = false;
  13541. return false;
  13542. }
  13543. return opened;
  13544. }
  13545. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13546. Response &res,
  13547. bool skip_100_continue) const {
  13548. std::array<char, 2048> buf{};
  13549. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13550. if (!line_reader.getline()) { return false; }
  13551. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13552. res.reason)) {
  13553. return req.method == "CONNECT";
  13554. }
  13555. // Skip interim (1xx) responses along with their header fields, except a 100
  13556. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13557. // HTTP on the connection, so it is final. A server sending them without end
  13558. // would hold the client, so there may be only so many.
  13559. size_t interim_count = 0;
  13560. while (100 <= res.status && res.status < 200 &&
  13561. res.status != StatusCode::SwitchingProtocol_101 &&
  13562. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13563. if (++interim_count > CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT) {
  13564. return false;
  13565. }
  13566. Headers interim_headers;
  13567. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13568. if (!line_reader.getline()) { return false; } // next response line
  13569. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13570. res.reason)) {
  13571. return false;
  13572. }
  13573. }
  13574. return true;
  13575. }
  13576. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13577. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13578. // A same-origin redirect and a digest retry send through here again. Only
  13579. // the call the caller made reports a failure, once, with its request.
  13580. auto outermost = send_depth_++ == 0;
  13581. auto se = detail::scope_exit([&] { send_depth_--; });
  13582. if (outermost) {
  13583. error = Error::Success;
  13584. stop_requested_ = false;
  13585. }
  13586. auto ret = send_(req, res, error);
  13587. if (error == Error::SSLPeerCouldBeClosed_) {
  13588. assert(!ret);
  13589. ret = send_(req, res, error);
  13590. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13591. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13592. }
  13593. // Also an answer that carries an error, such as a proxy's 407
  13594. if (outermost && error != Error::Success) { output_error_log(error, &req); }
  13595. return ret;
  13596. }
  13597. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13598. #ifdef CPPHTTPLIB_SSL_ENABLED
  13599. // Don't let an earlier attempt's TLS error show up in this one's Result. A
  13600. // client that failed to set up its TLS context keeps reporting why.
  13601. if (is_valid()) {
  13602. last_ssl_error_ = 0;
  13603. last_backend_error_ = 0;
  13604. }
  13605. #endif
  13606. {
  13607. std::unique_lock<std::mutex> guard(socket_mutex_);
  13608. // Set this to false immediately - if it ever gets set to true by the end
  13609. // of the request, we know another thread instructed us to close the
  13610. // socket.
  13611. socket_should_be_closed_when_request_is_done_ = false;
  13612. auto success = true;
  13613. if (!prepare_socket(guard, req.start_time_, res, success, error)) {
  13614. return success;
  13615. }
  13616. // Mark the current socket as being in use so that it cannot be closed by
  13617. // anyone else while this request is ongoing, even though we will be
  13618. // releasing the mutex.
  13619. if (socket_requests_in_flight_ > 1) {
  13620. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13621. }
  13622. socket_requests_in_flight_ += 1;
  13623. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13624. }
  13625. for (const auto &header : default_headers_) {
  13626. if (req.headers.find(header.first) == req.headers.end()) {
  13627. req.headers.insert(header);
  13628. }
  13629. }
  13630. auto ret = false;
  13631. auto close_connection = !keep_alive_;
  13632. auto se = detail::scope_exit([&]() {
  13633. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13634. std::lock_guard<std::mutex> guard(socket_mutex_);
  13635. socket_requests_in_flight_ -= 1;
  13636. if (socket_requests_in_flight_ <= 0) {
  13637. assert(socket_requests_in_flight_ == 0);
  13638. socket_requests_are_from_thread_ = std::thread::id();
  13639. }
  13640. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13641. !ret) {
  13642. disconnect(/*gracefully=*/true);
  13643. }
  13644. });
  13645. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13646. strm.set_read_interrupt(stop_interrupt());
  13647. return handle_request(strm, req, res, close_connection, error);
  13648. });
  13649. if (!ret) {
  13650. if (error == Error::Success) { error = Error::Unknown; }
  13651. }
  13652. return ret;
  13653. }
  13654. inline Result ClientImpl::send(const Request &req) {
  13655. auto req2 = req;
  13656. return send_(std::move(req2));
  13657. }
  13658. inline Result ClientImpl::send_(Request &&req) {
  13659. auto res = detail::make_unique<Response>();
  13660. auto error = Error::Success;
  13661. #ifdef CPPHTTPLIB_SSL_ENABLED
  13662. // Hold the request lock until the Result has read this request's TLS error
  13663. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13664. #endif
  13665. auto ret = send(req, *res, error);
  13666. #ifdef CPPHTTPLIB_SSL_ENABLED
  13667. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13668. last_ssl_error_, last_backend_error_};
  13669. #else
  13670. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13671. #endif
  13672. }
  13673. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13674. const std::string &ct) {
  13675. (void)for_stream;
  13676. // Default headers are meant for the origin and may carry its credentials, so
  13677. // keep them off the CONNECT request the proxy reads.
  13678. if (r.method != "CONNECT") {
  13679. for (const auto &header : default_headers_) {
  13680. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13681. }
  13682. }
  13683. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13684. // prepend it rather than appending it after the caller's own fields.
  13685. if (!r.has_header("Host")) {
  13686. r.headers.emplace_front(
  13687. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13688. address_family_));
  13689. }
  13690. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13691. if (!r.content_receiver) {
  13692. if (!r.has_header("Accept-Encoding")) {
  13693. std::string accept_encoding;
  13694. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13695. accept_encoding = "br";
  13696. #endif
  13697. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13698. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13699. accept_encoding += "gzip, deflate";
  13700. #endif
  13701. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13702. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13703. accept_encoding += "zstd";
  13704. #endif
  13705. r.set_header("Accept-Encoding", accept_encoding);
  13706. }
  13707. detail::add_default_user_agent_header(r);
  13708. }
  13709. if (!r.body.empty()) {
  13710. if (!ct.empty() && !r.has_header("Content-Type")) {
  13711. r.headers.emplace("Content-Type", ct);
  13712. }
  13713. if (!r.has_header("Content-Length")) {
  13714. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13715. }
  13716. }
  13717. }
  13718. inline ClientImpl::StreamHandle
  13719. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13720. const Params &params, const Headers &headers,
  13721. const std::string &body,
  13722. const std::string &content_type) {
  13723. // Encode the target exactly like the buffered send path does, so that the
  13724. // same `path` produces the same request line through either API.
  13725. auto raw_query_path =
  13726. params.empty() ? path : append_query_params(path, params);
  13727. Request req;
  13728. req.method = method;
  13729. req.path = detail::encode_request_target(raw_query_path, path_encode_);
  13730. req.headers = headers;
  13731. req.body = body;
  13732. prepare_default_headers(req, true, content_type);
  13733. auto handle = open_stream_(req);
  13734. // Like a buffered request, a stream that fails to open is reported once
  13735. if (handle.error != Error::Success) { output_error_log(handle.error, &req); }
  13736. return handle;
  13737. }
  13738. inline ClientImpl::StreamHandle ClientImpl::open_stream_(Request &req) {
  13739. StreamHandle handle;
  13740. handle.response = detail::make_unique<Response>();
  13741. handle.error = Error::Success;
  13742. handle.connection_ = detail::make_unique<ClientConnection>();
  13743. {
  13744. // A request in flight uses socket_ without holding socket_mutex_
  13745. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13746. if (send_depth_ == 0) { stop_requested_ = false; }
  13747. std::unique_lock<std::mutex> guard(socket_mutex_);
  13748. auto success = true;
  13749. if (!prepare_socket(guard, std::chrono::steady_clock::now(),
  13750. *handle.response, success, handle.error)) {
  13751. if (!success) { handle.response.reset(); }
  13752. return handle;
  13753. }
  13754. transfer_socket_ownership_to_handle(handle);
  13755. }
  13756. #ifdef CPPHTTPLIB_SSL_ENABLED
  13757. if (is_ssl() && handle.connection_->session) {
  13758. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13759. handle.connection_->sock, handle.connection_->session,
  13760. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13761. write_timeout_usec_);
  13762. } else {
  13763. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13764. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13765. write_timeout_sec_, write_timeout_usec_);
  13766. }
  13767. #else
  13768. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13769. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13770. write_timeout_sec_, write_timeout_usec_);
  13771. #endif
  13772. handle.stream_ = handle.socket_stream_.get();
  13773. auto &strm = *handle.stream_;
  13774. // Only for the head, as the handle may outlive this client
  13775. strm.set_read_interrupt(stop_interrupt());
  13776. auto release_interrupt =
  13777. detail::scope_exit([&] { strm.set_read_interrupt(nullptr); });
  13778. // After connecting, as for a buffered request
  13779. add_credential_headers(req);
  13780. // Build the request line and headers in memory first, like write_request()
  13781. // does, so that a rejected header leaves nothing on the wire.
  13782. {
  13783. detail::BufferStream bstrm;
  13784. // The path follows the authority in absolute-form, so one that does not
  13785. // begin with '/' (e.g. "@evil.example/x") would name another host.
  13786. auto prefix = proxy_target_prefix();
  13787. if ((!prefix.empty() && req.path[0] != '/') ||
  13788. detail::write_request_line(bstrm, req.method, prefix + req.path) < 0) {
  13789. handle.error = Error::Write;
  13790. handle.response.reset();
  13791. return handle;
  13792. }
  13793. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13794. handle.error)) {
  13795. handle.response.reset();
  13796. return handle;
  13797. }
  13798. const auto &data = bstrm.get_buffer();
  13799. if (!detail::write_data(strm, data.data(), data.size())) {
  13800. handle.error = Error::Write;
  13801. handle.response.reset();
  13802. return handle;
  13803. }
  13804. }
  13805. if (!req.body.empty()) {
  13806. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13807. handle.error = Error::Write;
  13808. handle.response.reset();
  13809. return handle;
  13810. }
  13811. }
  13812. if (!read_response_line(strm, req, *handle.response) ||
  13813. !detail::read_headers(strm, handle.response->headers)) {
  13814. handle.error = Error::Read;
  13815. handle.response.reset();
  13816. return handle;
  13817. }
  13818. handle.body_reader_.stream = handle.stream_;
  13819. handle.body_reader_.payload_max_length = payload_max_length_;
  13820. // RFC 9112 6.3: a response to HEAD, and a 204 or 304 response, ends with its
  13821. // header section, so none of its framing or coding headers apply.
  13822. if (req.method == "HEAD" ||
  13823. handle.response->status == StatusCode::NoContent_204 ||
  13824. handle.response->status == StatusCode::NotModified_304) {
  13825. handle.body_reader_.eof = true;
  13826. return handle;
  13827. }
  13828. // Same framing check as ClientImpl::process_request()
  13829. if (detail::has_conflicting_content_length(handle.response->headers)) {
  13830. handle.error = Error::Read;
  13831. handle.response.reset();
  13832. return handle;
  13833. }
  13834. if (handle.response->has_header("Content-Length")) {
  13835. bool is_invalid = false;
  13836. auto content_length = detail::get_header_value_u64(
  13837. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13838. if (is_invalid) {
  13839. handle.error = Error::Read;
  13840. handle.response.reset();
  13841. return handle;
  13842. }
  13843. handle.body_reader_.has_content_length = true;
  13844. handle.body_reader_.content_length = content_length;
  13845. }
  13846. handle.body_reader_.chunked =
  13847. detail::is_chunked_transfer_encoding(handle.response->headers);
  13848. auto content_encoding = detail::get_combined_header_value(
  13849. handle.response->headers, "Content-Encoding");
  13850. if (decompress_ && !content_encoding.empty()) {
  13851. // Same policy as prepare_content_receiver(): reject a coding we know about
  13852. // but were not built with, pass an unrecognized one through as-is.
  13853. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13854. if (!handle.decompressor_) {
  13855. if (detail::is_known_content_encoding(content_encoding)) {
  13856. handle.error = Error::UnsupportedContentEncoding;
  13857. handle.response.reset();
  13858. return handle;
  13859. }
  13860. } else if (!handle.decompressor_->is_valid()) {
  13861. handle.error = Error::Compression;
  13862. handle.response.reset();
  13863. return handle;
  13864. }
  13865. }
  13866. return handle;
  13867. }
  13868. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13869. if (!is_valid() || !response) { return -1; }
  13870. auto n = decompressor_
  13871. ? read_with_decompression(buf, len)
  13872. : detail::read_body_content(stream_, body_reader_, buf, len);
  13873. if (n == 0) { parse_trailers_if_needed(); }
  13874. return n;
  13875. }
  13876. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13877. size_t len) {
  13878. if (decompress_offset_ < decompress_buffer_.size()) {
  13879. auto available = decompress_buffer_.size() - decompress_offset_;
  13880. auto to_copy = (std::min)(len, available);
  13881. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13882. decompress_offset_ += to_copy;
  13883. decompressed_bytes_read_ += to_copy;
  13884. return static_cast<ssize_t>(to_copy);
  13885. }
  13886. decompress_buffer_.clear();
  13887. decompress_offset_ = 0;
  13888. constexpr size_t kDecompressionBufferSize = 8192;
  13889. char compressed_buf[kDecompressionBufferSize];
  13890. while (true) {
  13891. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13892. sizeof(compressed_buf));
  13893. if (n <= 0) { return n; }
  13894. auto exceeded = false;
  13895. bool decompress_ok = decompressor_->decompress(
  13896. compressed_buf, static_cast<size_t>(n),
  13897. [&](const char *data, size_t data_len) {
  13898. decompress_buffer_.append(data, data_len);
  13899. auto limit = body_reader_.payload_max_length;
  13900. exceeded =
  13901. limit > 0 &&
  13902. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  13903. return !exceeded;
  13904. });
  13905. if (!decompress_ok) {
  13906. body_reader_.last_error =
  13907. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  13908. return -1;
  13909. }
  13910. if (!decompress_buffer_.empty()) { break; }
  13911. }
  13912. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13913. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13914. decompress_offset_ = to_copy;
  13915. decompressed_bytes_read_ += to_copy;
  13916. return static_cast<ssize_t>(to_copy);
  13917. }
  13918. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13919. // The trailers follow the last chunk, so there are none before it
  13920. auto &decoder = body_reader_.chunked_decoder;
  13921. if (!response || trailers_parsed_ || !decoder || !decoder->finished) {
  13922. return;
  13923. }
  13924. trailers_parsed_ = true;
  13925. decoder->parse_trailers_into(response->trailers, response->headers);
  13926. }
  13927. namespace detail {
  13928. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13929. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13930. size_t &out_chunk_offset,
  13931. size_t &out_chunk_total) {
  13932. if (finished) { return 0; }
  13933. if (chunk_remaining == 0) {
  13934. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13935. if (!lr.getline()) { return -1; }
  13936. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13937. // the line terminator is never mistaken for line content.
  13938. const char *eol = lr.ptr() + lr.size();
  13939. if (lr.end_with_crlf()) {
  13940. eol -= 2;
  13941. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13942. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13943. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13944. // has to come off here or the check below would reject the line.
  13945. eol -= 1;
  13946. }
  13947. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13948. const char *p = lr.ptr();
  13949. int v = 0;
  13950. if (p == eol || !is_hex(*p, v)) { return -1; }
  13951. size_t chunk_len = 0;
  13952. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13953. for (; p < eol && is_hex(*p, v); ++p) {
  13954. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13955. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13956. }
  13957. while (p < eol && is_space_or_tab(*p)) {
  13958. ++p;
  13959. }
  13960. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13961. // terminator, and it is built from tokens and quoted-strings, so it never
  13962. // holds a CR, LF or any other control character. getline() reads up to the
  13963. // CRLF, so a bare LF left in here would be swallowed as extension text
  13964. // while an intermediary that ends the line on it delimits the chunks
  13965. // differently, and the two disagree on where the body ends (request
  13966. // smuggling).
  13967. if (p < eol && *p != ';') { return -1; }
  13968. for (; p < eol; ++p) {
  13969. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13970. }
  13971. // The bytes around the data are no payload, so they are counted on their
  13972. // own, as Go does: each chunk may spend 16 bytes and twice its data on
  13973. // them, which lets a stream send a byte at a time, and what goes past that
  13974. // in padding, leading zeros and extensions builds up to one header field.
  13975. overhead += lr.size() + 2;
  13976. overhead = overhead > 16 ? overhead - 16 : 0;
  13977. overhead = chunk_len > overhead / 2 ? 0 : overhead - 2 * chunk_len;
  13978. if (overhead > CPPHTTPLIB_HEADER_MAX_LENGTH) { return -1; }
  13979. if (chunk_len == 0) {
  13980. chunk_remaining = 0;
  13981. finished = true;
  13982. out_chunk_offset = 0;
  13983. out_chunk_total = 0;
  13984. return 0;
  13985. }
  13986. chunk_remaining = chunk_len;
  13987. last_chunk_total = chunk_remaining;
  13988. last_chunk_offset = 0;
  13989. }
  13990. auto to_read = (std::min)(chunk_remaining, len);
  13991. auto n = strm.read(buf, to_read);
  13992. if (n <= 0) { return -1; }
  13993. auto offset_before = last_chunk_offset;
  13994. last_chunk_offset += static_cast<size_t>(n);
  13995. chunk_remaining -= static_cast<size_t>(n);
  13996. out_chunk_offset = offset_before;
  13997. out_chunk_total = last_chunk_total;
  13998. if (chunk_remaining == 0) {
  13999. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  14000. if (!lr.getline()) { return -1; }
  14001. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  14002. }
  14003. return n;
  14004. }
  14005. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  14006. const Headers &src_headers) {
  14007. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  14008. if (!lr.getline()) { return false; }
  14009. return parse_trailers(lr, dest, src_headers);
  14010. }
  14011. // Only 301, 302, 303, 307 and 308 redirect. Any other 3xx, such as a 304, or
  14012. // a redirect without a Location, is a final response.
  14013. inline bool is_redirect(const Response &res) {
  14014. switch (res.status) {
  14015. case StatusCode::MovedPermanently_301:
  14016. case StatusCode::Found_302:
  14017. case StatusCode::SeeOther_303:
  14018. case StatusCode::TemporaryRedirect_307:
  14019. case StatusCode::PermanentRedirect_308:
  14020. return !res.get_header_value("Location").empty();
  14021. default: return false;
  14022. }
  14023. }
  14024. } // namespace detail
  14025. inline void
  14026. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  14027. handle.connection_->sock = socket_.sock;
  14028. #ifdef CPPHTTPLIB_SSL_ENABLED
  14029. handle.connection_->session = socket_.ssl;
  14030. socket_.ssl = nullptr;
  14031. #endif
  14032. socket_.sock = INVALID_SOCKET;
  14033. }
  14034. // A plain HTTP proxy reads the target in absolute-form (RFC 9112 3.2.2)
  14035. inline std::string ClientImpl::proxy_target_prefix() const {
  14036. if (is_ssl() || !is_proxy_enabled_for_host(host_)) { return std::string(); }
  14037. return "http://" + detail::make_host_and_port_string(host_, port_, false);
  14038. }
  14039. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  14040. Response &res, bool close_connection,
  14041. Error &error) {
  14042. if (req.path.empty()) {
  14043. error = Error::Connection;
  14044. return false;
  14045. }
  14046. auto req_save = req;
  14047. bool ret;
  14048. auto prefix = proxy_target_prefix();
  14049. if (!prefix.empty()) {
  14050. // The path follows the authority in absolute-form, so one that does not
  14051. // begin with '/' (e.g. "@evil.example/x") would name another host.
  14052. if (req.path[0] != '/') {
  14053. error = Error::Write;
  14054. return false;
  14055. }
  14056. auto req2 = req;
  14057. req2.path = prefix + req.path;
  14058. ret = process_request(strm, req2, res, close_connection, error);
  14059. req = std::move(req2);
  14060. req.path = req_save.path;
  14061. } else {
  14062. ret = process_request(strm, req, res, close_connection, error);
  14063. }
  14064. if (!ret) { return false; }
  14065. {
  14066. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  14067. // for this to be safe.
  14068. // This is safe to call because handle_request is only called by send_
  14069. // which locks the request mutex during the process. It would be a bug
  14070. // to call it from a different thread since it's a thread-safety issue
  14071. // to do these things to the socket if another thread is using the socket.
  14072. std::lock_guard<std::mutex> guard(socket_mutex_);
  14073. // Also when the request asked for it (e.g. a body that was never sent,
  14074. // or "Connection: close") or bytes follow the response (RFC 9112 9.2), so
  14075. // that a redirect or an auth retry below does not reuse the socket.
  14076. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  14077. strm.is_readable() ||
  14078. detail::has_header_token(res.headers, "Connection", "close") ||
  14079. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  14080. disconnect(/*gracefully=*/true);
  14081. }
  14082. }
  14083. if (follow_location_ && detail::is_redirect(res)) {
  14084. req = std::move(req_save);
  14085. // The client that followed the redirect has answered any challenge it
  14086. // could. Retrying below would sign another host's challenge and send it
  14087. // here.
  14088. return redirect(req, res, error);
  14089. }
  14090. #ifdef CPPHTTPLIB_SSL_ENABLED
  14091. if ((res.status == StatusCode::Unauthorized_401 ||
  14092. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  14093. req.authorization_count_ < 5) {
  14094. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  14095. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  14096. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  14097. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  14098. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  14099. return ret;
  14100. }
  14101. const auto &username =
  14102. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  14103. const auto &password =
  14104. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  14105. if (!username.empty() && !password.empty()) {
  14106. std::map<std::string, std::string> auth;
  14107. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  14108. Request new_req = req;
  14109. new_req.authorization_count_ += 1;
  14110. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  14111. : "Authorization");
  14112. new_req.headers.insert(detail::make_digest_authentication_header(
  14113. req, make_request_target(req), auth, new_req.authorization_count_,
  14114. detail::random_string(10), username, password, is_proxy));
  14115. Response new_res;
  14116. ret = send(new_req, new_res, error);
  14117. if (ret) { res = std::move(new_res); }
  14118. }
  14119. }
  14120. }
  14121. #endif
  14122. return ret;
  14123. }
  14124. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  14125. if (req.redirect_count_ == 0) {
  14126. error = Error::ExceedRedirectCount;
  14127. return false;
  14128. }
  14129. auto location = res.get_header_value("location");
  14130. if (location.empty()) { return false; }
  14131. auto next_url = detail::resolve_relative_location(location, req.path);
  14132. detail::UrlComponents uc;
  14133. if (!detail::parse_url(next_url, uc)) { return false; }
  14134. // Follow only http/https URLs and references starting with '/'
  14135. if (next_url[0] != '/' && uc.scheme != "http" && uc.scheme != "https") {
  14136. return false;
  14137. }
  14138. auto scheme = is_ssl() ? "https" : "http";
  14139. auto next_scheme = std::move(uc.scheme);
  14140. auto next_host = std::move(uc.host);
  14141. auto port_str = std::move(uc.port);
  14142. auto next_path = std::move(uc.path);
  14143. auto next_query = std::move(uc.query);
  14144. auto next_port = port_;
  14145. if (!port_str.empty()) {
  14146. if (!detail::parse_port(port_str, next_port)) { return false; }
  14147. } else if (!next_scheme.empty()) {
  14148. next_port = next_scheme == "https" ? 443 : 80;
  14149. }
  14150. if (next_scheme.empty()) { next_scheme = scheme; }
  14151. if (next_host.empty()) { next_host = host_; }
  14152. if (next_path.empty()) { next_path = "/"; }
  14153. // An absolute or absolute-path location can have dot segments too.
  14154. if (next_path[0] == '/') {
  14155. next_path = detail::remove_dot_segments(next_path);
  14156. }
  14157. auto path = std::move(next_path) + next_query;
  14158. // A Unix socket client sends "Host: localhost", so a Location naming
  14159. // localhost names this client too.
  14160. auto is_same_host = next_host == host_ ||
  14161. (address_family_ == AF_UNIX && next_host == "localhost");
  14162. // Same host redirect - use current client
  14163. if (next_scheme == scheme && is_same_host && next_port == port_) {
  14164. return detail::redirect(*this, req, res, path, location, error);
  14165. }
  14166. // Cross-host/scheme redirect - create new client with robust setup
  14167. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  14168. path, location, error);
  14169. }
  14170. // New method for robust redirect client creation
  14171. inline bool ClientImpl::create_redirect_client(
  14172. const std::string &scheme, const std::string &host, int port, Request &req,
  14173. Response &res, const std::string &path, const std::string &location,
  14174. Error &error) {
  14175. // Determine if we need SSL
  14176. auto need_ssl = (scheme == "https");
  14177. // Clean up request headers that are host/client specific
  14178. // Remove headers that should not be carried over to new host
  14179. auto headers_to_remove = std::vector<std::string>{
  14180. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  14181. for (const auto &header_name : headers_to_remove) {
  14182. auto it = req.headers.find(header_name);
  14183. while (it != req.headers.end()) {
  14184. it = req.headers.erase(it);
  14185. it = req.headers.find(header_name);
  14186. }
  14187. }
  14188. // Create appropriate client type and handle redirect
  14189. if (need_ssl) {
  14190. #ifdef CPPHTTPLIB_SSL_ENABLED
  14191. // Create SSL client for HTTPS redirect
  14192. SSLClient redirect_client(host, port);
  14193. // Setup basic client configuration first
  14194. setup_redirect_client(redirect_client);
  14195. redirect_client.enable_server_certificate_verification(
  14196. server_certificate_verification_);
  14197. redirect_client.enable_server_hostname_verification(
  14198. server_hostname_verification_);
  14199. redirect_client.system_ca_mode_ = system_ca_mode_;
  14200. // Transfer CA certificate to redirect client
  14201. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  14202. if (is_ssl()) {
  14203. auto &self = static_cast<SSLClient &>(*this);
  14204. // A store given to set_ca_cert_store() lives only in this client's
  14205. // context, which then holds all that is trusted.
  14206. if (self.ca_cert_store_set_) {
  14207. std::string pem;
  14208. {
  14209. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  14210. pem = detail::ca_certs_to_pem(self.ctx_);
  14211. }
  14212. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  14213. redirect_client.ca_cert_store_set_ = true;
  14214. } else if (self.custom_ca_loaded_) {
  14215. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  14216. ca_cert_pem_.size());
  14217. }
  14218. redirect_client.set_session_verifier(self.session_verifier_);
  14219. if (self.server_certificate_verifier_) {
  14220. redirect_client.set_server_certificate_verifier(
  14221. self.server_certificate_verifier_);
  14222. }
  14223. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  14224. redirect_client.enable_windows_cert_verification_ =
  14225. self.enable_windows_cert_verification_;
  14226. #endif
  14227. }
  14228. // Client certificates are set through constructor for SSLClient
  14229. // NOTE: SSLClient constructor already takes client_cert_path and
  14230. // client_key_path so we need to create it properly if client certs are
  14231. // needed
  14232. // Execute the redirect
  14233. return detail::redirect(redirect_client, req, res, path, location, error);
  14234. #else
  14235. // SSL not supported - set appropriate error
  14236. error = Error::SSLConnection;
  14237. return false;
  14238. #endif
  14239. } else {
  14240. // HTTP redirect
  14241. ClientImpl redirect_client(host, port);
  14242. // Setup client with robust configuration
  14243. setup_redirect_client(redirect_client);
  14244. // Execute the redirect
  14245. return detail::redirect(redirect_client, req, res, path, location, error);
  14246. }
  14247. }
  14248. // New method for robust client setup (based on basic_manual_redirect.cpp
  14249. // logic)
  14250. template <typename ClientType>
  14251. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  14252. // Copy basic settings first
  14253. client.set_connection_timeout(connection_timeout_sec_,
  14254. connection_timeout_usec_);
  14255. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14256. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  14257. client.set_max_timeout(max_timeout_msec_);
  14258. if (has_payload_max_length_) {
  14259. client.set_payload_max_length(payload_max_length_);
  14260. }
  14261. client.set_keep_alive(keep_alive_);
  14262. client.set_follow_location(
  14263. true); // Enable redirects to handle multi-step redirects
  14264. client.set_path_encode(path_encode_);
  14265. client.set_compress(compress_);
  14266. client.set_decompress(decompress_);
  14267. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  14268. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  14269. // 15.4, credentials must not be forwarded when redirecting to a different
  14270. // host. This function is only called for cross-host redirects; same-host
  14271. // redirects are handled directly in ClientImpl::redirect().
  14272. // Copy the proxy configuration unconditionally; the per-target bypass is
  14273. // re-evaluated at send time, so a later hop to a non-bypassed host can
  14274. // still use the proxy.
  14275. client.no_proxy_entries_ = no_proxy_entries_;
  14276. if (!proxy_host_.empty() && proxy_port_ != -1) {
  14277. client.set_proxy(proxy_host_, proxy_port_);
  14278. if (!proxy_basic_auth_username_.empty() ||
  14279. !proxy_basic_auth_password_.empty()) {
  14280. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  14281. proxy_basic_auth_password_);
  14282. }
  14283. if (!proxy_bearer_token_auth_token_.empty()) {
  14284. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  14285. }
  14286. #ifdef CPPHTTPLIB_SSL_ENABLED
  14287. if (!proxy_digest_auth_username_.empty()) {
  14288. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  14289. proxy_digest_auth_password_);
  14290. }
  14291. #endif
  14292. }
  14293. // Copy network and socket settings
  14294. client.addr_map_ = addr_map_;
  14295. client.tunnel_addr_map_ = tunnel_addr_map_;
  14296. // A Unix socket client reaches every host through its own socket, as curl's
  14297. // --unix-socket does, unless the caller mapped that host elsewhere. The
  14298. // Location's host is never taken as a socket path.
  14299. if (address_family_ == AF_UNIX) {
  14300. auto &target = client.addr_map_[client.host()];
  14301. if (target.empty()) { target = detail::addr_map_target(addr_map_, host_); }
  14302. }
  14303. client.set_address_family(address_family_);
  14304. client.set_tcp_nodelay(tcp_nodelay_);
  14305. client.set_ipv6_v6only(ipv6_v6only_);
  14306. if (socket_options_) { client.set_socket_options(socket_options_); }
  14307. if (!interface_.empty()) { client.set_interface(interface_); }
  14308. // Copy logging and headers. Not the error logger: a failure comes back to
  14309. // this client's send(), which reports it with the caller's request.
  14310. if (logger_) { client.set_logger(logger_); }
  14311. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  14312. // Each new client should generate its own headers based on its target host
  14313. }
  14314. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  14315. const Request &req,
  14316. Error &error) const {
  14317. auto is_shutting_down = []() { return false; };
  14318. if (req.is_chunked_content_provider_) {
  14319. auto compressor = compress_ ? detail::create_compressor().first
  14320. : std::unique_ptr<detail::compressor>();
  14321. if (!compressor) {
  14322. compressor = detail::make_unique<detail::nocompressor>();
  14323. }
  14324. return detail::write_content_chunked(strm, req.content_provider_,
  14325. is_shutting_down, *compressor, error);
  14326. } else {
  14327. return detail::write_content_with_progress(
  14328. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  14329. req.upload_progress, error);
  14330. }
  14331. }
  14332. // What goes on the request line for req: its path, encoded and without the
  14333. // fragment, with `req.params` as the query when the path has none.
  14334. inline std::string ClientImpl::make_request_target(const Request &req) const {
  14335. auto target = detail::encode_request_target(req.path, path_encode_);
  14336. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  14337. target = append_query_params(target, req.params);
  14338. }
  14339. return target;
  14340. }
  14341. inline void ClientImpl::add_credential_headers(Request &req) {
  14342. // A CONNECT request is read by the proxy; everything sent through the tunnel
  14343. // it opens is read by the origin. Each credential goes only to its own hop.
  14344. auto is_connect = req.method == "CONNECT";
  14345. if (!is_connect) {
  14346. detail::add_authorization_header(req, basic_auth_username_,
  14347. basic_auth_password_,
  14348. bearer_token_auth_token_, false);
  14349. }
  14350. // Proxy-Authorization is only sent when the proxy reads this message —
  14351. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  14352. // would leak proxy credentials to the destination server.
  14353. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  14354. detail::add_authorization_header(req, proxy_basic_auth_username_,
  14355. proxy_basic_auth_password_,
  14356. proxy_bearer_token_auth_token_, true);
  14357. }
  14358. }
  14359. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  14360. bool close_connection, Error &error,
  14361. bool skip_body, bool &rejected_locally) {
  14362. rejected_locally = false;
  14363. // Prepare additional headers
  14364. if (close_connection) {
  14365. if (!req.has_header("Connection")) {
  14366. req.set_header("Connection", "close");
  14367. }
  14368. }
  14369. std::string ct_for_defaults;
  14370. if (!req.has_header("Content-Type") && !req.body.empty()) {
  14371. ct_for_defaults = "text/plain";
  14372. }
  14373. prepare_default_headers(req, false, ct_for_defaults);
  14374. if (req.body.empty()) {
  14375. if (req.content_provider_) {
  14376. if (!req.is_chunked_content_provider_) {
  14377. if (!req.has_header("Content-Length")) {
  14378. auto length = std::to_string(req.content_length_);
  14379. req.set_header("Content-Length", length);
  14380. }
  14381. }
  14382. } else {
  14383. if (req.method == "POST" || req.method == "PUT" ||
  14384. req.method == "PATCH") {
  14385. req.set_header("Content-Length", "0");
  14386. }
  14387. }
  14388. }
  14389. add_credential_headers(req);
  14390. // Request line and headers
  14391. {
  14392. detail::BufferStream bstrm;
  14393. auto path_with_query = make_request_target(req);
  14394. // The query already came in through `req.path`; still populate
  14395. // `req.params` for handlers/users who read them.
  14396. auto query_part = detail::query_of(req.path);
  14397. if (!query_part.empty()) {
  14398. detail::parse_query_text(query_part, req.params);
  14399. }
  14400. // Write request line and headers
  14401. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  14402. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  14403. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  14404. // fail the request cleanly instead of emitting a request-line-less,
  14405. // header-injecting request.
  14406. error = Error::Write;
  14407. rejected_locally = true;
  14408. return false;
  14409. }
  14410. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14411. error)) {
  14412. rejected_locally = true;
  14413. return false;
  14414. }
  14415. // Flush buffer
  14416. auto &data = bstrm.get_buffer();
  14417. if (!detail::write_data(strm, data.data(), data.size())) {
  14418. error = Error::Write;
  14419. return false;
  14420. }
  14421. }
  14422. // After sending request line and headers, wait briefly for an early server
  14423. // response (e.g. 4xx) and avoid sending a potentially large request body
  14424. // unnecessarily. This workaround is only enabled on Windows because Unix
  14425. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  14426. // buffering can accept large writes even when the peer already responded.
  14427. // Check the stream first (which covers SSL via `is_readable()`), then
  14428. // fall back to select on the socket. Only perform the wait for very large
  14429. // request bodies to avoid interfering with normal small requests and
  14430. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  14431. // response. Skip this check when using Expect: 100-continue, as the protocol
  14432. // handles early responses properly.
  14433. #if defined(_WIN32)
  14434. if (!skip_body &&
  14435. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  14436. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  14437. auto start = std::chrono::high_resolution_clock::now();
  14438. for (;;) {
  14439. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  14440. // from SSL internals. If the underlying socket is readable, assume an
  14441. // early response may be present.
  14442. auto sock = strm.socket();
  14443. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  14444. return false;
  14445. }
  14446. // Fallback to stream-level check for non-socket streams or when the
  14447. // socket isn't reporting readable. Avoid using `is_readable()` for
  14448. // SSL, since `SSL_pending()` may report buffered records that do not
  14449. // indicate a complete application-level response yet.
  14450. if (!is_ssl() && strm.is_readable()) { return false; }
  14451. auto now = std::chrono::high_resolution_clock::now();
  14452. auto elapsed =
  14453. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  14454. .count();
  14455. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  14456. break;
  14457. }
  14458. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  14459. }
  14460. }
  14461. #endif
  14462. // Body
  14463. if (skip_body) { return true; }
  14464. return write_request_body(strm, req, error);
  14465. }
  14466. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  14467. Error &error) {
  14468. if (req.body.empty()) {
  14469. return write_content_with_provider(strm, req, error);
  14470. }
  14471. if (req.upload_progress) {
  14472. auto body_size = req.body.size();
  14473. size_t written = 0;
  14474. auto data = req.body.data();
  14475. while (written < body_size) {
  14476. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  14477. if (!detail::write_data(strm, data + written, to_write)) {
  14478. error = Error::Write;
  14479. return false;
  14480. }
  14481. written += to_write;
  14482. if (!req.upload_progress(written, body_size)) {
  14483. error = Error::Canceled;
  14484. return false;
  14485. }
  14486. }
  14487. } else {
  14488. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14489. error = Error::Write;
  14490. return false;
  14491. }
  14492. }
  14493. return true;
  14494. }
  14495. inline std::unique_ptr<Response>
  14496. ClientImpl::send_with_content_provider_and_receiver(
  14497. Request &req, const char *body, size_t content_length,
  14498. ContentProvider content_provider,
  14499. ContentProviderWithoutLength content_provider_without_length,
  14500. const std::string &content_type, ContentReceiver content_receiver,
  14501. Error &error) {
  14502. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14503. auto enc = compress_
  14504. ? detail::create_compressor()
  14505. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14506. nullptr, nullptr);
  14507. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14508. // A compressed or chunked body is framed by the library, not the caller
  14509. if (enc.second || content_provider_without_length) {
  14510. req.headers.erase("Content-Length");
  14511. }
  14512. if (enc.first && !content_provider_without_length) {
  14513. auto &compressor = enc.first;
  14514. if (content_provider) {
  14515. auto ok = true;
  14516. auto finished = false;
  14517. size_t offset = 0;
  14518. DataSink data_sink;
  14519. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14520. if (ok) {
  14521. auto last = offset + data_len == content_length;
  14522. auto ret = compressor->compress(
  14523. data, data_len, last,
  14524. [&](const char *compressed_data, size_t compressed_data_len) {
  14525. req.body.append(compressed_data, compressed_data_len);
  14526. return true;
  14527. });
  14528. if (ret) {
  14529. offset += data_len;
  14530. } else {
  14531. ok = false;
  14532. }
  14533. }
  14534. return ok;
  14535. };
  14536. // As in detail::write_content_with_progress(): the body is framed by
  14537. // content_length, so a provider that finishes early has truncated it.
  14538. // Stop and report that instead of calling the provider forever.
  14539. data_sink.done = [&]() { finished = true; };
  14540. while (ok && !finished && offset < content_length) {
  14541. if (!content_provider(offset, content_length - offset, data_sink)) {
  14542. error = Error::Canceled;
  14543. output_error_log(error, &req);
  14544. return nullptr;
  14545. }
  14546. }
  14547. // A short body here means either the provider stopped early or the
  14548. // compressor gave up. The branch below reports a failing compressor as
  14549. // Error::Compression, so keep the two distinguishable.
  14550. if (offset < content_length) {
  14551. error = ok ? Error::Write : Error::Compression;
  14552. output_error_log(error, &req);
  14553. return nullptr;
  14554. }
  14555. } else {
  14556. if (!compressor->compress(body, content_length, true,
  14557. [&](const char *data, size_t data_len) {
  14558. req.body.append(data, data_len);
  14559. return true;
  14560. })) {
  14561. error = Error::Compression;
  14562. output_error_log(error, &req);
  14563. return nullptr;
  14564. }
  14565. }
  14566. } else {
  14567. if (content_provider) {
  14568. req.content_length_ = content_length;
  14569. req.content_provider_ = std::move(content_provider);
  14570. req.is_chunked_content_provider_ = false;
  14571. } else if (content_provider_without_length) {
  14572. req.content_length_ = 0;
  14573. req.content_provider_ = detail::ContentProviderAdapter(
  14574. std::move(content_provider_without_length));
  14575. req.is_chunked_content_provider_ = true;
  14576. req.set_header("Transfer-Encoding", "chunked");
  14577. } else {
  14578. req.body.assign(body, content_length);
  14579. }
  14580. }
  14581. if (content_receiver) {
  14582. req.content_receiver =
  14583. [content_receiver](const char *data, size_t data_length,
  14584. size_t /*offset*/, size_t /*total_length*/) {
  14585. return content_receiver(data, data_length);
  14586. };
  14587. }
  14588. auto res = detail::make_unique<Response>();
  14589. return send(req, *res, error) ? std::move(res) : nullptr;
  14590. }
  14591. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14592. const std::string &method, const std::string &path, const Headers &headers,
  14593. const char *body, size_t content_length, ContentProvider content_provider,
  14594. ContentProviderWithoutLength content_provider_without_length,
  14595. const std::string &content_type, ContentReceiver content_receiver,
  14596. UploadProgress progress) {
  14597. Request req;
  14598. req.method = method;
  14599. req.headers = headers;
  14600. req.path = path;
  14601. req.upload_progress = std::move(progress);
  14602. if (max_timeout_msec_ > 0) {
  14603. req.start_time_ = std::chrono::steady_clock::now();
  14604. }
  14605. auto error = Error::Success;
  14606. #ifdef CPPHTTPLIB_SSL_ENABLED
  14607. // Hold the request lock until the Result has read this request's TLS error
  14608. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14609. #endif
  14610. auto res = send_with_content_provider_and_receiver(
  14611. req, body, content_length, std::move(content_provider),
  14612. std::move(content_provider_without_length), content_type,
  14613. std::move(content_receiver), error);
  14614. #ifdef CPPHTTPLIB_SSL_ENABLED
  14615. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14616. last_backend_error_};
  14617. #else
  14618. return Result{std::move(res), error, std::move(req.headers)};
  14619. #endif
  14620. }
  14621. inline void ClientImpl::output_log(const Request &req,
  14622. const Response &res) const {
  14623. if (logger_) {
  14624. std::lock_guard<std::mutex> guard(logger_mutex_);
  14625. logger_(req, res);
  14626. }
  14627. }
  14628. inline void ClientImpl::output_error_log(const Error &err,
  14629. const Request *req) const {
  14630. if (error_logger_) {
  14631. std::lock_guard<std::mutex> guard(logger_mutex_);
  14632. error_logger_(err, req);
  14633. }
  14634. }
  14635. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14636. Response &res, bool close_connection,
  14637. Error &error) {
  14638. // Auto-add Expect: 100-continue for large bodies
  14639. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14640. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14641. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14642. req.set_header("Expect", "100-continue");
  14643. }
  14644. }
  14645. // Check for Expect: 100-continue
  14646. auto expect_100_continue =
  14647. detail::has_header_token(req.headers, "Expect", "100-continue");
  14648. // Send request (skip body if using Expect: 100-continue)
  14649. auto rejected_locally = false;
  14650. auto write_request_success =
  14651. write_request(strm, req, close_connection, error, expect_100_continue,
  14652. rejected_locally);
  14653. // A failed write normally still reads the response below, since the server
  14654. // may have answered early (e.g. 413/414) and closed while the body was being
  14655. // sent. A request rejected before any byte reached the socket gets no such
  14656. // response, and waiting for one would block until the read timeout.
  14657. if (rejected_locally) { return false; }
  14658. #ifdef CPPHTTPLIB_SSL_ENABLED
  14659. if (is_ssl() && !expect_100_continue) {
  14660. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14661. if (!is_proxy_enabled) {
  14662. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14663. error = Error::SSLPeerCouldBeClosed_;
  14664. return false;
  14665. }
  14666. }
  14667. }
  14668. #endif
  14669. // Handle Expect: 100-continue.
  14670. //
  14671. // Wait for an interim/early response by attempting to read the status line
  14672. // under a short timeout, instead of trusting raw socket readability. Over
  14673. // TLS, post-handshake records (e.g. session tickets) make the socket
  14674. // readable without any HTTP response being available; relying on
  14675. // `select_read` there caused the body to be withheld forever and the
  14676. // request to fail with `Read` (#2458). If no status line arrives within the
  14677. // timeout, send the body anyway (matching curl's behavior).
  14678. auto status_line_read = false;
  14679. if (expect_100_continue && write_request_success) {
  14680. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14681. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14682. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14683. strm.set_read_timeout(sec, usec);
  14684. status_line_read = read_response_line(strm, req, res, false);
  14685. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14686. }
  14687. if (!status_line_read) {
  14688. // No interim response within the timeout: send the body and handle the
  14689. // response as usual.
  14690. if (!write_request_body(strm, req, error)) { return false; }
  14691. expect_100_continue = false; // Switch to normal response handling
  14692. }
  14693. }
  14694. // Receive response and headers
  14695. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14696. if ((!status_line_read &&
  14697. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14698. !detail::read_headers(strm, res.headers)) {
  14699. if (write_request_success) { error = Error::Read; }
  14700. return false;
  14701. }
  14702. if (!write_request_success) { return false; }
  14703. // Handle Expect: 100-continue response
  14704. if (expect_100_continue) {
  14705. if (res.status == StatusCode::Continue_100) {
  14706. // Server accepted, send the body
  14707. if (!write_request_body(strm, req, error)) { return false; }
  14708. // Read the actual response
  14709. res.headers.clear();
  14710. res.body.clear();
  14711. if (!read_response_line(strm, req, res) ||
  14712. !detail::read_headers(strm, res.headers)) {
  14713. error = Error::Read;
  14714. return false;
  14715. }
  14716. } else {
  14717. // A final response came first, so the body this request declared was
  14718. // never sent, and the server may still be waiting for it. The
  14719. // connection cannot carry another request.
  14720. std::lock_guard<std::mutex> guard(socket_mutex_);
  14721. socket_should_be_closed_when_request_is_done_ = true;
  14722. }
  14723. }
  14724. // Body
  14725. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14726. req.method != "CONNECT") {
  14727. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14728. // whose final transfer coding is not chunked is not ambiguous: its body
  14729. // runs until the server closes the connection, so it is not rejected.
  14730. // HEAD/204 are excluded above and a 304 carries no body.
  14731. if (res.status != StatusCode::NotModified_304) {
  14732. if (detail::has_conflicting_content_length(res.headers)) {
  14733. error = Error::Read;
  14734. return false;
  14735. }
  14736. if (detail::has_faulty_transfer_encoding(res)) {
  14737. std::lock_guard<std::mutex> guard(socket_mutex_);
  14738. socket_should_be_closed_when_request_is_done_ = true;
  14739. }
  14740. }
  14741. auto redirect = follow_location_ && detail::is_redirect(res);
  14742. if (req.response_handler && !redirect) {
  14743. if (!req.response_handler(res)) {
  14744. error = Error::Canceled;
  14745. return false;
  14746. }
  14747. }
  14748. auto out =
  14749. req.content_receiver
  14750. ? static_cast<ContentReceiverWithProgress>(
  14751. [&](const char *buf, size_t n, size_t off, size_t len) {
  14752. if (redirect) { return true; }
  14753. auto ret = req.content_receiver(buf, n, off, len);
  14754. if (!ret) { error = Error::Canceled; }
  14755. return ret;
  14756. })
  14757. : static_cast<ContentReceiverWithProgress>(
  14758. [&](const char *buf, size_t n, size_t /*off*/,
  14759. size_t /*len*/) {
  14760. assert(res.body.size() + n <= res.body.max_size());
  14761. if (payload_max_length_ > 0 &&
  14762. (res.body.size() >= payload_max_length_ ||
  14763. n > payload_max_length_ - res.body.size())) {
  14764. return false;
  14765. }
  14766. res.body.append(buf, n);
  14767. return true;
  14768. });
  14769. auto progress = [&](size_t current, size_t total) {
  14770. if (!req.download_progress || redirect) { return true; }
  14771. auto ret = req.download_progress(current, total);
  14772. if (!ret) { error = Error::Canceled; }
  14773. return ret;
  14774. };
  14775. if (res.has_header("Content-Length")) {
  14776. if (!req.content_receiver) {
  14777. auto len = res.get_header_value_u64("Content-Length");
  14778. if (len > res.body.max_size()) {
  14779. error = Error::Read;
  14780. return false;
  14781. }
  14782. // Content-Length is only the server's claim, so reserve no more than
  14783. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14784. // body has arrived. A longer body grows as it is read.
  14785. auto reserve_len =
  14786. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14787. if (payload_max_length_ > 0) {
  14788. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14789. }
  14790. res.body.reserve(reserve_len);
  14791. }
  14792. }
  14793. if (res.status != StatusCode::NotModified_304) {
  14794. auto content_status = 0;
  14795. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14796. ? (std::numeric_limits<size_t>::max)()
  14797. : payload_max_length_;
  14798. if (!detail::read_content(strm, res, max_length, content_status,
  14799. std::move(progress), std::move(out),
  14800. decompress_)) {
  14801. if (error != Error::Canceled) {
  14802. // Tell the caller apart from a plain read failure when the body was
  14803. // over the payload limit or could not be decoded because of its
  14804. // Content-Encoding.
  14805. switch (content_status) {
  14806. case StatusCode::PayloadTooLarge_413:
  14807. error = Error::ExceedMaxPayloadSize;
  14808. break;
  14809. case StatusCode::UnsupportedMediaType_415:
  14810. error = Error::UnsupportedContentEncoding;
  14811. break;
  14812. case StatusCode::InternalServerError_500:
  14813. error = Error::Compression;
  14814. break;
  14815. default: error = Error::Read; break;
  14816. }
  14817. }
  14818. return false;
  14819. }
  14820. }
  14821. }
  14822. // Log
  14823. output_log(req, res);
  14824. return true;
  14825. }
  14826. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14827. const std::string &boundary, const UploadFormDataItems &items,
  14828. const FormDataProviderItems &provider_items) const {
  14829. size_t cur_item = 0;
  14830. size_t cur_start = 0;
  14831. // cur_item and cur_start are copied to within the std::function and
  14832. // maintain state between successive calls
  14833. return [&, cur_item, cur_start](size_t offset,
  14834. DataSink &sink) mutable -> bool {
  14835. if (!offset && !items.empty()) {
  14836. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14837. return true;
  14838. } else if (cur_item < provider_items.size()) {
  14839. if (!cur_start) {
  14840. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14841. provider_items[cur_item], boundary);
  14842. offset += begin.size();
  14843. cur_start = offset;
  14844. sink.os << begin;
  14845. }
  14846. DataSink cur_sink;
  14847. auto has_data = true;
  14848. cur_sink.write = sink.write;
  14849. // Forward is_writable so a provider item asking whether it may keep
  14850. // going gets the outer sink's answer rather than the default `true`.
  14851. cur_sink.is_writable = sink.is_writable;
  14852. cur_sink.done = [&]() { has_data = false; };
  14853. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14854. return false;
  14855. }
  14856. if (!has_data) {
  14857. sink.os << detail::serialize_multipart_formdata_item_end();
  14858. cur_item++;
  14859. cur_start = 0;
  14860. }
  14861. return true;
  14862. } else {
  14863. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14864. sink.done();
  14865. return true;
  14866. }
  14867. };
  14868. }
  14869. inline bool ClientImpl::process_socket(
  14870. const Socket &socket,
  14871. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14872. std::function<bool(Stream &strm)> callback) {
  14873. return detail::process_client_socket(
  14874. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14875. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14876. }
  14877. inline bool ClientImpl::is_ssl() const { return false; }
  14878. inline Result ClientImpl::Get(const std::string &path,
  14879. DownloadProgress progress) {
  14880. return Get(path, Headers(), std::move(progress));
  14881. }
  14882. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14883. DownloadProgress progress) {
  14884. return Get(path, params, Headers(), std::move(progress));
  14885. }
  14886. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14887. const Headers &headers,
  14888. DownloadProgress progress) {
  14889. if (params.empty()) { return Get(path, headers); }
  14890. std::string path_with_query = append_query_params(path, params);
  14891. return Get(path_with_query, headers, std::move(progress));
  14892. }
  14893. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14894. DownloadProgress progress) {
  14895. Request req;
  14896. req.method = "GET";
  14897. req.path = path;
  14898. req.headers = headers;
  14899. req.download_progress = std::move(progress);
  14900. if (max_timeout_msec_ > 0) {
  14901. req.start_time_ = std::chrono::steady_clock::now();
  14902. }
  14903. return send_(std::move(req));
  14904. }
  14905. inline Result ClientImpl::Get(const std::string &path,
  14906. ContentReceiver content_receiver,
  14907. DownloadProgress progress) {
  14908. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14909. std::move(progress));
  14910. }
  14911. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14912. ContentReceiver content_receiver,
  14913. DownloadProgress progress) {
  14914. return Get(path, headers, nullptr, std::move(content_receiver),
  14915. std::move(progress));
  14916. }
  14917. inline Result ClientImpl::Get(const std::string &path,
  14918. ResponseHandler response_handler,
  14919. ContentReceiver content_receiver,
  14920. DownloadProgress progress) {
  14921. return Get(path, Headers(), std::move(response_handler),
  14922. std::move(content_receiver), std::move(progress));
  14923. }
  14924. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14925. ResponseHandler response_handler,
  14926. ContentReceiver content_receiver,
  14927. DownloadProgress progress) {
  14928. Request req;
  14929. req.method = "GET";
  14930. req.path = path;
  14931. req.headers = headers;
  14932. req.response_handler = std::move(response_handler);
  14933. req.content_receiver =
  14934. [content_receiver](const char *data, size_t data_length,
  14935. size_t /*offset*/, size_t /*total_length*/) {
  14936. return content_receiver(data, data_length);
  14937. };
  14938. req.download_progress = std::move(progress);
  14939. if (max_timeout_msec_ > 0) {
  14940. req.start_time_ = std::chrono::steady_clock::now();
  14941. }
  14942. return send_(std::move(req));
  14943. }
  14944. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14945. const Headers &headers,
  14946. ContentReceiver content_receiver,
  14947. DownloadProgress progress) {
  14948. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14949. std::move(progress));
  14950. }
  14951. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14952. const Headers &headers,
  14953. ResponseHandler response_handler,
  14954. ContentReceiver content_receiver,
  14955. DownloadProgress progress) {
  14956. if (params.empty()) {
  14957. return Get(path, headers, std::move(response_handler),
  14958. std::move(content_receiver), std::move(progress));
  14959. }
  14960. std::string path_with_query = append_query_params(path, params);
  14961. return Get(path_with_query, headers, std::move(response_handler),
  14962. std::move(content_receiver), std::move(progress));
  14963. }
  14964. inline Result ClientImpl::Head(const std::string &path) {
  14965. return Head(path, Headers());
  14966. }
  14967. inline Result ClientImpl::Head(const std::string &path,
  14968. const Headers &headers) {
  14969. Request req;
  14970. req.method = "HEAD";
  14971. req.headers = headers;
  14972. req.path = path;
  14973. if (max_timeout_msec_ > 0) {
  14974. req.start_time_ = std::chrono::steady_clock::now();
  14975. }
  14976. return send_(std::move(req));
  14977. }
  14978. inline Result ClientImpl::Post(const std::string &path) {
  14979. return Post(path, std::string(), std::string());
  14980. }
  14981. inline Result ClientImpl::Post(const std::string &path,
  14982. const Headers &headers) {
  14983. return Post(path, headers, nullptr, 0, std::string());
  14984. }
  14985. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14986. size_t content_length,
  14987. const std::string &content_type,
  14988. UploadProgress progress) {
  14989. return Post(path, Headers(), body, content_length, content_type, progress);
  14990. }
  14991. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14992. const std::string &content_type,
  14993. UploadProgress progress) {
  14994. return Post(path, Headers(), body, content_type, progress);
  14995. }
  14996. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14997. return Post(path, Headers(), params);
  14998. }
  14999. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  15000. ContentProvider content_provider,
  15001. const std::string &content_type,
  15002. UploadProgress progress) {
  15003. return Post(path, Headers(), content_length, std::move(content_provider),
  15004. content_type, progress);
  15005. }
  15006. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  15007. ContentProvider content_provider,
  15008. const std::string &content_type,
  15009. ContentReceiver content_receiver,
  15010. UploadProgress progress) {
  15011. return Post(path, Headers(), content_length, std::move(content_provider),
  15012. content_type, std::move(content_receiver), progress);
  15013. }
  15014. inline Result ClientImpl::Post(const std::string &path,
  15015. ContentProviderWithoutLength content_provider,
  15016. const std::string &content_type,
  15017. UploadProgress progress) {
  15018. return Post(path, Headers(), std::move(content_provider), content_type,
  15019. progress);
  15020. }
  15021. inline Result ClientImpl::Post(const std::string &path,
  15022. ContentProviderWithoutLength content_provider,
  15023. const std::string &content_type,
  15024. ContentReceiver content_receiver,
  15025. UploadProgress progress) {
  15026. return Post(path, Headers(), std::move(content_provider), content_type,
  15027. std::move(content_receiver), progress);
  15028. }
  15029. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15030. const Params &params) {
  15031. auto query = detail::params_to_query_str(params);
  15032. return Post(path, headers, query, "application/x-www-form-urlencoded");
  15033. }
  15034. inline Result ClientImpl::Post(const std::string &path,
  15035. const UploadFormDataItems &items,
  15036. UploadProgress progress) {
  15037. return Post(path, Headers(), items, progress);
  15038. }
  15039. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15040. const UploadFormDataItems &items,
  15041. UploadProgress progress) {
  15042. const auto &boundary = detail::make_multipart_data_boundary();
  15043. const auto &content_type =
  15044. detail::serialize_multipart_formdata_get_content_type(boundary);
  15045. auto content_length = detail::get_multipart_content_length(items, boundary);
  15046. return Post(path, headers, content_length,
  15047. detail::make_multipart_content_provider(items, boundary),
  15048. content_type, progress);
  15049. }
  15050. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15051. const UploadFormDataItems &items,
  15052. const std::string &boundary,
  15053. UploadProgress progress) {
  15054. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15055. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15056. }
  15057. const auto &content_type =
  15058. detail::serialize_multipart_formdata_get_content_type(boundary);
  15059. auto content_length = detail::get_multipart_content_length(items, boundary);
  15060. return Post(path, headers, content_length,
  15061. detail::make_multipart_content_provider(items, boundary),
  15062. content_type, progress);
  15063. }
  15064. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15065. const char *body, size_t content_length,
  15066. const std::string &content_type,
  15067. UploadProgress progress) {
  15068. return send_with_content_provider_and_receiver(
  15069. "POST", path, headers, body, content_length, nullptr, nullptr,
  15070. content_type, nullptr, progress);
  15071. }
  15072. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15073. const std::string &body,
  15074. const std::string &content_type,
  15075. UploadProgress progress) {
  15076. return send_with_content_provider_and_receiver(
  15077. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  15078. content_type, nullptr, progress);
  15079. }
  15080. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15081. size_t content_length,
  15082. ContentProvider content_provider,
  15083. const std::string &content_type,
  15084. UploadProgress progress) {
  15085. return send_with_content_provider_and_receiver(
  15086. "POST", path, headers, nullptr, content_length,
  15087. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15088. }
  15089. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15090. size_t content_length,
  15091. ContentProvider content_provider,
  15092. const std::string &content_type,
  15093. ContentReceiver content_receiver,
  15094. DownloadProgress progress) {
  15095. return send_with_content_provider_and_receiver(
  15096. "POST", path, headers, nullptr, content_length,
  15097. std::move(content_provider), nullptr, content_type,
  15098. std::move(content_receiver), std::move(progress));
  15099. }
  15100. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15101. ContentProviderWithoutLength content_provider,
  15102. const std::string &content_type,
  15103. UploadProgress progress) {
  15104. return send_with_content_provider_and_receiver(
  15105. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15106. content_type, nullptr, progress);
  15107. }
  15108. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15109. ContentProviderWithoutLength content_provider,
  15110. const std::string &content_type,
  15111. ContentReceiver content_receiver,
  15112. DownloadProgress progress) {
  15113. return send_with_content_provider_and_receiver(
  15114. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15115. content_type, std::move(content_receiver), std::move(progress));
  15116. }
  15117. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15118. const UploadFormDataItems &items,
  15119. const FormDataProviderItems &provider_items,
  15120. UploadProgress progress) {
  15121. const auto &boundary = detail::make_multipart_data_boundary();
  15122. const auto &content_type =
  15123. detail::serialize_multipart_formdata_get_content_type(boundary);
  15124. return send_with_content_provider_and_receiver(
  15125. "POST", path, headers, nullptr, 0, nullptr,
  15126. get_multipart_content_provider(boundary, items, provider_items),
  15127. content_type, nullptr, progress);
  15128. }
  15129. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15130. const std::string &body,
  15131. const std::string &content_type,
  15132. ContentReceiver content_receiver,
  15133. DownloadProgress progress) {
  15134. Request req;
  15135. req.method = "POST";
  15136. req.path = path;
  15137. req.headers = headers;
  15138. req.body = body;
  15139. req.content_receiver =
  15140. [content_receiver](const char *data, size_t data_length,
  15141. size_t /*offset*/, size_t /*total_length*/) {
  15142. return content_receiver(data, data_length);
  15143. };
  15144. req.download_progress = std::move(progress);
  15145. if (max_timeout_msec_ > 0) {
  15146. req.start_time_ = std::chrono::steady_clock::now();
  15147. }
  15148. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15149. return send_(std::move(req));
  15150. }
  15151. inline Result ClientImpl::Put(const std::string &path) {
  15152. return Put(path, std::string(), std::string());
  15153. }
  15154. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  15155. return Put(path, headers, nullptr, 0, std::string());
  15156. }
  15157. inline Result ClientImpl::Put(const std::string &path, const char *body,
  15158. size_t content_length,
  15159. const std::string &content_type,
  15160. UploadProgress progress) {
  15161. return Put(path, Headers(), body, content_length, content_type, progress);
  15162. }
  15163. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  15164. const std::string &content_type,
  15165. UploadProgress progress) {
  15166. return Put(path, Headers(), body, content_type, progress);
  15167. }
  15168. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  15169. return Put(path, Headers(), params);
  15170. }
  15171. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  15172. ContentProvider content_provider,
  15173. const std::string &content_type,
  15174. UploadProgress progress) {
  15175. return Put(path, Headers(), content_length, std::move(content_provider),
  15176. content_type, progress);
  15177. }
  15178. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  15179. ContentProvider content_provider,
  15180. const std::string &content_type,
  15181. ContentReceiver content_receiver,
  15182. UploadProgress progress) {
  15183. return Put(path, Headers(), content_length, std::move(content_provider),
  15184. content_type, std::move(content_receiver), progress);
  15185. }
  15186. inline Result ClientImpl::Put(const std::string &path,
  15187. ContentProviderWithoutLength content_provider,
  15188. const std::string &content_type,
  15189. UploadProgress progress) {
  15190. return Put(path, Headers(), std::move(content_provider), content_type,
  15191. progress);
  15192. }
  15193. inline Result ClientImpl::Put(const std::string &path,
  15194. ContentProviderWithoutLength content_provider,
  15195. const std::string &content_type,
  15196. ContentReceiver content_receiver,
  15197. UploadProgress progress) {
  15198. return Put(path, Headers(), std::move(content_provider), content_type,
  15199. std::move(content_receiver), progress);
  15200. }
  15201. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15202. const Params &params) {
  15203. auto query = detail::params_to_query_str(params);
  15204. return Put(path, headers, query, "application/x-www-form-urlencoded");
  15205. }
  15206. inline Result ClientImpl::Put(const std::string &path,
  15207. const UploadFormDataItems &items,
  15208. UploadProgress progress) {
  15209. return Put(path, Headers(), items, progress);
  15210. }
  15211. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15212. const UploadFormDataItems &items,
  15213. UploadProgress progress) {
  15214. const auto &boundary = detail::make_multipart_data_boundary();
  15215. const auto &content_type =
  15216. detail::serialize_multipart_formdata_get_content_type(boundary);
  15217. auto content_length = detail::get_multipart_content_length(items, boundary);
  15218. return Put(path, headers, content_length,
  15219. detail::make_multipart_content_provider(items, boundary),
  15220. content_type, progress);
  15221. }
  15222. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15223. const UploadFormDataItems &items,
  15224. const std::string &boundary,
  15225. UploadProgress progress) {
  15226. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15227. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15228. }
  15229. const auto &content_type =
  15230. detail::serialize_multipart_formdata_get_content_type(boundary);
  15231. auto content_length = detail::get_multipart_content_length(items, boundary);
  15232. return Put(path, headers, content_length,
  15233. detail::make_multipart_content_provider(items, boundary),
  15234. content_type, progress);
  15235. }
  15236. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15237. const char *body, size_t content_length,
  15238. const std::string &content_type,
  15239. UploadProgress progress) {
  15240. return send_with_content_provider_and_receiver(
  15241. "PUT", path, headers, body, content_length, nullptr, nullptr,
  15242. content_type, nullptr, progress);
  15243. }
  15244. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15245. const std::string &body,
  15246. const std::string &content_type,
  15247. UploadProgress progress) {
  15248. return send_with_content_provider_and_receiver(
  15249. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  15250. content_type, nullptr, progress);
  15251. }
  15252. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15253. size_t content_length,
  15254. ContentProvider content_provider,
  15255. const std::string &content_type,
  15256. UploadProgress progress) {
  15257. return send_with_content_provider_and_receiver(
  15258. "PUT", path, headers, nullptr, content_length,
  15259. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15260. }
  15261. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15262. size_t content_length,
  15263. ContentProvider content_provider,
  15264. const std::string &content_type,
  15265. ContentReceiver content_receiver,
  15266. UploadProgress progress) {
  15267. return send_with_content_provider_and_receiver(
  15268. "PUT", path, headers, nullptr, content_length,
  15269. std::move(content_provider), nullptr, content_type,
  15270. std::move(content_receiver), progress);
  15271. }
  15272. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15273. ContentProviderWithoutLength content_provider,
  15274. const std::string &content_type,
  15275. UploadProgress progress) {
  15276. return send_with_content_provider_and_receiver(
  15277. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15278. content_type, nullptr, progress);
  15279. }
  15280. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15281. ContentProviderWithoutLength content_provider,
  15282. const std::string &content_type,
  15283. ContentReceiver content_receiver,
  15284. UploadProgress progress) {
  15285. return send_with_content_provider_and_receiver(
  15286. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15287. content_type, std::move(content_receiver), progress);
  15288. }
  15289. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15290. const UploadFormDataItems &items,
  15291. const FormDataProviderItems &provider_items,
  15292. UploadProgress progress) {
  15293. const auto &boundary = detail::make_multipart_data_boundary();
  15294. const auto &content_type =
  15295. detail::serialize_multipart_formdata_get_content_type(boundary);
  15296. return send_with_content_provider_and_receiver(
  15297. "PUT", path, headers, nullptr, 0, nullptr,
  15298. get_multipart_content_provider(boundary, items, provider_items),
  15299. content_type, nullptr, progress);
  15300. }
  15301. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15302. const std::string &body,
  15303. const std::string &content_type,
  15304. ContentReceiver content_receiver,
  15305. DownloadProgress progress) {
  15306. Request req;
  15307. req.method = "PUT";
  15308. req.path = path;
  15309. req.headers = headers;
  15310. req.body = body;
  15311. req.content_receiver =
  15312. [content_receiver](const char *data, size_t data_length,
  15313. size_t /*offset*/, size_t /*total_length*/) {
  15314. return content_receiver(data, data_length);
  15315. };
  15316. req.download_progress = std::move(progress);
  15317. if (max_timeout_msec_ > 0) {
  15318. req.start_time_ = std::chrono::steady_clock::now();
  15319. }
  15320. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15321. return send_(std::move(req));
  15322. }
  15323. inline Result ClientImpl::Patch(const std::string &path) {
  15324. return Patch(path, std::string(), std::string());
  15325. }
  15326. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15327. UploadProgress progress) {
  15328. return Patch(path, headers, nullptr, 0, std::string(), progress);
  15329. }
  15330. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  15331. size_t content_length,
  15332. const std::string &content_type,
  15333. UploadProgress progress) {
  15334. return Patch(path, Headers(), body, content_length, content_type, progress);
  15335. }
  15336. inline Result ClientImpl::Patch(const std::string &path,
  15337. const std::string &body,
  15338. const std::string &content_type,
  15339. UploadProgress progress) {
  15340. return Patch(path, Headers(), body, content_type, progress);
  15341. }
  15342. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  15343. return Patch(path, Headers(), params);
  15344. }
  15345. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15346. ContentProvider content_provider,
  15347. const std::string &content_type,
  15348. UploadProgress progress) {
  15349. return Patch(path, Headers(), content_length, std::move(content_provider),
  15350. content_type, progress);
  15351. }
  15352. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15353. ContentProvider content_provider,
  15354. const std::string &content_type,
  15355. ContentReceiver content_receiver,
  15356. UploadProgress progress) {
  15357. return Patch(path, Headers(), content_length, std::move(content_provider),
  15358. content_type, std::move(content_receiver), progress);
  15359. }
  15360. inline Result ClientImpl::Patch(const std::string &path,
  15361. ContentProviderWithoutLength content_provider,
  15362. const std::string &content_type,
  15363. UploadProgress progress) {
  15364. return Patch(path, Headers(), std::move(content_provider), content_type,
  15365. progress);
  15366. }
  15367. inline Result ClientImpl::Patch(const std::string &path,
  15368. ContentProviderWithoutLength content_provider,
  15369. const std::string &content_type,
  15370. ContentReceiver content_receiver,
  15371. UploadProgress progress) {
  15372. return Patch(path, Headers(), std::move(content_provider), content_type,
  15373. std::move(content_receiver), progress);
  15374. }
  15375. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15376. const Params &params) {
  15377. auto query = detail::params_to_query_str(params);
  15378. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  15379. }
  15380. inline Result ClientImpl::Patch(const std::string &path,
  15381. const UploadFormDataItems &items,
  15382. UploadProgress progress) {
  15383. return Patch(path, Headers(), items, progress);
  15384. }
  15385. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15386. const UploadFormDataItems &items,
  15387. UploadProgress progress) {
  15388. const auto &boundary = detail::make_multipart_data_boundary();
  15389. const auto &content_type =
  15390. detail::serialize_multipart_formdata_get_content_type(boundary);
  15391. auto content_length = detail::get_multipart_content_length(items, boundary);
  15392. return Patch(path, headers, content_length,
  15393. detail::make_multipart_content_provider(items, boundary),
  15394. content_type, progress);
  15395. }
  15396. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15397. const UploadFormDataItems &items,
  15398. const std::string &boundary,
  15399. UploadProgress progress) {
  15400. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15401. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15402. }
  15403. const auto &content_type =
  15404. detail::serialize_multipart_formdata_get_content_type(boundary);
  15405. auto content_length = detail::get_multipart_content_length(items, boundary);
  15406. return Patch(path, headers, content_length,
  15407. detail::make_multipart_content_provider(items, boundary),
  15408. content_type, progress);
  15409. }
  15410. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15411. const char *body, size_t content_length,
  15412. const std::string &content_type,
  15413. UploadProgress progress) {
  15414. return send_with_content_provider_and_receiver(
  15415. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  15416. content_type, nullptr, progress);
  15417. }
  15418. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15419. const std::string &body,
  15420. const std::string &content_type,
  15421. UploadProgress progress) {
  15422. return send_with_content_provider_and_receiver(
  15423. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  15424. content_type, nullptr, progress);
  15425. }
  15426. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15427. size_t content_length,
  15428. ContentProvider content_provider,
  15429. const std::string &content_type,
  15430. UploadProgress progress) {
  15431. return send_with_content_provider_and_receiver(
  15432. "PATCH", path, headers, nullptr, content_length,
  15433. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15434. }
  15435. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15436. size_t content_length,
  15437. ContentProvider content_provider,
  15438. const std::string &content_type,
  15439. ContentReceiver content_receiver,
  15440. UploadProgress progress) {
  15441. return send_with_content_provider_and_receiver(
  15442. "PATCH", path, headers, nullptr, content_length,
  15443. std::move(content_provider), nullptr, content_type,
  15444. std::move(content_receiver), progress);
  15445. }
  15446. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15447. ContentProviderWithoutLength content_provider,
  15448. const std::string &content_type,
  15449. UploadProgress progress) {
  15450. return send_with_content_provider_and_receiver(
  15451. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15452. content_type, nullptr, progress);
  15453. }
  15454. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15455. ContentProviderWithoutLength content_provider,
  15456. const std::string &content_type,
  15457. ContentReceiver content_receiver,
  15458. UploadProgress progress) {
  15459. return send_with_content_provider_and_receiver(
  15460. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15461. content_type, std::move(content_receiver), progress);
  15462. }
  15463. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15464. const UploadFormDataItems &items,
  15465. const FormDataProviderItems &provider_items,
  15466. UploadProgress progress) {
  15467. const auto &boundary = detail::make_multipart_data_boundary();
  15468. const auto &content_type =
  15469. detail::serialize_multipart_formdata_get_content_type(boundary);
  15470. return send_with_content_provider_and_receiver(
  15471. "PATCH", path, headers, nullptr, 0, nullptr,
  15472. get_multipart_content_provider(boundary, items, provider_items),
  15473. content_type, nullptr, progress);
  15474. }
  15475. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15476. const std::string &body,
  15477. const std::string &content_type,
  15478. ContentReceiver content_receiver,
  15479. DownloadProgress progress) {
  15480. Request req;
  15481. req.method = "PATCH";
  15482. req.path = path;
  15483. req.headers = headers;
  15484. req.body = body;
  15485. req.content_receiver =
  15486. [content_receiver](const char *data, size_t data_length,
  15487. size_t /*offset*/, size_t /*total_length*/) {
  15488. return content_receiver(data, data_length);
  15489. };
  15490. req.download_progress = std::move(progress);
  15491. if (max_timeout_msec_ > 0) {
  15492. req.start_time_ = std::chrono::steady_clock::now();
  15493. }
  15494. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15495. return send_(std::move(req));
  15496. }
  15497. inline Result ClientImpl::Delete(const std::string &path,
  15498. DownloadProgress progress) {
  15499. return Delete(path, Headers(), std::string(), std::string(), progress);
  15500. }
  15501. inline Result ClientImpl::Delete(const std::string &path,
  15502. const Headers &headers,
  15503. DownloadProgress progress) {
  15504. return Delete(path, headers, std::string(), std::string(), progress);
  15505. }
  15506. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15507. size_t content_length,
  15508. const std::string &content_type,
  15509. DownloadProgress progress) {
  15510. return Delete(path, Headers(), body, content_length, content_type, progress);
  15511. }
  15512. inline Result ClientImpl::Delete(const std::string &path,
  15513. const std::string &body,
  15514. const std::string &content_type,
  15515. DownloadProgress progress) {
  15516. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15517. progress);
  15518. }
  15519. inline Result ClientImpl::Delete(const std::string &path,
  15520. const Headers &headers,
  15521. const std::string &body,
  15522. const std::string &content_type,
  15523. DownloadProgress progress) {
  15524. return Delete(path, headers, body.data(), body.size(), content_type,
  15525. progress);
  15526. }
  15527. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15528. DownloadProgress progress) {
  15529. return Delete(path, Headers(), params, progress);
  15530. }
  15531. inline Result ClientImpl::Delete(const std::string &path,
  15532. const Headers &headers, const Params &params,
  15533. DownloadProgress progress) {
  15534. auto query = detail::params_to_query_str(params);
  15535. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15536. progress);
  15537. }
  15538. inline Result ClientImpl::Delete(const std::string &path,
  15539. const Headers &headers, const char *body,
  15540. size_t content_length,
  15541. const std::string &content_type,
  15542. DownloadProgress progress) {
  15543. Request req;
  15544. req.method = "DELETE";
  15545. req.headers = headers;
  15546. req.path = path;
  15547. req.download_progress = std::move(progress);
  15548. if (max_timeout_msec_ > 0) {
  15549. req.start_time_ = std::chrono::steady_clock::now();
  15550. }
  15551. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15552. req.body.assign(body, content_length);
  15553. return send_(std::move(req));
  15554. }
  15555. inline Result ClientImpl::Options(const std::string &path) {
  15556. return Options(path, Headers());
  15557. }
  15558. inline Result ClientImpl::Options(const std::string &path,
  15559. const Headers &headers) {
  15560. Request req;
  15561. req.method = "OPTIONS";
  15562. req.headers = headers;
  15563. req.path = path;
  15564. if (max_timeout_msec_ > 0) {
  15565. req.start_time_ = std::chrono::steady_clock::now();
  15566. }
  15567. return send_(std::move(req));
  15568. }
  15569. inline void ClientImpl::stop() {
  15570. std::lock_guard<std::mutex> guard(socket_mutex_);
  15571. stop_requested_ = true;
  15572. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15573. // do is to shutdown_socket, so that threads using this socket suddenly
  15574. // discover they can't read/write any more and error out. Everything else
  15575. // (closing the socket, shutting ssl down) is unsafe because these actions
  15576. // are not thread-safe.
  15577. if (socket_requests_in_flight_ > 0) {
  15578. shutdown_socket(socket_);
  15579. // Aside from that, we set a flag for the socket to be closed when we're
  15580. // done.
  15581. socket_should_be_closed_when_request_is_done_ = true;
  15582. return;
  15583. }
  15584. disconnect(/*gracefully=*/true);
  15585. }
  15586. inline std::string ClientImpl::host() const { return host_; }
  15587. inline int ClientImpl::port() const { return port_; }
  15588. inline size_t ClientImpl::is_socket_open() const {
  15589. std::lock_guard<std::mutex> guard(socket_mutex_);
  15590. return socket_.is_open();
  15591. }
  15592. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15593. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15594. connection_timeout_sec_ = sec;
  15595. connection_timeout_usec_ = usec;
  15596. }
  15597. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15598. read_timeout_sec_ = sec;
  15599. read_timeout_usec_ = usec;
  15600. }
  15601. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15602. write_timeout_sec_ = sec;
  15603. write_timeout_usec_ = usec;
  15604. }
  15605. inline void ClientImpl::set_max_timeout(time_t msec) {
  15606. max_timeout_msec_ = msec;
  15607. }
  15608. inline void ClientImpl::set_basic_auth(const std::string &username,
  15609. const std::string &password) {
  15610. basic_auth_username_ = username;
  15611. basic_auth_password_ = password;
  15612. }
  15613. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15614. bearer_token_auth_token_ = token;
  15615. }
  15616. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15617. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15618. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15619. inline void
  15620. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15621. set_direct_hostname_addr_map(std::move(addr_map));
  15622. }
  15623. inline void ClientImpl::set_direct_hostname_addr_map(
  15624. std::map<std::string, std::string> addr_map) {
  15625. addr_map_ = std::move(addr_map);
  15626. }
  15627. inline void ClientImpl::set_tunnel_hostname_addr_map(
  15628. std::map<std::string, std::string> addr_map) {
  15629. tunnel_addr_map_ = std::move(addr_map);
  15630. }
  15631. inline void ClientImpl::set_default_headers(Headers headers) {
  15632. default_headers_ = std::move(headers);
  15633. }
  15634. inline void ClientImpl::set_header_writer(
  15635. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15636. header_writer_ = writer;
  15637. }
  15638. inline void ClientImpl::set_address_family(int family) {
  15639. address_family_ = family;
  15640. }
  15641. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15642. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15643. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15644. socket_options_ = std::move(socket_options);
  15645. }
  15646. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15647. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15648. inline void ClientImpl::set_payload_max_length(size_t length) {
  15649. payload_max_length_ = length;
  15650. has_payload_max_length_ = true;
  15651. }
  15652. inline void ClientImpl::set_interface(const std::string &intf) {
  15653. interface_ = intf;
  15654. }
  15655. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15656. proxy_host_ = host;
  15657. proxy_port_ = port;
  15658. std::lock_guard<std::mutex> guard(socket_mutex_);
  15659. disconnect(/*gracefully=*/true);
  15660. }
  15661. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15662. const std::string &password) {
  15663. proxy_basic_auth_username_ = username;
  15664. proxy_basic_auth_password_ = password;
  15665. }
  15666. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15667. proxy_bearer_token_auth_token_ = token;
  15668. }
  15669. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15670. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  15671. std::lock_guard<std::mutex> guard(socket_mutex_);
  15672. disconnect(/*gracefully=*/true);
  15673. }
  15674. #ifdef CPPHTTPLIB_SSL_ENABLED
  15675. inline void ClientImpl::set_digest_auth(const std::string &username,
  15676. const std::string &password) {
  15677. digest_auth_username_ = username;
  15678. digest_auth_password_ = password;
  15679. }
  15680. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15681. const std::string &ca_cert_dir_path) {
  15682. ca_cert_file_path_ = ca_cert_file_path;
  15683. ca_cert_dir_path_ = ca_cert_dir_path;
  15684. }
  15685. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15686. const std::string &password) {
  15687. proxy_digest_auth_username_ = username;
  15688. proxy_digest_auth_password_ = password;
  15689. }
  15690. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15691. if (server_certificate_verification_ == enabled) { return; }
  15692. server_certificate_verification_ = enabled;
  15693. tls_settings_changed();
  15694. }
  15695. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15696. if (server_hostname_verification_ == enabled) { return; }
  15697. server_hostname_verification_ = enabled;
  15698. tls_settings_changed();
  15699. }
  15700. inline void ClientImpl::enable_system_ca(bool enabled) {
  15701. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15702. }
  15703. #endif
  15704. inline void ClientImpl::set_logger(Logger logger) {
  15705. logger_ = std::move(logger);
  15706. }
  15707. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15708. error_logger_ = std::move(error_logger);
  15709. }
  15710. /*
  15711. * SSL/TLS Common Implementation
  15712. */
  15713. inline ClientConnection::~ClientConnection() {
  15714. #ifdef CPPHTTPLIB_SSL_ENABLED
  15715. if (session) {
  15716. tls::shutdown(session, true);
  15717. tls::free_session(session);
  15718. session = nullptr;
  15719. }
  15720. #endif
  15721. if (sock != INVALID_SOCKET) {
  15722. detail::close_socket(sock);
  15723. sock = INVALID_SOCKET;
  15724. }
  15725. }
  15726. // Universal client implementation
  15727. inline Client::Client(const std::string &scheme_host_port)
  15728. : Client(scheme_host_port, std::string(), std::string()) {}
  15729. inline Client::Client(const std::string &scheme_host_port,
  15730. const std::string &client_cert_path,
  15731. const std::string &client_key_path) {
  15732. detail::UrlComponents uc;
  15733. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15734. auto &scheme = uc.scheme;
  15735. #ifdef CPPHTTPLIB_SSL_ENABLED
  15736. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15737. #else
  15738. if (!scheme.empty() && scheme != "http") {
  15739. #endif
  15740. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15741. std::string msg = "'" + scheme + "' scheme is not supported.";
  15742. throw std::invalid_argument(msg);
  15743. #endif
  15744. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15745. return;
  15746. }
  15747. auto is_ssl = scheme == "https";
  15748. auto host = std::move(uc.host);
  15749. auto port = is_ssl ? 443 : 80;
  15750. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15751. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15752. return;
  15753. }
  15754. if (is_ssl) {
  15755. #ifdef CPPHTTPLIB_SSL_ENABLED
  15756. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15757. client_key_path);
  15758. is_ssl_ = is_ssl;
  15759. #endif
  15760. } else {
  15761. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15762. client_key_path);
  15763. }
  15764. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  15765. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  15766. // A URL, but not one this client can use, such as one with userinfo. A
  15767. // Unix socket path may have "//" further on.
  15768. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15769. } else {
  15770. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15771. // if port param below changes.
  15772. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15773. client_cert_path, client_key_path);
  15774. }
  15775. }
  15776. inline Client::Client(const std::string &host, int port)
  15777. : Client(host, port, std::string(), std::string()) {}
  15778. inline Client::Client(const std::string &host, int port,
  15779. const std::string &client_cert_path,
  15780. const std::string &client_key_path)
  15781. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15782. client_key_path)) {}
  15783. inline Client::~Client() = default;
  15784. inline bool Client::is_valid() const {
  15785. return cli_ != nullptr && cli_->is_valid();
  15786. }
  15787. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15788. return cli_->Get(path, std::move(progress));
  15789. }
  15790. inline Result Client::Get(const std::string &path, const Headers &headers,
  15791. DownloadProgress progress) {
  15792. return cli_->Get(path, headers, std::move(progress));
  15793. }
  15794. inline Result Client::Get(const std::string &path,
  15795. ContentReceiver content_receiver,
  15796. DownloadProgress progress) {
  15797. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15798. }
  15799. inline Result Client::Get(const std::string &path, const Headers &headers,
  15800. ContentReceiver content_receiver,
  15801. DownloadProgress progress) {
  15802. return cli_->Get(path, headers, std::move(content_receiver),
  15803. std::move(progress));
  15804. }
  15805. inline Result Client::Get(const std::string &path,
  15806. ResponseHandler response_handler,
  15807. ContentReceiver content_receiver,
  15808. DownloadProgress progress) {
  15809. return cli_->Get(path, std::move(response_handler),
  15810. std::move(content_receiver), std::move(progress));
  15811. }
  15812. inline Result Client::Get(const std::string &path, const Headers &headers,
  15813. ResponseHandler response_handler,
  15814. ContentReceiver content_receiver,
  15815. DownloadProgress progress) {
  15816. return cli_->Get(path, headers, std::move(response_handler),
  15817. std::move(content_receiver), std::move(progress));
  15818. }
  15819. inline Result Client::Get(const std::string &path, const Params &params,
  15820. DownloadProgress progress) {
  15821. return cli_->Get(path, params, std::move(progress));
  15822. }
  15823. inline Result Client::Get(const std::string &path, const Params &params,
  15824. const Headers &headers, DownloadProgress progress) {
  15825. return cli_->Get(path, params, headers, std::move(progress));
  15826. }
  15827. inline Result Client::Get(const std::string &path, const Params &params,
  15828. const Headers &headers,
  15829. ContentReceiver content_receiver,
  15830. DownloadProgress progress) {
  15831. return cli_->Get(path, params, headers, std::move(content_receiver),
  15832. std::move(progress));
  15833. }
  15834. inline Result Client::Get(const std::string &path, const Params &params,
  15835. const Headers &headers,
  15836. ResponseHandler response_handler,
  15837. ContentReceiver content_receiver,
  15838. DownloadProgress progress) {
  15839. return cli_->Get(path, params, headers, std::move(response_handler),
  15840. std::move(content_receiver), std::move(progress));
  15841. }
  15842. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15843. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15844. return cli_->Head(path, headers);
  15845. }
  15846. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15847. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15848. return cli_->Post(path, headers);
  15849. }
  15850. inline Result Client::Post(const std::string &path, const char *body,
  15851. size_t content_length,
  15852. const std::string &content_type,
  15853. UploadProgress progress) {
  15854. return cli_->Post(path, body, content_length, content_type, progress);
  15855. }
  15856. inline Result Client::Post(const std::string &path, const Headers &headers,
  15857. const char *body, size_t content_length,
  15858. const std::string &content_type,
  15859. UploadProgress progress) {
  15860. return cli_->Post(path, headers, body, content_length, content_type,
  15861. progress);
  15862. }
  15863. inline Result Client::Post(const std::string &path, const std::string &body,
  15864. const std::string &content_type,
  15865. UploadProgress progress) {
  15866. return cli_->Post(path, body, content_type, progress);
  15867. }
  15868. inline Result Client::Post(const std::string &path, const Headers &headers,
  15869. const std::string &body,
  15870. const std::string &content_type,
  15871. UploadProgress progress) {
  15872. return cli_->Post(path, headers, body, content_type, progress);
  15873. }
  15874. inline Result Client::Post(const std::string &path, size_t content_length,
  15875. ContentProvider content_provider,
  15876. const std::string &content_type,
  15877. UploadProgress progress) {
  15878. return cli_->Post(path, content_length, std::move(content_provider),
  15879. content_type, progress);
  15880. }
  15881. inline Result Client::Post(const std::string &path, size_t content_length,
  15882. ContentProvider content_provider,
  15883. const std::string &content_type,
  15884. ContentReceiver content_receiver,
  15885. UploadProgress progress) {
  15886. return cli_->Post(path, content_length, std::move(content_provider),
  15887. content_type, std::move(content_receiver), progress);
  15888. }
  15889. inline Result Client::Post(const std::string &path,
  15890. ContentProviderWithoutLength content_provider,
  15891. const std::string &content_type,
  15892. UploadProgress progress) {
  15893. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15894. }
  15895. inline Result Client::Post(const std::string &path,
  15896. ContentProviderWithoutLength content_provider,
  15897. const std::string &content_type,
  15898. ContentReceiver content_receiver,
  15899. UploadProgress progress) {
  15900. return cli_->Post(path, std::move(content_provider), content_type,
  15901. std::move(content_receiver), progress);
  15902. }
  15903. inline Result Client::Post(const std::string &path, const Headers &headers,
  15904. size_t content_length,
  15905. ContentProvider content_provider,
  15906. const std::string &content_type,
  15907. UploadProgress progress) {
  15908. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15909. content_type, progress);
  15910. }
  15911. inline Result Client::Post(const std::string &path, const Headers &headers,
  15912. size_t content_length,
  15913. ContentProvider content_provider,
  15914. const std::string &content_type,
  15915. ContentReceiver content_receiver,
  15916. DownloadProgress progress) {
  15917. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15918. content_type, std::move(content_receiver), progress);
  15919. }
  15920. inline Result Client::Post(const std::string &path, const Headers &headers,
  15921. ContentProviderWithoutLength content_provider,
  15922. const std::string &content_type,
  15923. UploadProgress progress) {
  15924. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15925. progress);
  15926. }
  15927. inline Result Client::Post(const std::string &path, const Headers &headers,
  15928. ContentProviderWithoutLength content_provider,
  15929. const std::string &content_type,
  15930. ContentReceiver content_receiver,
  15931. DownloadProgress progress) {
  15932. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15933. std::move(content_receiver), progress);
  15934. }
  15935. inline Result Client::Post(const std::string &path, const Params &params) {
  15936. return cli_->Post(path, params);
  15937. }
  15938. inline Result Client::Post(const std::string &path, const Headers &headers,
  15939. const Params &params) {
  15940. return cli_->Post(path, headers, params);
  15941. }
  15942. inline Result Client::Post(const std::string &path,
  15943. const UploadFormDataItems &items,
  15944. UploadProgress progress) {
  15945. return cli_->Post(path, items, progress);
  15946. }
  15947. inline Result Client::Post(const std::string &path, const Headers &headers,
  15948. const UploadFormDataItems &items,
  15949. UploadProgress progress) {
  15950. return cli_->Post(path, headers, items, progress);
  15951. }
  15952. inline Result Client::Post(const std::string &path, const Headers &headers,
  15953. const UploadFormDataItems &items,
  15954. const std::string &boundary,
  15955. UploadProgress progress) {
  15956. return cli_->Post(path, headers, items, boundary, progress);
  15957. }
  15958. inline Result Client::Post(const std::string &path, const Headers &headers,
  15959. const UploadFormDataItems &items,
  15960. const FormDataProviderItems &provider_items,
  15961. UploadProgress progress) {
  15962. return cli_->Post(path, headers, items, provider_items, progress);
  15963. }
  15964. inline Result Client::Post(const std::string &path, const Headers &headers,
  15965. const std::string &body,
  15966. const std::string &content_type,
  15967. ContentReceiver content_receiver,
  15968. DownloadProgress progress) {
  15969. return cli_->Post(path, headers, body, content_type,
  15970. std::move(content_receiver), progress);
  15971. }
  15972. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15973. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15974. return cli_->Put(path, headers);
  15975. }
  15976. inline Result Client::Put(const std::string &path, const char *body,
  15977. size_t content_length,
  15978. const std::string &content_type,
  15979. UploadProgress progress) {
  15980. return cli_->Put(path, body, content_length, content_type, progress);
  15981. }
  15982. inline Result Client::Put(const std::string &path, const Headers &headers,
  15983. const char *body, size_t content_length,
  15984. const std::string &content_type,
  15985. UploadProgress progress) {
  15986. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15987. }
  15988. inline Result Client::Put(const std::string &path, const std::string &body,
  15989. const std::string &content_type,
  15990. UploadProgress progress) {
  15991. return cli_->Put(path, body, content_type, progress);
  15992. }
  15993. inline Result Client::Put(const std::string &path, const Headers &headers,
  15994. const std::string &body,
  15995. const std::string &content_type,
  15996. UploadProgress progress) {
  15997. return cli_->Put(path, headers, body, content_type, progress);
  15998. }
  15999. inline Result Client::Put(const std::string &path, size_t content_length,
  16000. ContentProvider content_provider,
  16001. const std::string &content_type,
  16002. UploadProgress progress) {
  16003. return cli_->Put(path, content_length, std::move(content_provider),
  16004. content_type, progress);
  16005. }
  16006. inline Result Client::Put(const std::string &path, size_t content_length,
  16007. ContentProvider content_provider,
  16008. const std::string &content_type,
  16009. ContentReceiver content_receiver,
  16010. UploadProgress progress) {
  16011. return cli_->Put(path, content_length, std::move(content_provider),
  16012. content_type, std::move(content_receiver), progress);
  16013. }
  16014. inline Result Client::Put(const std::string &path,
  16015. ContentProviderWithoutLength content_provider,
  16016. const std::string &content_type,
  16017. UploadProgress progress) {
  16018. return cli_->Put(path, std::move(content_provider), content_type, progress);
  16019. }
  16020. inline Result Client::Put(const std::string &path,
  16021. ContentProviderWithoutLength content_provider,
  16022. const std::string &content_type,
  16023. ContentReceiver content_receiver,
  16024. UploadProgress progress) {
  16025. return cli_->Put(path, std::move(content_provider), content_type,
  16026. std::move(content_receiver), progress);
  16027. }
  16028. inline Result Client::Put(const std::string &path, const Headers &headers,
  16029. size_t content_length,
  16030. ContentProvider content_provider,
  16031. const std::string &content_type,
  16032. UploadProgress progress) {
  16033. return cli_->Put(path, headers, content_length, std::move(content_provider),
  16034. content_type, progress);
  16035. }
  16036. inline Result Client::Put(const std::string &path, const Headers &headers,
  16037. size_t content_length,
  16038. ContentProvider content_provider,
  16039. const std::string &content_type,
  16040. ContentReceiver content_receiver,
  16041. UploadProgress progress) {
  16042. return cli_->Put(path, headers, content_length, std::move(content_provider),
  16043. content_type, std::move(content_receiver), progress);
  16044. }
  16045. inline Result Client::Put(const std::string &path, const Headers &headers,
  16046. ContentProviderWithoutLength content_provider,
  16047. const std::string &content_type,
  16048. UploadProgress progress) {
  16049. return cli_->Put(path, headers, std::move(content_provider), content_type,
  16050. progress);
  16051. }
  16052. inline Result Client::Put(const std::string &path, const Headers &headers,
  16053. ContentProviderWithoutLength content_provider,
  16054. const std::string &content_type,
  16055. ContentReceiver content_receiver,
  16056. UploadProgress progress) {
  16057. return cli_->Put(path, headers, std::move(content_provider), content_type,
  16058. std::move(content_receiver), progress);
  16059. }
  16060. inline Result Client::Put(const std::string &path, const Params &params) {
  16061. return cli_->Put(path, params);
  16062. }
  16063. inline Result Client::Put(const std::string &path, const Headers &headers,
  16064. const Params &params) {
  16065. return cli_->Put(path, headers, params);
  16066. }
  16067. inline Result Client::Put(const std::string &path,
  16068. const UploadFormDataItems &items,
  16069. UploadProgress progress) {
  16070. return cli_->Put(path, items, progress);
  16071. }
  16072. inline Result Client::Put(const std::string &path, const Headers &headers,
  16073. const UploadFormDataItems &items,
  16074. UploadProgress progress) {
  16075. return cli_->Put(path, headers, items, progress);
  16076. }
  16077. inline Result Client::Put(const std::string &path, const Headers &headers,
  16078. const UploadFormDataItems &items,
  16079. const std::string &boundary,
  16080. UploadProgress progress) {
  16081. return cli_->Put(path, headers, items, boundary, progress);
  16082. }
  16083. inline Result Client::Put(const std::string &path, const Headers &headers,
  16084. const UploadFormDataItems &items,
  16085. const FormDataProviderItems &provider_items,
  16086. UploadProgress progress) {
  16087. return cli_->Put(path, headers, items, provider_items, progress);
  16088. }
  16089. inline Result Client::Put(const std::string &path, const Headers &headers,
  16090. const std::string &body,
  16091. const std::string &content_type,
  16092. ContentReceiver content_receiver,
  16093. DownloadProgress progress) {
  16094. return cli_->Put(path, headers, body, content_type, content_receiver,
  16095. progress);
  16096. }
  16097. inline Result Client::Patch(const std::string &path) {
  16098. return cli_->Patch(path);
  16099. }
  16100. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  16101. return cli_->Patch(path, headers);
  16102. }
  16103. inline Result Client::Patch(const std::string &path, const char *body,
  16104. size_t content_length,
  16105. const std::string &content_type,
  16106. UploadProgress progress) {
  16107. return cli_->Patch(path, body, content_length, content_type, progress);
  16108. }
  16109. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16110. const char *body, size_t content_length,
  16111. const std::string &content_type,
  16112. UploadProgress progress) {
  16113. return cli_->Patch(path, headers, body, content_length, content_type,
  16114. progress);
  16115. }
  16116. inline Result Client::Patch(const std::string &path, const std::string &body,
  16117. const std::string &content_type,
  16118. UploadProgress progress) {
  16119. return cli_->Patch(path, body, content_type, progress);
  16120. }
  16121. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16122. const std::string &body,
  16123. const std::string &content_type,
  16124. UploadProgress progress) {
  16125. return cli_->Patch(path, headers, body, content_type, progress);
  16126. }
  16127. inline Result Client::Patch(const std::string &path, size_t content_length,
  16128. ContentProvider content_provider,
  16129. const std::string &content_type,
  16130. UploadProgress progress) {
  16131. return cli_->Patch(path, content_length, std::move(content_provider),
  16132. content_type, progress);
  16133. }
  16134. inline Result Client::Patch(const std::string &path, size_t content_length,
  16135. ContentProvider content_provider,
  16136. const std::string &content_type,
  16137. ContentReceiver content_receiver,
  16138. UploadProgress progress) {
  16139. return cli_->Patch(path, content_length, std::move(content_provider),
  16140. content_type, std::move(content_receiver), progress);
  16141. }
  16142. inline Result Client::Patch(const std::string &path,
  16143. ContentProviderWithoutLength content_provider,
  16144. const std::string &content_type,
  16145. UploadProgress progress) {
  16146. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  16147. }
  16148. inline Result Client::Patch(const std::string &path,
  16149. ContentProviderWithoutLength content_provider,
  16150. const std::string &content_type,
  16151. ContentReceiver content_receiver,
  16152. UploadProgress progress) {
  16153. return cli_->Patch(path, std::move(content_provider), content_type,
  16154. std::move(content_receiver), progress);
  16155. }
  16156. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16157. size_t content_length,
  16158. ContentProvider content_provider,
  16159. const std::string &content_type,
  16160. UploadProgress progress) {
  16161. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  16162. content_type, progress);
  16163. }
  16164. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16165. size_t content_length,
  16166. ContentProvider content_provider,
  16167. const std::string &content_type,
  16168. ContentReceiver content_receiver,
  16169. UploadProgress progress) {
  16170. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  16171. content_type, std::move(content_receiver), progress);
  16172. }
  16173. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16174. ContentProviderWithoutLength content_provider,
  16175. const std::string &content_type,
  16176. UploadProgress progress) {
  16177. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16178. progress);
  16179. }
  16180. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16181. ContentProviderWithoutLength content_provider,
  16182. const std::string &content_type,
  16183. ContentReceiver content_receiver,
  16184. UploadProgress progress) {
  16185. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16186. std::move(content_receiver), progress);
  16187. }
  16188. inline Result Client::Patch(const std::string &path, const Params &params) {
  16189. return cli_->Patch(path, params);
  16190. }
  16191. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16192. const Params &params) {
  16193. return cli_->Patch(path, headers, params);
  16194. }
  16195. inline Result Client::Patch(const std::string &path,
  16196. const UploadFormDataItems &items,
  16197. UploadProgress progress) {
  16198. return cli_->Patch(path, items, progress);
  16199. }
  16200. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16201. const UploadFormDataItems &items,
  16202. UploadProgress progress) {
  16203. return cli_->Patch(path, headers, items, progress);
  16204. }
  16205. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16206. const UploadFormDataItems &items,
  16207. const std::string &boundary,
  16208. UploadProgress progress) {
  16209. return cli_->Patch(path, headers, items, boundary, progress);
  16210. }
  16211. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16212. const UploadFormDataItems &items,
  16213. const FormDataProviderItems &provider_items,
  16214. UploadProgress progress) {
  16215. return cli_->Patch(path, headers, items, provider_items, progress);
  16216. }
  16217. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16218. const std::string &body,
  16219. const std::string &content_type,
  16220. ContentReceiver content_receiver,
  16221. DownloadProgress progress) {
  16222. return cli_->Patch(path, headers, body, content_type, content_receiver,
  16223. progress);
  16224. }
  16225. inline Result Client::Delete(const std::string &path,
  16226. DownloadProgress progress) {
  16227. return cli_->Delete(path, progress);
  16228. }
  16229. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16230. DownloadProgress progress) {
  16231. return cli_->Delete(path, headers, progress);
  16232. }
  16233. inline Result Client::Delete(const std::string &path, const char *body,
  16234. size_t content_length,
  16235. const std::string &content_type,
  16236. DownloadProgress progress) {
  16237. return cli_->Delete(path, body, content_length, content_type, progress);
  16238. }
  16239. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16240. const char *body, size_t content_length,
  16241. const std::string &content_type,
  16242. DownloadProgress progress) {
  16243. return cli_->Delete(path, headers, body, content_length, content_type,
  16244. progress);
  16245. }
  16246. inline Result Client::Delete(const std::string &path, const std::string &body,
  16247. const std::string &content_type,
  16248. DownloadProgress progress) {
  16249. return cli_->Delete(path, body, content_type, progress);
  16250. }
  16251. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16252. const std::string &body,
  16253. const std::string &content_type,
  16254. DownloadProgress progress) {
  16255. return cli_->Delete(path, headers, body, content_type, progress);
  16256. }
  16257. inline Result Client::Delete(const std::string &path, const Params &params,
  16258. DownloadProgress progress) {
  16259. return cli_->Delete(path, params, progress);
  16260. }
  16261. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16262. const Params &params, DownloadProgress progress) {
  16263. return cli_->Delete(path, headers, params, progress);
  16264. }
  16265. inline Result Client::Options(const std::string &path) {
  16266. return cli_->Options(path);
  16267. }
  16268. inline Result Client::Options(const std::string &path, const Headers &headers) {
  16269. return cli_->Options(path, headers);
  16270. }
  16271. inline ClientImpl::StreamHandle
  16272. Client::open_stream(const std::string &method, const std::string &path,
  16273. const Params &params, const Headers &headers,
  16274. const std::string &body, const std::string &content_type) {
  16275. return cli_->open_stream(method, path, params, headers, body, content_type);
  16276. }
  16277. inline bool Client::send(Request &req, Response &res, Error &error) {
  16278. return cli_->send(req, res, error);
  16279. }
  16280. inline Result Client::send(const Request &req) { return cli_->send(req); }
  16281. inline void Client::stop() { cli_->stop(); }
  16282. inline std::string Client::host() const { return cli_->host(); }
  16283. inline int Client::port() const { return cli_->port(); }
  16284. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  16285. inline socket_t Client::socket() const { return cli_->socket(); }
  16286. inline void
  16287. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  16288. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  16289. }
  16290. inline void Client::set_direct_hostname_addr_map(
  16291. std::map<std::string, std::string> addr_map) {
  16292. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  16293. }
  16294. inline void Client::set_tunnel_hostname_addr_map(
  16295. std::map<std::string, std::string> addr_map) {
  16296. cli_->set_tunnel_hostname_addr_map(std::move(addr_map));
  16297. }
  16298. inline void Client::set_default_headers(Headers headers) {
  16299. cli_->set_default_headers(std::move(headers));
  16300. }
  16301. inline void Client::set_header_writer(
  16302. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  16303. cli_->set_header_writer(writer);
  16304. }
  16305. inline void Client::set_address_family(int family) {
  16306. cli_->set_address_family(family);
  16307. }
  16308. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  16309. inline void Client::set_socket_options(SocketOptions socket_options) {
  16310. cli_->set_socket_options(std::move(socket_options));
  16311. }
  16312. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  16313. cli_->set_connection_timeout(sec, usec);
  16314. }
  16315. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  16316. cli_->set_read_timeout(sec, usec);
  16317. }
  16318. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  16319. cli_->set_write_timeout(sec, usec);
  16320. }
  16321. inline void Client::set_basic_auth(const std::string &username,
  16322. const std::string &password) {
  16323. cli_->set_basic_auth(username, password);
  16324. }
  16325. inline void Client::set_bearer_token_auth(const std::string &token) {
  16326. cli_->set_bearer_token_auth(token);
  16327. }
  16328. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  16329. inline void Client::set_follow_location(bool on) {
  16330. cli_->set_follow_location(on);
  16331. }
  16332. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  16333. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  16334. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  16335. inline void Client::set_payload_max_length(size_t length) {
  16336. cli_->set_payload_max_length(length);
  16337. }
  16338. inline void Client::set_interface(const std::string &intf) {
  16339. cli_->set_interface(intf);
  16340. }
  16341. inline void Client::set_proxy(const std::string &host, int port) {
  16342. cli_->set_proxy(host, port);
  16343. }
  16344. inline void Client::set_proxy_basic_auth(const std::string &username,
  16345. const std::string &password) {
  16346. cli_->set_proxy_basic_auth(username, password);
  16347. }
  16348. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  16349. cli_->set_proxy_bearer_token_auth(token);
  16350. }
  16351. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  16352. cli_->set_no_proxy(patterns);
  16353. }
  16354. inline void Client::set_logger(Logger logger) {
  16355. cli_->set_logger(std::move(logger));
  16356. }
  16357. inline void Client::set_error_logger(ErrorLogger error_logger) {
  16358. cli_->set_error_logger(std::move(error_logger));
  16359. }
  16360. /*
  16361. * Group 6: SSL Server and Client implementation
  16362. */
  16363. #ifdef CPPHTTPLIB_SSL_ENABLED
  16364. // SSL HTTP server implementation
  16365. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  16366. const char *client_ca_cert_file_path,
  16367. const char *client_ca_cert_dir_path,
  16368. const char *private_key_password) {
  16369. using namespace tls;
  16370. ctx_ = create_server_context();
  16371. if (!ctx_) { return; }
  16372. // Load server certificate and private key
  16373. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  16374. private_key_password)) {
  16375. last_ssl_error_ = static_cast<int>(get_error());
  16376. free_context(ctx_);
  16377. ctx_ = nullptr;
  16378. return;
  16379. }
  16380. // Load client CA certificates for client authentication
  16381. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  16382. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  16383. client_ca_cert_dir_path)) {
  16384. last_ssl_error_ = static_cast<int>(get_error());
  16385. free_context(ctx_);
  16386. ctx_ = nullptr;
  16387. return;
  16388. }
  16389. // Enable client certificate verification
  16390. set_verify_client(ctx_, true);
  16391. }
  16392. }
  16393. inline SSLServer::SSLServer(const PemMemory &pem) {
  16394. using namespace tls;
  16395. ctx_ = create_server_context();
  16396. if (ctx_) {
  16397. std::string cert_buf, key_buf;
  16398. if (!set_server_cert_pem(
  16399. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16400. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16401. pem.private_key_password)) {
  16402. last_ssl_error_ = static_cast<int>(get_error());
  16403. free_context(ctx_);
  16404. ctx_ = nullptr;
  16405. } else if (pem.client_ca_pem) {
  16406. auto ca_len = pem.client_ca_pem_len ? pem.client_ca_pem_len
  16407. : strlen(pem.client_ca_pem);
  16408. if (!load_ca_pem(ctx_, pem.client_ca_pem, ca_len)) {
  16409. last_ssl_error_ = static_cast<int>(get_error());
  16410. free_context(ctx_);
  16411. ctx_ = nullptr;
  16412. } else {
  16413. set_verify_client(ctx_, true);
  16414. }
  16415. }
  16416. }
  16417. }
  16418. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  16419. using namespace tls;
  16420. ctx_ = create_server_context();
  16421. if (ctx_) {
  16422. if (!setup_callback(ctx_)) {
  16423. free_context(ctx_);
  16424. ctx_ = nullptr;
  16425. }
  16426. }
  16427. }
  16428. inline SSLServer::~SSLServer() {
  16429. if (ctx_) { tls::free_context(ctx_); }
  16430. }
  16431. inline bool SSLServer::is_valid() const {
  16432. return ctx_ != nullptr && Server::is_valid();
  16433. }
  16434. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  16435. using namespace tls;
  16436. session_t session = nullptr;
  16437. {
  16438. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16439. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  16440. session = create_session(static_cast<ctx_t>(ctx_), sock);
  16441. if (session) { handshakes_in_progress_++; }
  16442. }
  16443. if (!session) {
  16444. last_ssl_error_ = static_cast<int>(get_error());
  16445. detail::shutdown_socket(sock);
  16446. detail::close_socket(sock);
  16447. return false;
  16448. }
  16449. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  16450. bool handshake_done = false;
  16451. bool ret = false;
  16452. bool websocket_upgraded = false;
  16453. auto cleanup = detail::scope_exit([&] {
  16454. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  16455. free_session(session);
  16456. if (handshake_done) {
  16457. detail::drain_and_close_socket(sock);
  16458. } else {
  16459. detail::shutdown_socket(sock);
  16460. detail::close_socket(sock);
  16461. }
  16462. });
  16463. // Perform TLS accept handshake with timeout
  16464. TlsError tls_err;
  16465. auto accepted = false;
  16466. {
  16467. auto handshake_left = detail::scope_exit([&] {
  16468. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16469. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  16470. });
  16471. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  16472. read_timeout_usec_, &tls_err);
  16473. }
  16474. if (!accepted) {
  16475. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16476. // Map TlsError to legacy ssl_error for backward compatibility
  16477. if (tls_err.code == ErrorCode::WantRead) {
  16478. last_ssl_error_ = SSL_ERROR_WANT_READ;
  16479. } else if (tls_err.code == ErrorCode::WantWrite) {
  16480. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  16481. } else {
  16482. last_ssl_error_ = SSL_ERROR_SSL;
  16483. }
  16484. #else
  16485. last_ssl_error_ = static_cast<int>(get_error());
  16486. #endif
  16487. return false;
  16488. }
  16489. handshake_done = true;
  16490. std::string remote_addr;
  16491. int remote_port = 0;
  16492. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  16493. std::string local_addr;
  16494. int local_port = 0;
  16495. detail::get_local_ip_and_port(sock, local_addr, local_port);
  16496. ret = serve_guarded([&]() {
  16497. return detail::process_server_socket_ssl(
  16498. svr_sock_, session, sock, keep_alive_max_count_,
  16499. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  16500. write_timeout_sec_, write_timeout_usec_,
  16501. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  16502. return process_request(
  16503. strm, remote_addr, remote_port, local_addr, local_port,
  16504. close_connection, connection_closed,
  16505. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16506. });
  16507. });
  16508. return ret;
  16509. }
  16510. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16511. const char *key_pem,
  16512. const char *client_ca_pem,
  16513. const char *password) {
  16514. if (!ctx_) { return false; }
  16515. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16516. updates_pending_++;
  16517. auto se = detail::scope_exit([&] {
  16518. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16519. });
  16520. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16521. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16522. return false;
  16523. }
  16524. if (client_ca_pem) {
  16525. if (!tls::update_server_client_ca(ctx_, client_ca_pem)) { return false; }
  16526. // As in the constructors, a client CA makes client certificates required
  16527. tls::set_verify_client(ctx_, true);
  16528. }
  16529. return true;
  16530. }
  16531. // SSL HTTP client implementation
  16532. inline SSLClient::~SSLClient() {
  16533. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16534. // base function rather than the derived function once we get to the
  16535. // base class destructor, and won't free the SSL (causing a leak).
  16536. // This must happen before the context is freed below: some backends
  16537. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16538. // context, so freeing the context first leaves close_notify reading
  16539. // freed memory.
  16540. shutdown_ssl_impl(socket_, true);
  16541. if (ctx_) {
  16542. tls::free_context(ctx_);
  16543. ctx_ = nullptr;
  16544. }
  16545. }
  16546. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16547. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16548. shutdown_ssl_impl(socket, shutdown_gracefully);
  16549. }
  16550. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16551. bool shutdown_gracefully) {
  16552. if (socket.sock == INVALID_SOCKET) {
  16553. assert(socket.ssl == nullptr);
  16554. return;
  16555. }
  16556. if (socket.ssl) {
  16557. tls::shutdown(socket.ssl, shutdown_gracefully);
  16558. {
  16559. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16560. tls::free_session(socket.ssl);
  16561. }
  16562. socket.ssl = nullptr;
  16563. }
  16564. assert(socket.ssl == nullptr);
  16565. }
  16566. inline bool SSLClient::process_socket(
  16567. const Socket &socket,
  16568. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16569. std::function<bool(Stream &strm)> callback) {
  16570. assert(socket.ssl);
  16571. return detail::process_client_socket_ssl(
  16572. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16573. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16574. [&](detail::SSLSocketStream &strm) {
  16575. auto ret = callback(strm);
  16576. // A request that failed after the handshake reports Error::Read or
  16577. // Error::Write; keep the TLS error behind it, such as a fatal alert
  16578. // from the server, for Result::ssl_error() and ssl_backend_error()
  16579. const auto &tls_error = strm.tls_error();
  16580. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  16581. last_ssl_error_ = static_cast<int>(tls_error.code);
  16582. last_backend_error_ = tls_error.backend_code;
  16583. }
  16584. return ret;
  16585. });
  16586. }
  16587. inline bool SSLClient::is_ssl() const { return true; }
  16588. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16589. if (!is_valid()) {
  16590. error = Error::SSLConnection;
  16591. return false;
  16592. }
  16593. return ClientImpl::create_and_connect_socket(socket, error);
  16594. }
  16595. inline bool SSLClient::setup_proxy_connection(
  16596. Socket &socket,
  16597. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16598. Response &res, bool &success, Error &error) {
  16599. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16600. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16601. return false;
  16602. }
  16603. if (!initialize_ssl(socket, error)) {
  16604. shutdown_socket(socket);
  16605. close_socket(socket);
  16606. success = false;
  16607. return false;
  16608. }
  16609. return true;
  16610. }
  16611. // Assumes that socket is a connection being opened, which no other thread uses
  16612. inline bool SSLClient::connect_with_proxy(
  16613. Socket &socket,
  16614. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16615. Response &res, bool &success, Error &error) {
  16616. success = true;
  16617. auto connect_target =
  16618. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  16619. auto retargeted = connect_target !=
  16620. detail::make_host_and_port_string_always_port(host_, port_);
  16621. Response proxy_res;
  16622. if (!detail::process_client_socket(
  16623. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16624. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16625. start_time, [&](Stream &strm) {
  16626. strm.set_read_interrupt(stop_interrupt());
  16627. Request req2;
  16628. req2.method = "CONNECT";
  16629. req2.path = connect_target;
  16630. if (retargeted) { req2.set_header("Host", connect_target); }
  16631. if (max_timeout_msec_ > 0) {
  16632. req2.start_time_ = std::chrono::steady_clock::now();
  16633. }
  16634. return process_request(strm, req2, proxy_res, false, error);
  16635. })) {
  16636. // Thread-safe to close everything because we are assuming there are no
  16637. // requests in flight
  16638. shutdown_ssl(socket, true);
  16639. shutdown_socket(socket);
  16640. close_socket(socket);
  16641. success = false;
  16642. return false;
  16643. }
  16644. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16645. if (!proxy_digest_auth_username_.empty() &&
  16646. !proxy_digest_auth_password_.empty()) {
  16647. std::map<std::string, std::string> auth;
  16648. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16649. // Close the current socket and create a new one for the authenticated
  16650. // request
  16651. shutdown_ssl(socket, true);
  16652. shutdown_socket(socket);
  16653. close_socket(socket);
  16654. // Create a new socket for the authenticated CONNECT request
  16655. if (!ensure_socket_connection(socket, error)) {
  16656. success = false;
  16657. return false;
  16658. }
  16659. proxy_res = Response();
  16660. if (!detail::process_client_socket(
  16661. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16662. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16663. start_time, [&](Stream &strm) {
  16664. strm.set_read_interrupt(stop_interrupt());
  16665. Request req3;
  16666. req3.method = "CONNECT";
  16667. req3.path = connect_target;
  16668. if (retargeted) { req3.set_header("Host", connect_target); }
  16669. req3.headers.insert(detail::make_digest_authentication_header(
  16670. req3, make_request_target(req3), auth, 1,
  16671. detail::random_string(10), proxy_digest_auth_username_,
  16672. proxy_digest_auth_password_, true));
  16673. if (max_timeout_msec_ > 0) {
  16674. req3.start_time_ = std::chrono::steady_clock::now();
  16675. }
  16676. return process_request(strm, req3, proxy_res, false, error);
  16677. })) {
  16678. // Thread-safe to close everything because we are assuming there are
  16679. // no requests in flight
  16680. shutdown_ssl(socket, true);
  16681. shutdown_socket(socket);
  16682. close_socket(socket);
  16683. success = false;
  16684. return false;
  16685. }
  16686. }
  16687. }
  16688. }
  16689. // If status code is not 200, proxy request is failed.
  16690. // Set error to ProxyConnection. A 407 is returned as the response of the
  16691. // request, so the caller sees the proxy asks for credentials; any other
  16692. // status would read as the answer of the origin, which it never reached.
  16693. if (proxy_res.status != StatusCode::OK_200) {
  16694. error = Error::ProxyConnection;
  16695. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16696. res = std::move(proxy_res);
  16697. } else {
  16698. success = false;
  16699. }
  16700. // Thread-safe to close everything because we are assuming there are
  16701. // no requests in flight
  16702. shutdown_ssl(socket, true);
  16703. shutdown_socket(socket);
  16704. close_socket(socket);
  16705. return false;
  16706. }
  16707. return true;
  16708. }
  16709. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16710. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16711. if (is_proxy_enabled_for_host(host_)) { return true; }
  16712. if (!initialize_ssl(socket, error)) {
  16713. shutdown_socket(socket);
  16714. close_socket(socket);
  16715. return false;
  16716. }
  16717. return true;
  16718. }
  16719. // SSL HTTP client implementation
  16720. inline SSLClient::SSLClient(const std::string &host)
  16721. : SSLClient(host, 443, std::string(), std::string()) {}
  16722. inline SSLClient::SSLClient(const std::string &host, int port)
  16723. : SSLClient(host, port, std::string(), std::string()) {}
  16724. inline void SSLClient::init_ctx() {
  16725. ctx_ = tls::create_client_context();
  16726. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16727. }
  16728. inline void SSLClient::reset_ctx_on_error() {
  16729. last_backend_error_ = tls::get_error();
  16730. tls::free_context(ctx_);
  16731. ctx_ = nullptr;
  16732. }
  16733. inline SSLClient::SSLClient(const std::string &host, int port,
  16734. const std::string &client_cert_path,
  16735. const std::string &client_key_path,
  16736. const std::string &private_key_password)
  16737. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16738. init_ctx();
  16739. if (!ctx_) { return; }
  16740. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16741. const char *password =
  16742. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16743. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16744. client_key_path.c_str(), password)) {
  16745. reset_ctx_on_error();
  16746. }
  16747. }
  16748. }
  16749. inline SSLClient::SSLClient(const std::string &host, int port,
  16750. const PemMemory &pem)
  16751. : ClientImpl(host, port) {
  16752. init_ctx();
  16753. if (!ctx_) { return; }
  16754. if (pem.cert_pem && pem.key_pem) {
  16755. std::string cert_buf, key_buf;
  16756. if (!tls::set_client_cert_pem(
  16757. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16758. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16759. pem.private_key_password)) {
  16760. reset_ctx_on_error();
  16761. }
  16762. }
  16763. }
  16764. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16765. if (ca_cert_store && ctx_) {
  16766. // set_ca_store takes ownership of ca_cert_store
  16767. tls::set_ca_store(ctx_, ca_cert_store);
  16768. ca_cert_store_set_ = true;
  16769. } else if (ca_cert_store) {
  16770. tls::free_ca_store(ca_cert_store);
  16771. }
  16772. custom_ca_loaded_ = true;
  16773. tls_settings_changed();
  16774. }
  16775. inline void
  16776. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16777. if (!ctx_) { return; }
  16778. server_certificate_verifier_ = verifier;
  16779. {
  16780. // Under the lock that creating a session from ctx_ takes
  16781. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16782. tls::set_verify_callback(ctx_, std::move(verifier));
  16783. }
  16784. tls_settings_changed();
  16785. }
  16786. inline void SSLClient::set_session_verifier(
  16787. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16788. session_verifier_ = std::move(verifier);
  16789. tls_settings_changed();
  16790. }
  16791. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16792. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16793. if (enable_windows_cert_verification_ == enabled) { return; }
  16794. enable_windows_cert_verification_ = enabled;
  16795. tls_settings_changed();
  16796. }
  16797. #endif
  16798. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16799. std::size_t size) {
  16800. if (ctx_ && ca_cert && size > 0) {
  16801. // Every PEM loaded, for redirect transfer
  16802. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  16803. ca_cert_pem_ += '\n';
  16804. }
  16805. ca_cert_pem_.append(ca_cert, size);
  16806. tls::load_ca_pem(ctx_, ca_cert, size);
  16807. }
  16808. custom_ca_loaded_ = true;
  16809. tls_settings_changed();
  16810. }
  16811. inline bool SSLClient::load_certs() {
  16812. auto ret = true;
  16813. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16814. // one client is shared across concurrent requests here.
  16815. std::call_once(initialize_cert_, [&]() {
  16816. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16817. ret = detail::load_client_ca_config(ctx_, ca_cert_file_path_,
  16818. ca_cert_dir_path_, custom_ca_loaded_,
  16819. system_ca_mode_, last_backend_error_);
  16820. });
  16821. return ret;
  16822. }
  16823. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16824. // Load CA certificates if server verification is enabled
  16825. if (server_certificate_verification_) {
  16826. if (!load_certs()) {
  16827. error = Error::SSLLoadingCerts;
  16828. return false;
  16829. }
  16830. }
  16831. detail::ClientTlsSessionOptions options;
  16832. options.server_hostname_verification = server_hostname_verification_;
  16833. options.session_verifier = session_verifier_;
  16834. options.interrupted = stop_interrupt();
  16835. options.ctx_mutex = &ctx_mutex_;
  16836. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16837. // Skip Schannel when a custom CA cert is specified, as the Windows
  16838. // certificate store would not know about user-provided CA certificates.
  16839. // Also skip when system CA trust is explicitly disabled.
  16840. options.windows_cert_verification =
  16841. enable_windows_cert_verification_ &&
  16842. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16843. ca_cert_dir_path_.empty() && !custom_ca_loaded_;
  16844. // Only a verifier set through set_server_certificate_verifier() is seen
  16845. // here, not one installed with tls::set_verify_callback() directly.
  16846. options.server_certificate_verifier_set =
  16847. static_cast<bool>(server_certificate_verifier_);
  16848. #endif
  16849. tls::session_t session = nullptr;
  16850. // Use scope_exit to ensure session is freed on error paths
  16851. bool success = false;
  16852. auto session_guard = detail::scope_exit([&] {
  16853. if (!success) { tls::free_session(session); }
  16854. });
  16855. detail::ClientTlsSessionError tls_error;
  16856. if (!detail::setup_client_tls_session(
  16857. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16858. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16859. options)) {
  16860. error = tls_error.error;
  16861. last_ssl_error_ = tls_error.ssl_error;
  16862. last_backend_error_ = tls_error.backend_error;
  16863. return false;
  16864. }
  16865. success = true;
  16866. socket.ssl = session;
  16867. return true;
  16868. }
  16869. inline void Client::set_digest_auth(const std::string &username,
  16870. const std::string &password) {
  16871. cli_->set_digest_auth(username, password);
  16872. }
  16873. inline void Client::set_proxy_digest_auth(const std::string &username,
  16874. const std::string &password) {
  16875. cli_->set_proxy_digest_auth(username, password);
  16876. }
  16877. inline void Client::enable_server_certificate_verification(bool enabled) {
  16878. cli_->enable_server_certificate_verification(enabled);
  16879. }
  16880. inline void Client::enable_server_hostname_verification(bool enabled) {
  16881. cli_->enable_server_hostname_verification(enabled);
  16882. }
  16883. inline void Client::enable_system_ca(bool enabled) {
  16884. cli_->enable_system_ca(enabled);
  16885. }
  16886. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16887. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16888. if (is_ssl_) {
  16889. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16890. enabled);
  16891. }
  16892. }
  16893. #endif
  16894. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16895. const std::string &ca_cert_dir_path) {
  16896. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16897. }
  16898. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16899. if (is_ssl_) {
  16900. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16901. } else if (ca_cert_store) {
  16902. tls::free_ca_store(ca_cert_store);
  16903. }
  16904. }
  16905. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16906. if (is_ssl_) {
  16907. // Use the PEM-based path so the CA data is retained for redirect transfer
  16908. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16909. }
  16910. }
  16911. inline void
  16912. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16913. if (is_ssl_) {
  16914. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16915. std::move(verifier));
  16916. }
  16917. }
  16918. inline void Client::set_session_verifier(
  16919. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16920. if (is_ssl_) {
  16921. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16922. }
  16923. }
  16924. inline tls::ctx_t Client::tls_context() const {
  16925. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16926. return nullptr;
  16927. }
  16928. #endif // CPPHTTPLIB_SSL_ENABLED
  16929. /*
  16930. * Group 7: TLS abstraction layer - Common API
  16931. */
  16932. #ifdef CPPHTTPLIB_SSL_ENABLED
  16933. namespace tls {
  16934. // Helper for PeerCert construction
  16935. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16936. return PeerCert(get_peer_cert(session));
  16937. }
  16938. namespace impl {
  16939. // set_verify_callback() can replace a callback while handshakes on other
  16940. // threads run it, so they share it, and take their reference under this lock.
  16941. inline std::mutex &verify_callback_mutex() {
  16942. static std::mutex mutex;
  16943. return mutex;
  16944. }
  16945. // The TLS libraries are C, so an exception from a verify callback must not
  16946. // unwind through them. It rejects the certificate instead.
  16947. inline bool run_verify_callback(const VerifyCallback &callback,
  16948. const VerifyContext &ctx) {
  16949. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  16950. return callback(ctx);
  16951. #else
  16952. try {
  16953. return callback(ctx);
  16954. } catch (...) { return false; }
  16955. #endif
  16956. }
  16957. // Check if a string is an IPv4 address
  16958. inline bool is_ipv4_address(const std::string &str) {
  16959. int dots = 0;
  16960. for (char c : str) {
  16961. if (c == '.') {
  16962. dots++;
  16963. } else if (!detail::is_ascii_digit(c)) {
  16964. return false;
  16965. }
  16966. }
  16967. return dots == 3;
  16968. }
  16969. // Parse IPv4 address string to bytes
  16970. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16971. const char *p = str.c_str();
  16972. for (int i = 0; i < 4; i++) {
  16973. if (i > 0) {
  16974. if (*p != '.') { return false; }
  16975. p++;
  16976. }
  16977. int val = 0;
  16978. int digits = 0;
  16979. while (detail::is_ascii_digit(*p)) {
  16980. val = val * 10 + (*p - '0');
  16981. if (val > 255) { return false; }
  16982. p++;
  16983. digits++;
  16984. }
  16985. if (digits == 0) { return false; }
  16986. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16987. if (digits > 1 && *(p - digits) == '0') { return false; }
  16988. out[i] = static_cast<unsigned char>(val);
  16989. }
  16990. return *p == '\0';
  16991. }
  16992. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16993. // `out` must have room for at least 16 bytes. Returns the address length
  16994. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16995. // literal. Used to match a host against iPAddress SANs the same way the
  16996. // OpenSSL backend does via X509_check_ip.
  16997. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16998. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16999. struct in6_addr addr6 = {};
  17000. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  17001. memcpy(out, &addr6, 16);
  17002. return 16;
  17003. }
  17004. return 0;
  17005. }
  17006. #ifdef _WIN32
  17007. // Enumerate Windows system certificates and call callback with DER data
  17008. template <typename Callback>
  17009. inline bool enumerate_windows_system_certs(Callback cb) {
  17010. bool loaded = false;
  17011. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17012. for (auto store_name : store_names) {
  17013. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  17014. if (hStore) {
  17015. PCCERT_CONTEXT pContext = nullptr;
  17016. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17017. nullptr) {
  17018. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  17019. loaded = true;
  17020. }
  17021. }
  17022. CertCloseStore(hStore, 0);
  17023. }
  17024. }
  17025. return loaded;
  17026. }
  17027. #endif
  17028. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17029. // The trust a certificate's Trust Settings give it for SSL server
  17030. // verification (SecTrustSettings.h). An empty array trusts it as a root.
  17031. // Otherwise the first usage-constraints dictionary that applies decides: one
  17032. // naming a policy other than SSL, a host name or an application does not
  17033. // apply, and a result left out means TrustRoot. Keychain Access writes "Never
  17034. // Trust" as kSecTrustSettingsResultDeny.
  17035. inline SecTrustSettingsResult
  17036. macos_ssl_trust_settings_result(CFArrayRef trust_settings) {
  17037. auto count = CFArrayGetCount(trust_settings);
  17038. if (count == 0) { return kSecTrustSettingsResultTrustRoot; }
  17039. for (CFIndex i = 0; i < count; i++) {
  17040. auto value = CFArrayGetValueAtIndex(trust_settings, i);
  17041. if (!value || CFGetTypeID(value) != CFDictionaryGetTypeID()) { continue; }
  17042. auto constraint = static_cast<CFDictionaryRef>(value);
  17043. auto policy_value =
  17044. CFDictionaryGetValue(constraint, kSecTrustSettingsPolicy);
  17045. if (policy_value) {
  17046. auto policy = static_cast<SecPolicyRef>(const_cast<void *>(policy_value));
  17047. auto is_ssl = false;
  17048. if (auto properties = SecPolicyCopyProperties(policy)) {
  17049. auto oid = CFDictionaryGetValue(properties, kSecPolicyOid);
  17050. is_ssl = oid && CFEqual(oid, kSecPolicyAppleSSL);
  17051. CFRelease(properties);
  17052. }
  17053. if (!is_ssl) { continue; }
  17054. }
  17055. if (CFDictionaryContainsKey(constraint, kSecTrustSettingsPolicyString) ||
  17056. CFDictionaryContainsKey(constraint, kSecTrustSettingsApplication)) {
  17057. continue;
  17058. }
  17059. auto result = kSecTrustSettingsResultTrustRoot;
  17060. auto number = static_cast<CFNumberRef>(
  17061. CFDictionaryGetValue(constraint, kSecTrustSettingsResult));
  17062. if (number) {
  17063. SInt32 number_value = 0;
  17064. if (!CFNumberGetValue(number, kCFNumberSInt32Type, &number_value)) {
  17065. continue;
  17066. }
  17067. result = static_cast<SecTrustSettingsResult>(number_value);
  17068. }
  17069. if (result == kSecTrustSettingsResultTrustRoot ||
  17070. result == kSecTrustSettingsResultTrustAsRoot ||
  17071. result == kSecTrustSettingsResultDeny) {
  17072. return result;
  17073. }
  17074. }
  17075. return kSecTrustSettingsResultUnspecified;
  17076. }
  17077. // Enumerate the macOS Keychain certificates trusted for SSL and call callback
  17078. // with DER data. A certificate with Trust Settings is not trusted just by
  17079. // having them: the settings say whether it is, and a per-user setting
  17080. // overrides the admin domain's, which overrides the system domain's (whose
  17081. // roots are all trusted). So a system root the user set to "Never Trust" is
  17082. // left out, as is one trusted only for S/MIME or code signing.
  17083. template <typename Callback>
  17084. inline bool enumerate_macos_keychain_certs(Callback cb) {
  17085. const SecTrustSettingsDomain domains[] = {
  17086. kSecTrustSettingsDomainUser,
  17087. kSecTrustSettingsDomainAdmin,
  17088. kSecTrustSettingsDomainSystem,
  17089. };
  17090. std::set<std::string> decided;
  17091. std::vector<std::string> trusted;
  17092. for (auto domain : domains) {
  17093. CFArrayRef certs = nullptr;
  17094. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  17095. if (status != errSecSuccess || !certs) {
  17096. if (certs) CFRelease(certs);
  17097. continue;
  17098. }
  17099. CFIndex count = CFArrayGetCount(certs);
  17100. for (CFIndex i = 0; i < count; i++) {
  17101. SecCertificateRef cert =
  17102. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  17103. CFDataRef data = SecCertificateCopyData(cert);
  17104. if (!data) { continue; }
  17105. std::string der(reinterpret_cast<const char *>(CFDataGetBytePtr(data)),
  17106. static_cast<size_t>(CFDataGetLength(data)));
  17107. CFRelease(data);
  17108. // Decided by a domain that overrides this one
  17109. if (decided.find(der) != decided.end()) { continue; }
  17110. auto result = kSecTrustSettingsResultTrustRoot;
  17111. if (domain != kSecTrustSettingsDomainSystem) {
  17112. result = kSecTrustSettingsResultUnspecified;
  17113. CFArrayRef trust_settings = nullptr;
  17114. if (SecTrustSettingsCopyTrustSettings(cert, domain, &trust_settings) ==
  17115. errSecSuccess &&
  17116. trust_settings) {
  17117. result = macos_ssl_trust_settings_result(trust_settings);
  17118. }
  17119. if (trust_settings) CFRelease(trust_settings);
  17120. }
  17121. // Neither trusted nor distrusted here; a domain below may decide
  17122. if (result == kSecTrustSettingsResultUnspecified) { continue; }
  17123. decided.insert(der);
  17124. if (result == kSecTrustSettingsResultTrustRoot ||
  17125. result == kSecTrustSettingsResultTrustAsRoot) {
  17126. trusted.push_back(std::move(der));
  17127. }
  17128. }
  17129. CFRelease(certs);
  17130. }
  17131. bool loaded = false;
  17132. for (const auto &der : trusted) {
  17133. if (cb(reinterpret_cast<const unsigned char *>(der.data()), der.size())) {
  17134. loaded = true;
  17135. }
  17136. }
  17137. return loaded;
  17138. }
  17139. #endif
  17140. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  17141. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  17142. // Common CA certificate file paths on Linux/Unix
  17143. inline const char **system_ca_paths() {
  17144. static const char *paths[] = {
  17145. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  17146. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  17147. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  17148. "/etc/pki/tls/cacert.pem", // OpenELEC
  17149. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  17150. nullptr};
  17151. return paths;
  17152. }
  17153. // Common CA certificate directory paths on Linux/Unix
  17154. inline const char **system_ca_dirs() {
  17155. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  17156. "/etc/pki/tls/certs", // RHEL/CentOS
  17157. "/usr/share/ca-certificates", // Other
  17158. nullptr};
  17159. return dirs;
  17160. }
  17161. #endif
  17162. } // namespace impl
  17163. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  17164. const char *ca_dir) {
  17165. if (!ctx) { return false; }
  17166. bool success = true;
  17167. if (ca_file && *ca_file) {
  17168. if (!load_ca_file(ctx, ca_file)) { success = false; }
  17169. }
  17170. if (ca_dir && *ca_dir) {
  17171. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  17172. }
  17173. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17174. // Set CA list for client certificate request (CertificateRequest message)
  17175. if (ca_file && *ca_file) {
  17176. auto list = SSL_load_client_CA_file(ca_file);
  17177. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  17178. }
  17179. #endif
  17180. return success;
  17181. }
  17182. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17183. const char *password) {
  17184. return set_client_cert_pem(ctx, cert, key, password);
  17185. }
  17186. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  17187. const char *key_path, const char *password) {
  17188. return set_client_cert_file(ctx, cert_path, key_path, password);
  17189. }
  17190. // PeerCert implementation
  17191. inline PeerCert::PeerCert() = default;
  17192. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  17193. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  17194. other.cert_ = nullptr;
  17195. }
  17196. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  17197. if (this != &other) {
  17198. if (cert_) { free_cert(cert_); }
  17199. cert_ = other.cert_;
  17200. other.cert_ = nullptr;
  17201. }
  17202. return *this;
  17203. }
  17204. inline PeerCert::~PeerCert() {
  17205. if (cert_) { free_cert(cert_); }
  17206. }
  17207. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  17208. inline std::string PeerCert::subject_cn() const {
  17209. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  17210. }
  17211. inline std::string PeerCert::issuer_name() const {
  17212. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  17213. }
  17214. inline bool PeerCert::check_hostname(const char *hostname) const {
  17215. return cert_ ? verify_hostname(cert_, hostname) : false;
  17216. }
  17217. inline std::vector<SanEntry> PeerCert::sans() const {
  17218. std::vector<SanEntry> result;
  17219. if (cert_) { get_cert_sans(cert_, result); }
  17220. return result;
  17221. }
  17222. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  17223. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  17224. }
  17225. inline std::string PeerCert::serial() const {
  17226. return cert_ ? get_cert_serial(cert_) : std::string();
  17227. }
  17228. // VerifyContext method implementations
  17229. inline std::string VerifyContext::subject_cn() const {
  17230. return cert ? get_cert_subject_cn(cert) : std::string();
  17231. }
  17232. inline std::string VerifyContext::issuer_name() const {
  17233. return cert ? get_cert_issuer_name(cert) : std::string();
  17234. }
  17235. inline bool VerifyContext::check_hostname(const char *hostname) const {
  17236. return cert ? verify_hostname(cert, hostname) : false;
  17237. }
  17238. inline std::vector<SanEntry> VerifyContext::sans() const {
  17239. std::vector<SanEntry> result;
  17240. if (cert) { get_cert_sans(cert, result); }
  17241. return result;
  17242. }
  17243. inline bool VerifyContext::validity(time_t &not_before,
  17244. time_t &not_after) const {
  17245. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  17246. }
  17247. inline std::string VerifyContext::serial() const {
  17248. return cert ? get_cert_serial(cert) : std::string();
  17249. }
  17250. // TlsError static method implementation
  17251. inline std::string TlsError::verify_error_to_string(long error_code) {
  17252. return verify_error_string(error_code);
  17253. }
  17254. } // namespace tls
  17255. // Request::peer_cert() implementation
  17256. inline tls::PeerCert Request::peer_cert() const {
  17257. return tls::get_peer_cert_from_session(ssl);
  17258. }
  17259. // Request::sni() implementation
  17260. inline std::string Request::sni() const {
  17261. if (!ssl) { return std::string(); }
  17262. const char *s = tls::get_sni(ssl);
  17263. return s ? std::string(s) : std::string();
  17264. }
  17265. #endif // CPPHTTPLIB_SSL_ENABLED
  17266. /*
  17267. * Group 8: TLS abstraction layer - OpenSSL backend
  17268. */
  17269. /*
  17270. * OpenSSL Backend Implementation
  17271. */
  17272. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17273. namespace tls {
  17274. namespace impl {
  17275. // Helper to map OpenSSL SSL_get_error to ErrorCode
  17276. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  17277. switch (ssl_error) {
  17278. case SSL_ERROR_NONE: return ErrorCode::Success;
  17279. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  17280. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  17281. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  17282. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  17283. case SSL_ERROR_SSL:
  17284. default: return ErrorCode::Fatal;
  17285. }
  17286. }
  17287. // Fills in a failed SSL_connect(). One that the server certificate's
  17288. // verification stopped reports the verify result, as the other backends and
  17289. // a check after the handshake do.
  17290. inline void fill_connect_error(SSL *ssl, int ret, TlsError &err) {
  17291. auto ssl_err = SSL_get_error(ssl, ret);
  17292. auto error = ERR_get_error();
  17293. err.code = map_ssl_error(ssl_err, err.sys_errno);
  17294. err.backend_code = error;
  17295. if (ssl_err != SSL_ERROR_SSL || ERR_GET_LIB(error) != ERR_LIB_SSL ||
  17296. ERR_GET_REASON(error) != SSL_R_CERTIFICATE_VERIFY_FAILED) {
  17297. return;
  17298. }
  17299. // A certificate only a verify callback turned down carries no verdict of
  17300. // its own, and fails as any other handshake does
  17301. auto verify_result = SSL_get_verify_result(ssl);
  17302. if (verify_result == X509_V_OK || verify_result == X509_V_ERR_UNSPECIFIED) {
  17303. return;
  17304. }
  17305. err.code = verify_result == X509_V_ERR_HOSTNAME_MISMATCH
  17306. ? ErrorCode::HostnameMismatch
  17307. : ErrorCode::CertVerifyFailed;
  17308. err.backend_code = static_cast<uint64_t>(verify_result);
  17309. }
  17310. // Helper: Create client CA list from PEM string
  17311. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  17312. // Caller takes ownership of returned list
  17313. inline STACK_OF(X509_NAME) *
  17314. create_client_ca_list_from_pem(const char *ca_pem) {
  17315. if (!ca_pem) { return nullptr; }
  17316. auto ca_list = sk_X509_NAME_new_null();
  17317. if (!ca_list) { return nullptr; }
  17318. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  17319. if (!bio) {
  17320. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  17321. return nullptr;
  17322. }
  17323. X509 *cert = nullptr;
  17324. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17325. nullptr) {
  17326. const X509_NAME *name = X509_get_subject_name(cert);
  17327. if (name) {
  17328. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  17329. }
  17330. X509_free(cert);
  17331. }
  17332. BIO_free(bio);
  17333. return ca_list;
  17334. }
  17335. inline void free_verify_callback(void * /*parent*/, void *ptr,
  17336. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  17337. long /*argl*/, void * /*argp*/) {
  17338. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  17339. }
  17340. // The SSL_CTX owns its verify callback, so each client or server sees only
  17341. // its own, on whichever thread runs the handshake.
  17342. inline int verify_callback_index() {
  17343. static const auto index = SSL_CTX_get_ex_new_index(
  17344. 0, nullptr, nullptr, nullptr, free_verify_callback);
  17345. return index;
  17346. }
  17347. // OpenSSL verify callback wrapper
  17348. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  17349. // Get SSL object from X509_STORE_CTX
  17350. auto ssl = static_cast<SSL *>(
  17351. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  17352. if (!ssl) { return preverify_ok; }
  17353. std::shared_ptr<VerifyCallback> callback;
  17354. {
  17355. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  17356. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  17357. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  17358. if (stored) { callback = *stored; }
  17359. }
  17360. if (!callback) { return preverify_ok; }
  17361. // Get current certificate and depth
  17362. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  17363. int depth = X509_STORE_CTX_get_error_depth(ctx);
  17364. int error = X509_STORE_CTX_get_error(ctx);
  17365. // Build context
  17366. VerifyContext verify_ctx;
  17367. verify_ctx.session = static_cast<session_t>(ssl);
  17368. verify_ctx.cert = static_cast<cert_t>(cert);
  17369. verify_ctx.depth = depth;
  17370. verify_ctx.preverify_ok = (preverify_ok != 0);
  17371. verify_ctx.error_code = error;
  17372. verify_ctx.error_string =
  17373. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  17374. auto accepted = run_verify_callback(*callback, verify_ctx);
  17375. // A client verifying the server during the handshake, which is what
  17376. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  17377. if (!SSL_is_server(ssl) &&
  17378. (SSL_get_verify_mode(ssl) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  17379. accepted = accepted && preverify_ok;
  17380. }
  17381. return accepted ? 1 : 0;
  17382. }
  17383. // Sets the verify mode from whether the peer's certificate is required and
  17384. // whether a verify callback is set.
  17385. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  17386. auto has_callback =
  17387. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  17388. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  17389. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  17390. SSL_CTX_set_verify(ssl_ctx, mode,
  17391. has_callback ? openssl_verify_callback : nullptr);
  17392. }
  17393. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  17394. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  17395. // that must be released with release_store_objects
  17396. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  17397. OPENSSL_VERSION_NUMBER >= 0x30300000L
  17398. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17399. #endif
  17400. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  17401. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17402. return X509_STORE_get1_objects(store);
  17403. #else
  17404. return X509_STORE_get0_objects(store);
  17405. #endif
  17406. }
  17407. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  17408. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17409. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  17410. #else
  17411. (void)objs; // get0 variant returns an internal pointer; nothing to free
  17412. #endif
  17413. }
  17414. } // namespace impl
  17415. inline ctx_t create_client_context() {
  17416. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  17417. if (ctx) {
  17418. // Disable auto-retry to properly handle non-blocking I/O
  17419. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  17420. // Set minimum TLS version
  17421. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17422. }
  17423. return static_cast<ctx_t>(ctx);
  17424. }
  17425. inline void free_context(ctx_t ctx) {
  17426. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  17427. }
  17428. inline bool set_min_version(ctx_t ctx, Version version) {
  17429. if (!ctx) return false;
  17430. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  17431. static_cast<uint16_t>(version)) == 1;
  17432. }
  17433. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17434. if (!ctx || !pem || len == 0) return false;
  17435. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17436. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17437. if (!store) return false;
  17438. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  17439. if (!bio) return false;
  17440. bool ok = true;
  17441. X509 *cert = nullptr;
  17442. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17443. nullptr) {
  17444. if (X509_STORE_add_cert(store, cert) != 1) {
  17445. // Ignore duplicate errors
  17446. auto err = ERR_peek_last_error();
  17447. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  17448. ok = false;
  17449. }
  17450. }
  17451. X509_free(cert);
  17452. if (!ok) break;
  17453. }
  17454. BIO_free(bio);
  17455. // Clear any "no more certificates" errors
  17456. ERR_clear_error();
  17457. return ok;
  17458. }
  17459. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17460. if (!ctx || !file_path) return false;
  17461. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  17462. nullptr) == 1;
  17463. }
  17464. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17465. if (!ctx || !dir_path) return false;
  17466. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  17467. dir_path) == 1;
  17468. }
  17469. inline bool load_system_certs(ctx_t ctx) {
  17470. if (!ctx) return false;
  17471. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17472. #ifdef _WIN32
  17473. // Windows: Load from system certificate store (ROOT and CA)
  17474. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17475. if (!store) return false;
  17476. bool loaded_any = false;
  17477. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17478. for (auto store_name : store_names) {
  17479. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  17480. if (!hStore) continue;
  17481. PCCERT_CONTEXT pContext = nullptr;
  17482. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17483. nullptr) {
  17484. const unsigned char *data = pContext->pbCertEncoded;
  17485. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  17486. if (x509) {
  17487. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17488. X509_free(x509);
  17489. }
  17490. }
  17491. CertCloseStore(hStore, 0);
  17492. }
  17493. return loaded_any;
  17494. #elif defined(__APPLE__)
  17495. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17496. // macOS: Load from Keychain
  17497. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17498. if (!store) return false;
  17499. auto loaded_any = impl::enumerate_macos_keychain_certs(
  17500. [&](const unsigned char *data, size_t len) {
  17501. auto x509 = d2i_X509(nullptr, &data, static_cast<long>(len));
  17502. if (!x509) { return false; }
  17503. auto added = X509_STORE_add_cert(store, x509) == 1;
  17504. X509_free(x509);
  17505. return added;
  17506. });
  17507. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17508. #else
  17509. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17510. #endif
  17511. #else
  17512. // Other Unix: use default verify paths
  17513. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17514. #endif
  17515. }
  17516. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17517. const char *password) {
  17518. if (!ctx || !cert || !key) return false;
  17519. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17520. // Load certificate
  17521. auto cert_bio = BIO_new_mem_buf(cert, -1);
  17522. if (!cert_bio) return false;
  17523. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17524. BIO_free(cert_bio);
  17525. if (!x509) return false;
  17526. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  17527. X509_free(x509);
  17528. if (!cert_ok) return false;
  17529. // Load private key
  17530. auto key_bio = BIO_new_mem_buf(key, -1);
  17531. if (!key_bio) return false;
  17532. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17533. password ? const_cast<char *>(password)
  17534. : nullptr);
  17535. BIO_free(key_bio);
  17536. if (!pkey) return false;
  17537. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  17538. EVP_PKEY_free(pkey);
  17539. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  17540. }
  17541. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17542. const char *key_path, const char *password) {
  17543. if (!ctx || !cert_path || !key_path) return false;
  17544. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17545. if (password && password[0] != '\0') {
  17546. SSL_CTX_set_default_passwd_cb_userdata(
  17547. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  17548. }
  17549. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  17550. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  17551. }
  17552. inline ctx_t create_server_context() {
  17553. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17554. if (ctx) {
  17555. // No renegotiation, as on the other backends: it would run a handshake
  17556. // that SSLServer::update_certs_pem() does not wait for
  17557. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  17558. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  17559. SSL_OP_NO_RENEGOTIATION);
  17560. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17561. // Without one, a client resuming its session is sent a fatal alert once
  17562. // client certificates are verified.
  17563. static const unsigned char sid_ctx[] = "cpp-httplib";
  17564. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  17565. }
  17566. return static_cast<ctx_t>(ctx);
  17567. }
  17568. inline void set_verify_client(ctx_t ctx, bool require) {
  17569. if (!ctx) return;
  17570. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  17571. }
  17572. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17573. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  17574. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17575. SSL *ssl = SSL_new(ssl_ctx);
  17576. if (!ssl) return nullptr;
  17577. // Disable auto-retry for proper non-blocking I/O handling
  17578. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  17579. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  17580. if (!bio) {
  17581. SSL_free(ssl);
  17582. return nullptr;
  17583. }
  17584. SSL_set_bio(ssl, bio, bio);
  17585. return static_cast<session_t>(ssl);
  17586. }
  17587. inline void free_session(session_t session) {
  17588. if (session) { SSL_free(static_cast<SSL *>(session)); }
  17589. }
  17590. inline bool set_sni(session_t session, const char *hostname,
  17591. bool verify_hostname) {
  17592. if (!session || !hostname) return false;
  17593. auto ssl = static_cast<SSL *>(session);
  17594. // The handshake's chain verification then checks the name as well
  17595. if (verify_hostname) {
  17596. auto param = SSL_get0_param(ssl);
  17597. X509_VERIFY_PARAM_set_hostflags(param, X509_CHECK_FLAG_NEVER_CHECK_SUBJECT);
  17598. if (X509_VERIFY_PARAM_set1_host(param, hostname, strlen(hostname)) != 1) {
  17599. return false;
  17600. }
  17601. }
  17602. #if defined(OPENSSL_IS_BORINGSSL)
  17603. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  17604. #else
  17605. // Direct call instead of macro to suppress -Wold-style-cast warning
  17606. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  17607. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  17608. #endif
  17609. }
  17610. inline TlsError connect(session_t session) {
  17611. if (!session) { return TlsError(); }
  17612. auto ssl = static_cast<SSL *>(session);
  17613. auto ret = SSL_connect(ssl);
  17614. TlsError err;
  17615. if (ret == 1) {
  17616. err.code = ErrorCode::Success;
  17617. } else {
  17618. impl::fill_connect_error(ssl, ret, err);
  17619. }
  17620. return err;
  17621. }
  17622. inline TlsError accept(session_t session) {
  17623. if (!session) { return TlsError(); }
  17624. auto ssl = static_cast<SSL *>(session);
  17625. auto ret = SSL_accept(ssl);
  17626. TlsError err;
  17627. if (ret == 1) {
  17628. err.code = ErrorCode::Success;
  17629. } else {
  17630. auto ssl_err = SSL_get_error(ssl, ret);
  17631. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17632. err.backend_code = ERR_get_error();
  17633. }
  17634. return err;
  17635. }
  17636. inline bool connect_nonblocking(session_t session, socket_t sock,
  17637. time_t timeout_sec, time_t timeout_usec,
  17638. TlsError *err,
  17639. const std::function<bool()> &interrupted) {
  17640. if (!session) {
  17641. if (err) { err->code = ErrorCode::Fatal; }
  17642. return false;
  17643. }
  17644. auto ssl = static_cast<SSL *>(session);
  17645. auto bio = SSL_get_rbio(ssl);
  17646. // Set non-blocking mode for handshake
  17647. detail::set_nonblocking(sock, true);
  17648. if (bio) { BIO_set_nbio(bio, 1); }
  17649. auto cleanup = detail::scope_exit([&]() {
  17650. // Restore blocking mode after handshake
  17651. if (bio) { BIO_set_nbio(bio, 0); }
  17652. detail::set_nonblocking(sock, false);
  17653. });
  17654. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17655. auto res = 0;
  17656. while ((res = SSL_connect(ssl)) != 1) {
  17657. auto ssl_err = SSL_get_error(ssl, res);
  17658. switch (ssl_err) {
  17659. case SSL_ERROR_WANT_READ:
  17660. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  17661. continue;
  17662. }
  17663. break;
  17664. case SSL_ERROR_WANT_WRITE:
  17665. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  17666. continue;
  17667. }
  17668. break;
  17669. default: break;
  17670. }
  17671. if (err) { impl::fill_connect_error(ssl, res, *err); }
  17672. return false;
  17673. }
  17674. if (err) { err->code = ErrorCode::Success; }
  17675. return true;
  17676. }
  17677. inline bool accept_nonblocking(session_t session, socket_t sock,
  17678. time_t timeout_sec, time_t timeout_usec,
  17679. TlsError *err) {
  17680. if (!session) {
  17681. if (err) { err->code = ErrorCode::Fatal; }
  17682. return false;
  17683. }
  17684. auto ssl = static_cast<SSL *>(session);
  17685. auto bio = SSL_get_rbio(ssl);
  17686. // Set non-blocking mode for handshake
  17687. detail::set_nonblocking(sock, true);
  17688. if (bio) { BIO_set_nbio(bio, 1); }
  17689. auto cleanup = detail::scope_exit([&]() {
  17690. // Restore blocking mode after handshake
  17691. if (bio) { BIO_set_nbio(bio, 0); }
  17692. detail::set_nonblocking(sock, false);
  17693. });
  17694. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17695. auto res = 0;
  17696. while ((res = SSL_accept(ssl)) != 1) {
  17697. auto ssl_err = SSL_get_error(ssl, res);
  17698. switch (ssl_err) {
  17699. case SSL_ERROR_WANT_READ:
  17700. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17701. break;
  17702. case SSL_ERROR_WANT_WRITE:
  17703. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17704. break;
  17705. default: break;
  17706. }
  17707. if (err) {
  17708. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17709. err->backend_code = ERR_get_error();
  17710. }
  17711. return false;
  17712. }
  17713. if (err) { err->code = ErrorCode::Success; }
  17714. return true;
  17715. }
  17716. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17717. if (!session || !buf) {
  17718. err.code = ErrorCode::Fatal;
  17719. return -1;
  17720. }
  17721. auto ssl = static_cast<SSL *>(session);
  17722. constexpr auto max_len =
  17723. static_cast<size_t>((std::numeric_limits<int>::max)());
  17724. if (len > max_len) { len = max_len; }
  17725. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17726. if (ret > 0) {
  17727. err.code = ErrorCode::Success;
  17728. return ret;
  17729. }
  17730. auto ssl_err = SSL_get_error(ssl, ret);
  17731. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17732. if (err.code == ErrorCode::PeerClosed) {
  17733. return 0;
  17734. } // Gracefully handle the peer closed state.
  17735. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17736. return -1;
  17737. }
  17738. inline ssize_t write(session_t session, const void *buf, size_t len,
  17739. TlsError &err) {
  17740. if (!session || !buf) {
  17741. err.code = ErrorCode::Fatal;
  17742. return -1;
  17743. }
  17744. auto ssl = static_cast<SSL *>(session);
  17745. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17746. if (ret > 0) {
  17747. err.code = ErrorCode::Success;
  17748. return ret;
  17749. }
  17750. auto ssl_err = SSL_get_error(ssl, ret);
  17751. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17752. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17753. return -1;
  17754. }
  17755. inline int pending(const_session_t session) {
  17756. if (!session) return 0;
  17757. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17758. }
  17759. inline void shutdown(session_t session, bool graceful) {
  17760. if (!session) return;
  17761. auto ssl = static_cast<SSL *>(session);
  17762. if (graceful) {
  17763. // Send close_notify without waiting for the peer's. The connection is
  17764. // closed right after this, so a unidirectional shutdown is enough, and an
  17765. // idle peer that never answers would otherwise hold this thread until the
  17766. // read timeout. The other backends do not wait either.
  17767. SSL_shutdown(ssl);
  17768. }
  17769. }
  17770. inline bool is_peer_closed(session_t session, socket_t sock) {
  17771. if (!session) return true;
  17772. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17773. detail::set_nonblocking(sock, true);
  17774. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17775. auto ssl = static_cast<SSL *>(session);
  17776. char buf;
  17777. auto ret = SSL_peek(ssl, &buf, 1);
  17778. if (ret > 0) return false;
  17779. auto err = SSL_get_error(ssl, ret);
  17780. return err == SSL_ERROR_ZERO_RETURN;
  17781. }
  17782. inline cert_t get_peer_cert(const_session_t session) {
  17783. if (!session) return nullptr;
  17784. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17785. static_cast<SSL *>(const_cast<void *>(session))));
  17786. }
  17787. inline size_t get_peer_certs(const_session_t session,
  17788. std::vector<cert_t> &certs) {
  17789. certs.clear();
  17790. if (!session) { return 0; }
  17791. auto ssl = static_cast<const SSL *>(session);
  17792. // On the server side, the chain leaves out the peer's own certificate
  17793. if (SSL_is_server(ssl)) {
  17794. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17795. }
  17796. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  17797. auto count = sk_X509_num(sk);
  17798. for (decltype(count) i = 0; i < count; i++) {
  17799. auto x509 = sk_X509_value(sk, i);
  17800. X509_up_ref(x509);
  17801. certs.push_back(static_cast<cert_t>(x509));
  17802. }
  17803. }
  17804. return certs.size();
  17805. }
  17806. inline void free_cert(cert_t cert) {
  17807. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17808. }
  17809. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17810. if (!cert || !hostname) return false;
  17811. auto x509 = static_cast<X509 *>(cert);
  17812. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17813. if (detail::is_ip_address(hostname)) {
  17814. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17815. }
  17816. return X509_check_host(x509, hostname, strlen(hostname),
  17817. X509_CHECK_FLAG_NEVER_CHECK_SUBJECT, nullptr) == 1;
  17818. }
  17819. inline uint64_t hostname_mismatch_code() {
  17820. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17821. }
  17822. inline long get_verify_result(const_session_t session) {
  17823. if (!session) return X509_V_ERR_UNSPECIFIED;
  17824. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17825. }
  17826. inline std::string get_cert_subject_cn(cert_t cert) {
  17827. if (!cert) return "";
  17828. auto x509 = static_cast<X509 *>(cert);
  17829. auto subject_name = X509_get_subject_name(x509);
  17830. if (!subject_name) return "";
  17831. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17832. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17833. if (idx < 0) return "";
  17834. auto entry = X509_NAME_get_entry(subject_name, idx);
  17835. if (!entry) return "";
  17836. auto data = X509_NAME_ENTRY_get_data(entry);
  17837. if (!data) return "";
  17838. return std::string(
  17839. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17840. static_cast<size_t>(ASN1_STRING_length(data)));
  17841. }
  17842. inline std::string get_cert_issuer_name(cert_t cert) {
  17843. if (!cert) return "";
  17844. auto x509 = static_cast<X509 *>(cert);
  17845. auto issuer_name = X509_get_issuer_name(x509);
  17846. if (!issuer_name) return "";
  17847. char buf[256];
  17848. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17849. return std::string(buf);
  17850. }
  17851. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17852. sans.clear();
  17853. if (!cert) return false;
  17854. auto x509 = static_cast<X509 *>(cert);
  17855. auto names = static_cast<GENERAL_NAMES *>(
  17856. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17857. if (!names) return true; // No SANs is valid
  17858. auto count = sk_GENERAL_NAME_num(names);
  17859. for (decltype(count) i = 0; i < count; i++) {
  17860. auto gen = sk_GENERAL_NAME_value(names, i);
  17861. if (!gen) continue;
  17862. SanEntry entry;
  17863. switch (gen->type) {
  17864. case GEN_DNS:
  17865. entry.type = SanType::DNS;
  17866. if (gen->d.dNSName) {
  17867. entry.value = std::string(
  17868. reinterpret_cast<const char *>(
  17869. ASN1_STRING_get0_data(gen->d.dNSName)),
  17870. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17871. }
  17872. break;
  17873. case GEN_IPADD:
  17874. entry.type = SanType::IP;
  17875. if (gen->d.iPAddress) {
  17876. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17877. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17878. if (len == 4) {
  17879. // IPv4
  17880. char buf[INET_ADDRSTRLEN];
  17881. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17882. entry.value = buf;
  17883. } else if (len == 16) {
  17884. // IPv6
  17885. char buf[INET6_ADDRSTRLEN];
  17886. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17887. entry.value = buf;
  17888. }
  17889. }
  17890. break;
  17891. case GEN_EMAIL:
  17892. entry.type = SanType::EMAIL;
  17893. if (gen->d.rfc822Name) {
  17894. entry.value = std::string(
  17895. reinterpret_cast<const char *>(
  17896. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17897. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17898. }
  17899. break;
  17900. case GEN_URI:
  17901. entry.type = SanType::URI;
  17902. if (gen->d.uniformResourceIdentifier) {
  17903. entry.value = std::string(
  17904. reinterpret_cast<const char *>(
  17905. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17906. static_cast<size_t>(
  17907. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17908. }
  17909. break;
  17910. default: entry.type = SanType::OTHER; break;
  17911. }
  17912. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17913. }
  17914. GENERAL_NAMES_free(names);
  17915. return true;
  17916. }
  17917. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17918. time_t &not_after) {
  17919. if (!cert) return false;
  17920. auto x509 = static_cast<X509 *>(cert);
  17921. auto nb = X509_get0_notBefore(x509);
  17922. auto na = X509_get0_notAfter(x509);
  17923. if (!nb || !na) return false;
  17924. ASN1_TIME *epoch = ASN1_TIME_new();
  17925. if (!epoch) return false;
  17926. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17927. if (!ASN1_TIME_set(epoch, 0)) return false;
  17928. int pday, psec;
  17929. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17930. not_before = 86400 * (time_t)pday + psec;
  17931. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17932. not_after = 86400 * (time_t)pday + psec;
  17933. return true;
  17934. }
  17935. inline std::string get_cert_serial(cert_t cert) {
  17936. if (!cert) return "";
  17937. auto x509 = static_cast<X509 *>(cert);
  17938. auto serial = X509_get_serialNumber(x509);
  17939. if (!serial) return "";
  17940. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17941. if (!bn) return "";
  17942. auto hex = BN_bn2hex(bn);
  17943. BN_free(bn);
  17944. if (!hex) return "";
  17945. std::string result(hex);
  17946. OPENSSL_free(hex);
  17947. return result;
  17948. }
  17949. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17950. if (!cert) return false;
  17951. auto x509 = static_cast<X509 *>(cert);
  17952. auto len = i2d_X509(x509, nullptr);
  17953. if (len < 0) return false;
  17954. der.resize(static_cast<size_t>(len));
  17955. auto p = der.data();
  17956. i2d_X509(x509, &p);
  17957. return true;
  17958. }
  17959. inline const char *get_sni(const_session_t session) {
  17960. if (!session) return nullptr;
  17961. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17962. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17963. }
  17964. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17965. inline uint64_t get_error() { return ERR_get_error(); }
  17966. inline std::string error_string(uint64_t code) {
  17967. char buf[256];
  17968. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  17969. sizeof(buf));
  17970. return std::string(buf);
  17971. }
  17972. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17973. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17974. if (!mem) { return nullptr; }
  17975. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17976. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17977. if (!inf) { return nullptr; }
  17978. auto store = X509_STORE_new();
  17979. if (store) {
  17980. auto count = sk_X509_INFO_num(inf);
  17981. for (decltype(count) i = 0; i < count; i++) {
  17982. auto itmp = sk_X509_INFO_value(inf, i);
  17983. if (!itmp) { continue; }
  17984. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17985. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17986. }
  17987. }
  17988. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17989. return static_cast<ca_store_t>(store);
  17990. }
  17991. inline void free_ca_store(ca_store_t store) {
  17992. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17993. }
  17994. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17995. if (!ctx || !store) { return false; }
  17996. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17997. auto x509_store = static_cast<X509_STORE *>(store);
  17998. // Check if same store is already set
  17999. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  18000. // SSL_CTX_set_cert_store takes ownership and frees the old store
  18001. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  18002. return true;
  18003. }
  18004. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18005. certs.clear();
  18006. if (!ctx) { return 0; }
  18007. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18008. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  18009. if (!store) { return 0; }
  18010. auto objs = impl::get_store_objects(store);
  18011. if (!objs) { return 0; }
  18012. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  18013. auto count = sk_X509_OBJECT_num(objs);
  18014. for (decltype(count) i = 0; i < count; i++) {
  18015. auto obj = sk_X509_OBJECT_value(objs, i);
  18016. if (!obj) { continue; }
  18017. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  18018. auto x509 = X509_OBJECT_get0_X509(obj);
  18019. if (x509) {
  18020. // Increment reference count so caller can free it
  18021. X509_up_ref(x509);
  18022. certs.push_back(static_cast<cert_t>(x509));
  18023. }
  18024. }
  18025. }
  18026. return certs.size();
  18027. }
  18028. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18029. std::vector<std::string> names;
  18030. if (!ctx) { return names; }
  18031. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18032. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  18033. if (!store) { return names; }
  18034. auto objs = impl::get_store_objects(store);
  18035. if (!objs) { return names; }
  18036. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  18037. auto count = sk_X509_OBJECT_num(objs);
  18038. for (decltype(count) i = 0; i < count; i++) {
  18039. auto obj = sk_X509_OBJECT_value(objs, i);
  18040. if (!obj) { continue; }
  18041. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  18042. auto x509 = X509_OBJECT_get0_X509(obj);
  18043. if (x509) {
  18044. auto subject = X509_get_subject_name(x509);
  18045. if (subject) {
  18046. char buf[512];
  18047. X509_NAME_oneline(subject, buf, sizeof(buf));
  18048. names.push_back(buf);
  18049. }
  18050. }
  18051. }
  18052. }
  18053. return names;
  18054. }
  18055. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18056. const char *key_pem, const char *password) {
  18057. if (!ctx || !cert_pem || !key_pem) { return false; }
  18058. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18059. // Load certificate from PEM
  18060. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  18061. if (!cert_bio) { return false; }
  18062. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  18063. BIO_free(cert_bio);
  18064. if (!cert) { return false; }
  18065. // Load private key from PEM
  18066. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  18067. if (!key_bio) {
  18068. X509_free(cert);
  18069. return false;
  18070. }
  18071. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  18072. password ? const_cast<char *>(password)
  18073. : nullptr);
  18074. BIO_free(key_bio);
  18075. if (!key) {
  18076. X509_free(cert);
  18077. return false;
  18078. }
  18079. // Update certificate and key
  18080. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  18081. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  18082. X509_free(cert);
  18083. EVP_PKEY_free(key);
  18084. return ret;
  18085. }
  18086. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18087. if (!ctx || !ca_pem) { return false; }
  18088. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18089. // Create new X509_STORE from PEM
  18090. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  18091. if (!store) { return false; }
  18092. // A resumed session is not verified again, so the ticket keys from before
  18093. // go, or a client verified under the old CAs could go on resuming.
  18094. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  18095. unsigned char ticket_keys[48];
  18096. #else
  18097. unsigned char ticket_keys[80];
  18098. #endif
  18099. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  18100. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  18101. sizeof(ticket_keys)) != 1) {
  18102. free_ca_store(store);
  18103. return false;
  18104. }
  18105. // SSL_CTX_set_cert_store takes ownership
  18106. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  18107. // Set client CA list for client certificate request
  18108. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  18109. if (ca_list) {
  18110. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  18111. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  18112. }
  18113. // The cached sessions go for the same reason.
  18114. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  18115. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  18116. #else
  18117. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  18118. #endif
  18119. return true;
  18120. }
  18121. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18122. if (!ctx) { return false; }
  18123. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18124. auto index = impl::verify_callback_index();
  18125. if (index < 0) { return false; }
  18126. std::shared_ptr<VerifyCallback> *stored = nullptr;
  18127. if (callback) {
  18128. stored = new std::shared_ptr<VerifyCallback>(
  18129. std::make_shared<VerifyCallback>(std::move(callback)));
  18130. }
  18131. std::shared_ptr<VerifyCallback> *previous = nullptr;
  18132. {
  18133. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  18134. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  18135. SSL_CTX_get_ex_data(ssl_ctx, index));
  18136. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  18137. delete stored;
  18138. return false;
  18139. }
  18140. }
  18141. // A handshake running the previous callback keeps it until it returns.
  18142. delete previous;
  18143. // A resumed handshake shows no certificate to run the callback on.
  18144. if (stored) {
  18145. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  18146. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  18147. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  18148. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  18149. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  18150. #endif
  18151. }
  18152. // Keep requiring the peer's certificate if set_verify_client() asked for it
  18153. auto require =
  18154. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  18155. impl::apply_verify_mode(ssl_ctx, require);
  18156. return true;
  18157. }
  18158. inline long get_verify_error(const_session_t session) {
  18159. if (!session) { return -1; }
  18160. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  18161. return SSL_get_verify_result(ssl);
  18162. }
  18163. inline std::string verify_error_string(long error_code) {
  18164. if (error_code == X509_V_OK) { return ""; }
  18165. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  18166. return str ? str : "unknown error";
  18167. }
  18168. } // namespace tls
  18169. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  18170. /*
  18171. * Group 9: TLS abstraction layer - Mbed TLS backend
  18172. */
  18173. /*
  18174. * Mbed TLS Backend Implementation
  18175. */
  18176. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  18177. namespace tls {
  18178. namespace impl {
  18179. // Mbed TLS session wrapper
  18180. struct MbedTlsSession {
  18181. mbedtls_ssl_context ssl;
  18182. socket_t sock = INVALID_SOCKET;
  18183. std::string hostname; // For client: set via set_sni
  18184. std::string sni_hostname; // For server: received from client via SNI callback
  18185. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  18186. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  18187. // (e.g. a response that arrived while this side was still in its post-write
  18188. // check), the byte is pushed back here and served by the next read().
  18189. unsigned char peeked_byte = 0;
  18190. bool has_peeked_byte = false;
  18191. // Set by set_sni() when the caller disabled hostname verification, so the
  18192. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  18193. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  18194. // OpenSSL and wolfSSL keep them independent).
  18195. bool suppress_hostname_mismatch = false;
  18196. // Copied from the owning MbedTlsContext at creation, so a handshake only
  18197. // ever runs the callback of its own context.
  18198. VerifyCallback verify_callback;
  18199. bool is_server = false;
  18200. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  18201. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  18202. MbedTlsSession(const MbedTlsSession &) = delete;
  18203. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  18204. };
  18205. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  18206. // queue)
  18207. inline int &mbedtls_last_error() {
  18208. static thread_local int err = 0;
  18209. return err;
  18210. }
  18211. // Helper to map Mbed TLS error to ErrorCode
  18212. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  18213. uint32_t verify_flags) {
  18214. if (ret == 0) { return ErrorCode::Success; }
  18215. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  18216. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  18217. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  18218. return ErrorCode::PeerClosed;
  18219. }
  18220. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  18221. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  18222. out_errno = errno;
  18223. return ErrorCode::SyscallError;
  18224. }
  18225. if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
  18226. // EOF without close_notify
  18227. out_errno = 0;
  18228. return ErrorCode::SyscallError;
  18229. }
  18230. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  18231. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  18232. // the handshake's chain verification (see set_sni()); a mismatch there
  18233. // is reported the same way as any other verify_flags bit. Report it as
  18234. // HostnameMismatch, matching the other backends and the post-handshake
  18235. // identity check below, but only when naming is the sole problem -
  18236. // if the chain itself is also untrusted/expired/etc., that takes
  18237. // priority over the naming detail.
  18238. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  18239. return ErrorCode::HostnameMismatch;
  18240. }
  18241. return ErrorCode::CertVerifyFailed;
  18242. }
  18243. return ErrorCode::Fatal;
  18244. }
  18245. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  18246. // return value, including the verify-flags-dependent HostnameMismatch
  18247. // mapping; shared by connect() and connect_nonblocking() so the
  18248. // backend_code policy for that mapping only lives in one place.
  18249. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  18250. int ret) {
  18251. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  18252. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  18253. err.backend_code = err.code == ErrorCode::HostnameMismatch
  18254. ? static_cast<uint64_t>(verify_flags)
  18255. : static_cast<uint64_t>(-ret);
  18256. }
  18257. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  18258. // non-fatal notification delivered between records, not an error and not
  18259. // application data, so I/O calls that see it should just be retried. Kept in
  18260. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  18261. // splitting the closing brace across an #if.
  18262. inline bool mbedtls_is_session_ticket(int ret) {
  18263. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  18264. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  18265. #else
  18266. (void)ret;
  18267. return false;
  18268. #endif
  18269. }
  18270. // BIO-like send callback for Mbed TLS
  18271. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  18272. size_t len) {
  18273. auto sock = *static_cast<socket_t *>(ctx);
  18274. #ifdef _WIN32
  18275. auto ret =
  18276. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  18277. if (ret == SOCKET_ERROR) {
  18278. int err = WSAGetLastError();
  18279. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  18280. return MBEDTLS_ERR_NET_SEND_FAILED;
  18281. }
  18282. #else
  18283. auto ret = send(sock, buf, len, 0);
  18284. if (ret < 0) {
  18285. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18286. return MBEDTLS_ERR_SSL_WANT_WRITE;
  18287. }
  18288. return MBEDTLS_ERR_NET_SEND_FAILED;
  18289. }
  18290. #endif
  18291. return static_cast<int>(ret);
  18292. }
  18293. // BIO-like recv callback for Mbed TLS
  18294. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  18295. auto sock = *static_cast<socket_t *>(ctx);
  18296. #ifdef _WIN32
  18297. auto ret =
  18298. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  18299. if (ret == SOCKET_ERROR) {
  18300. int err = WSAGetLastError();
  18301. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  18302. return MBEDTLS_ERR_NET_RECV_FAILED;
  18303. }
  18304. #else
  18305. auto ret = recv(sock, buf, len, 0);
  18306. if (ret < 0) {
  18307. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18308. return MBEDTLS_ERR_SSL_WANT_READ;
  18309. }
  18310. return MBEDTLS_ERR_NET_RECV_FAILED;
  18311. }
  18312. #endif
  18313. // EOF is MBEDTLS_ERR_SSL_CONN_EOF; only a close_notify is a clean end
  18314. return static_cast<int>(ret);
  18315. }
  18316. // MbedTlsContext constructor/destructor implementations
  18317. inline MbedTlsContext::MbedTlsContext() {
  18318. mbedtls_ssl_config_init(&conf);
  18319. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18320. mbedtls_entropy_init(&entropy);
  18321. mbedtls_ctr_drbg_init(&ctr_drbg);
  18322. #endif
  18323. mbedtls_x509_crt_init(&ca_chain);
  18324. mbedtls_x509_crt_init(&own_cert);
  18325. mbedtls_pk_init(&own_key);
  18326. }
  18327. inline MbedTlsContext::~MbedTlsContext() {
  18328. mbedtls_pk_free(&own_key);
  18329. mbedtls_x509_crt_free(&own_cert);
  18330. mbedtls_x509_crt_free(&ca_chain);
  18331. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18332. mbedtls_ctr_drbg_free(&ctr_drbg);
  18333. mbedtls_entropy_free(&entropy);
  18334. #endif
  18335. mbedtls_ssl_config_free(&conf);
  18336. }
  18337. // Thread-local storage for SNI captured during handshake
  18338. // This is needed because the SNI callback doesn't have a way to pass
  18339. // session-specific data before the session is fully set up
  18340. inline std::string &mbedpending_sni() {
  18341. static thread_local std::string sni;
  18342. return sni;
  18343. }
  18344. // SNI callback for Mbed TLS server to capture client's SNI hostname
  18345. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  18346. const unsigned char *name, size_t name_len) {
  18347. (void)p_ctx;
  18348. (void)ssl;
  18349. // Store SNI name in thread-local storage
  18350. // It will be retrieved and stored in the session after handshake
  18351. if (name && name_len > 0) {
  18352. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  18353. } else {
  18354. mbedpending_sni().clear();
  18355. }
  18356. return 0; // Accept any SNI
  18357. }
  18358. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  18359. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  18360. }
  18361. // MbedTLS verify callback wrapper
  18362. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  18363. int cert_depth, uint32_t *flags) {
  18364. // data points to the MbedTlsSession
  18365. auto *session = static_cast<MbedTlsSession *>(data);
  18366. // set_sni() disabled hostname verification for this session: ignore the
  18367. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  18368. // pass/fail decision still comes from the remaining flags (and, below, from
  18369. // the user's own verify callback).
  18370. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  18371. const auto &callback = session->verify_callback;
  18372. if (!callback) { return 0; } // Continue with default verification
  18373. // Build context
  18374. VerifyContext verify_ctx;
  18375. verify_ctx.session = static_cast<session_t>(session);
  18376. verify_ctx.cert = static_cast<cert_t>(crt);
  18377. verify_ctx.depth = cert_depth;
  18378. verify_ctx.preverify_ok = (*flags == 0);
  18379. verify_ctx.error_code = static_cast<long>(*flags);
  18380. // Convert Mbed TLS flags to error string
  18381. static thread_local char error_buf[256];
  18382. if (*flags != 0) {
  18383. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  18384. verify_ctx.error_string = error_buf;
  18385. } else {
  18386. verify_ctx.error_string = nullptr;
  18387. }
  18388. bool accepted = run_verify_callback(callback, verify_ctx);
  18389. if (accepted) {
  18390. // Overrides the built-in verification only on a server, as on OpenSSL and
  18391. // wolfSSL, whose clients check the verify result after the handshake
  18392. if (session->is_server) { *flags = 0; }
  18393. return 0;
  18394. }
  18395. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  18396. }
  18397. // Sets the authentication mode from whether the peer's certificate is required
  18398. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  18399. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  18400. inline void apply_verify_mode(MbedTlsContext &mctx) {
  18401. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  18402. if (mctx.verify_client) {
  18403. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  18404. } else if (mctx.verify_callback) {
  18405. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  18406. }
  18407. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  18408. }
  18409. } // namespace impl
  18410. inline ctx_t create_client_context() {
  18411. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18412. if (!ctx) { return nullptr; }
  18413. ctx->is_server = false;
  18414. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18415. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18416. if (!detail::ensure_mbedtls_psa_crypto()) {
  18417. delete ctx;
  18418. return nullptr;
  18419. }
  18420. int ret;
  18421. #else
  18422. // Seed the random number generator
  18423. const char *pers = "httplib_client";
  18424. int ret = mbedtls_ctr_drbg_seed(
  18425. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18426. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18427. if (ret != 0) {
  18428. impl::mbedtls_last_error() = ret;
  18429. delete ctx;
  18430. return nullptr;
  18431. }
  18432. #endif
  18433. // Set up SSL config for client
  18434. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  18435. MBEDTLS_SSL_TRANSPORT_STREAM,
  18436. MBEDTLS_SSL_PRESET_DEFAULT);
  18437. if (ret != 0) {
  18438. impl::mbedtls_last_error() = ret;
  18439. delete ctx;
  18440. return nullptr;
  18441. }
  18442. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18443. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18444. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18445. #endif
  18446. // Default: verify peer certificate
  18447. ctx->verify_client = true;
  18448. impl::apply_verify_mode(*ctx);
  18449. // Set minimum TLS version to 1.2
  18450. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18451. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18452. #else
  18453. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18454. MBEDTLS_SSL_MINOR_VERSION_3);
  18455. #endif
  18456. return static_cast<ctx_t>(ctx);
  18457. }
  18458. inline ctx_t create_server_context() {
  18459. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18460. if (!ctx) { return nullptr; }
  18461. ctx->is_server = true;
  18462. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18463. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18464. if (!detail::ensure_mbedtls_psa_crypto()) {
  18465. delete ctx;
  18466. return nullptr;
  18467. }
  18468. int ret;
  18469. #else
  18470. // Seed the random number generator
  18471. const char *pers = "httplib_server";
  18472. int ret = mbedtls_ctr_drbg_seed(
  18473. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18474. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18475. if (ret != 0) {
  18476. impl::mbedtls_last_error() = ret;
  18477. delete ctx;
  18478. return nullptr;
  18479. }
  18480. #endif
  18481. // Set up SSL config for server
  18482. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  18483. MBEDTLS_SSL_TRANSPORT_STREAM,
  18484. MBEDTLS_SSL_PRESET_DEFAULT);
  18485. if (ret != 0) {
  18486. impl::mbedtls_last_error() = ret;
  18487. delete ctx;
  18488. return nullptr;
  18489. }
  18490. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18491. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18492. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18493. #endif
  18494. // Default: don't verify client
  18495. impl::apply_verify_mode(*ctx);
  18496. // Set minimum TLS version to 1.2
  18497. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18498. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18499. #else
  18500. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18501. MBEDTLS_SSL_MINOR_VERSION_3);
  18502. #endif
  18503. // Set SNI callback to capture client's SNI hostname
  18504. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  18505. return static_cast<ctx_t>(ctx);
  18506. }
  18507. inline void free_context(ctx_t ctx) {
  18508. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  18509. }
  18510. inline bool set_min_version(ctx_t ctx, Version version) {
  18511. if (!ctx) { return false; }
  18512. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18513. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18514. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  18515. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  18516. if (version >= Version::TLS1_3) {
  18517. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18518. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  18519. #endif
  18520. }
  18521. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  18522. #else
  18523. // Mbed TLS 2.x uses major/minor version numbers
  18524. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  18525. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  18526. if (version >= Version::TLS1_3) {
  18527. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18528. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  18529. #else
  18530. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  18531. #endif
  18532. }
  18533. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  18534. #endif
  18535. return true;
  18536. }
  18537. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18538. if (!ctx || !pem) { return false; }
  18539. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18540. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  18541. // Add null terminator if not present
  18542. std::string pem_str(pem, len);
  18543. int ret = mbedtls_x509_crt_parse(
  18544. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18545. pem_str.size() + 1);
  18546. if (ret != 0) {
  18547. impl::mbedtls_last_error() = ret;
  18548. return false;
  18549. }
  18550. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18551. return true;
  18552. }
  18553. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18554. if (!ctx || !file_path) { return false; }
  18555. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18556. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  18557. if (ret != 0) {
  18558. impl::mbedtls_last_error() = ret;
  18559. return false;
  18560. }
  18561. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18562. return true;
  18563. }
  18564. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18565. if (!ctx || !dir_path) { return false; }
  18566. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18567. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  18568. if (ret < 0) { // Returns number of certs on success, negative on error
  18569. impl::mbedtls_last_error() = ret;
  18570. return false;
  18571. }
  18572. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18573. return true;
  18574. }
  18575. inline bool load_system_certs(ctx_t ctx) {
  18576. if (!ctx) { return false; }
  18577. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18578. bool loaded = false;
  18579. #ifdef _WIN32
  18580. loaded = impl::enumerate_windows_system_certs(
  18581. [&](const unsigned char *data, size_t len) {
  18582. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18583. });
  18584. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18585. loaded = impl::enumerate_macos_keychain_certs(
  18586. [&](const unsigned char *data, size_t len) {
  18587. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18588. });
  18589. #else
  18590. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18591. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  18592. loaded = true;
  18593. break;
  18594. }
  18595. }
  18596. if (!loaded) {
  18597. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18598. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  18599. loaded = true;
  18600. break;
  18601. }
  18602. }
  18603. }
  18604. #endif
  18605. if (loaded) {
  18606. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18607. }
  18608. return loaded;
  18609. }
  18610. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18611. const char *password) {
  18612. if (!ctx || !cert || !key) { return false; }
  18613. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18614. // Parse certificate
  18615. std::string cert_str(cert);
  18616. int ret = mbedtls_x509_crt_parse(
  18617. &mctx->own_cert,
  18618. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  18619. cert_str.size() + 1);
  18620. if (ret != 0) {
  18621. impl::mbedtls_last_error() = ret;
  18622. return false;
  18623. }
  18624. // Parse private key
  18625. std::string key_str(key);
  18626. const unsigned char *pwd =
  18627. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  18628. size_t pwd_len = password ? strlen(password) : 0;
  18629. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18630. ret = mbedtls_pk_parse_key(
  18631. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18632. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  18633. &mctx->ctr_drbg);
  18634. #else
  18635. ret = mbedtls_pk_parse_key(
  18636. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18637. key_str.size() + 1, pwd, pwd_len);
  18638. #endif
  18639. if (ret != 0) {
  18640. impl::mbedtls_last_error() = ret;
  18641. return false;
  18642. }
  18643. // Verify that the certificate and private key match.
  18644. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  18645. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  18646. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18647. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18648. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18649. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18650. #else
  18651. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18652. #endif
  18653. if (ret != 0) {
  18654. impl::mbedtls_last_error() = ret;
  18655. return false;
  18656. }
  18657. #endif
  18658. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18659. if (ret != 0) {
  18660. impl::mbedtls_last_error() = ret;
  18661. return false;
  18662. }
  18663. return true;
  18664. }
  18665. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18666. const char *key_path, const char *password) {
  18667. if (!ctx || !cert_path || !key_path) { return false; }
  18668. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18669. // Parse certificate file
  18670. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  18671. if (ret != 0) {
  18672. impl::mbedtls_last_error() = ret;
  18673. return false;
  18674. }
  18675. // Parse private key file
  18676. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18677. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  18678. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18679. #else
  18680. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  18681. #endif
  18682. if (ret != 0) {
  18683. impl::mbedtls_last_error() = ret;
  18684. return false;
  18685. }
  18686. // Verify that the certificate and private key match.
  18687. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  18688. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18689. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18690. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18691. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18692. #else
  18693. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18694. #endif
  18695. if (ret != 0) {
  18696. impl::mbedtls_last_error() = ret;
  18697. return false;
  18698. }
  18699. #endif
  18700. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18701. if (ret != 0) {
  18702. impl::mbedtls_last_error() = ret;
  18703. return false;
  18704. }
  18705. return true;
  18706. }
  18707. inline void set_verify_client(ctx_t ctx, bool require) {
  18708. if (!ctx) { return; }
  18709. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18710. mctx->verify_client = require;
  18711. impl::apply_verify_mode(*mctx);
  18712. }
  18713. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18714. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18715. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18716. auto session = new (std::nothrow) impl::MbedTlsSession();
  18717. if (!session) { return nullptr; }
  18718. session->sock = sock;
  18719. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18720. if (ret != 0) {
  18721. impl::mbedtls_last_error() = ret;
  18722. delete session;
  18723. return nullptr;
  18724. }
  18725. // Explicitly opt out of in-handshake hostname verification by default;
  18726. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18727. // fails outright when no hostname was set. set_sni() installs the real
  18728. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18729. // caller verifies the certificate identity post-handshake via
  18730. // verify_hostname().
  18731. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18732. // Set BIO callbacks
  18733. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18734. impl::mbedtls_net_recv_cb, nullptr);
  18735. // Installed always, as it also masks the hostname mismatch that set_sni()
  18736. // may ask for. The session runs its own copy of the user's callback, which
  18737. // set_verify_callback() cannot replace under a handshake.
  18738. session->verify_callback = mctx->verify_callback;
  18739. session->is_server = mctx->is_server;
  18740. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  18741. return static_cast<session_t>(session);
  18742. }
  18743. inline void free_session(session_t session) {
  18744. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18745. }
  18746. inline bool set_sni(session_t session, const char *hostname,
  18747. bool verify_hostname) {
  18748. if (!session || !hostname) { return false; }
  18749. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18750. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18751. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18752. // independently, so a disabled hostname check is handled below by masking
  18753. // the resulting mismatch flag instead of skipping this call.
  18754. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18755. if (ret != 0) {
  18756. impl::mbedtls_last_error() = ret;
  18757. return false;
  18758. }
  18759. msession->hostname = hostname;
  18760. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  18761. return true;
  18762. }
  18763. inline TlsError connect(session_t session) {
  18764. TlsError err;
  18765. if (!session) {
  18766. err.code = ErrorCode::Fatal;
  18767. return err;
  18768. }
  18769. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18770. int ret;
  18771. do {
  18772. ret = mbedtls_ssl_handshake(&msession->ssl);
  18773. } while (impl::mbedtls_is_session_ticket(ret));
  18774. if (ret == 0) {
  18775. err.code = ErrorCode::Success;
  18776. } else {
  18777. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18778. impl::mbedtls_last_error() = ret;
  18779. }
  18780. return err;
  18781. }
  18782. inline TlsError accept(session_t session) {
  18783. // A failed handshake leaves its SNI behind, so start without it
  18784. impl::mbedpending_sni().clear();
  18785. // Same as connect for Mbed TLS - handshake works for both client and server
  18786. auto result = connect(session);
  18787. // After successful handshake, capture SNI from thread-local storage
  18788. if (result.code == ErrorCode::Success && session) {
  18789. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18790. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18791. }
  18792. return result;
  18793. }
  18794. inline bool connect_nonblocking(session_t session, socket_t sock,
  18795. time_t timeout_sec, time_t timeout_usec,
  18796. TlsError *err,
  18797. const std::function<bool()> &interrupted) {
  18798. if (!session) {
  18799. if (err) { err->code = ErrorCode::Fatal; }
  18800. return false;
  18801. }
  18802. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18803. // Set socket to non-blocking mode
  18804. detail::set_nonblocking(sock, true);
  18805. auto cleanup =
  18806. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18807. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18808. int ret;
  18809. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18810. // Non-fatal TLS 1.3 ticket; retry immediately.
  18811. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18812. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18813. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  18814. continue;
  18815. }
  18816. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18817. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  18818. continue;
  18819. }
  18820. }
  18821. // TlsError or timeout
  18822. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18823. impl::mbedtls_last_error() = ret;
  18824. return false;
  18825. }
  18826. if (err) { err->code = ErrorCode::Success; }
  18827. return true;
  18828. }
  18829. inline bool accept_nonblocking(session_t session, socket_t sock,
  18830. time_t timeout_sec, time_t timeout_usec,
  18831. TlsError *err) {
  18832. // A failed handshake leaves its SNI behind, so start without it
  18833. impl::mbedpending_sni().clear();
  18834. // Same implementation as connect for Mbed TLS
  18835. bool result =
  18836. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18837. // After successful handshake, capture SNI from thread-local storage
  18838. if (result && session) {
  18839. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18840. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18841. }
  18842. return result;
  18843. }
  18844. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18845. if (!session || !buf) {
  18846. err.code = ErrorCode::Fatal;
  18847. return -1;
  18848. }
  18849. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18850. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18851. if (msession->has_peeked_byte) {
  18852. if (len == 0) { return 0; }
  18853. auto p = static_cast<unsigned char *>(buf);
  18854. p[0] = msession->peeked_byte;
  18855. msession->has_peeked_byte = false;
  18856. size_t n = 1;
  18857. // Top up with any already-decrypted bytes without risking a block.
  18858. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18859. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18860. if (extra > 0) { n += static_cast<size_t>(extra); }
  18861. }
  18862. err.code = ErrorCode::Success;
  18863. return static_cast<ssize_t>(n);
  18864. }
  18865. int ret;
  18866. do {
  18867. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18868. len);
  18869. } while (impl::mbedtls_is_session_ticket(ret));
  18870. if (ret > 0) {
  18871. err.code = ErrorCode::Success;
  18872. return static_cast<ssize_t>(ret);
  18873. }
  18874. // 0 means EOF without close_notify, which is an error as on OpenSSL
  18875. if (ret == 0) { ret = MBEDTLS_ERR_SSL_CONN_EOF; }
  18876. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18877. err.backend_code = static_cast<uint64_t>(-ret);
  18878. impl::mbedtls_last_error() = ret;
  18879. // mbedTLS signals a clean close_notify via a negative error code rather
  18880. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18881. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18882. return -1;
  18883. }
  18884. inline ssize_t write(session_t session, const void *buf, size_t len,
  18885. TlsError &err) {
  18886. if (!session || !buf) {
  18887. err.code = ErrorCode::Fatal;
  18888. return -1;
  18889. }
  18890. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18891. int ret;
  18892. do {
  18893. ret = mbedtls_ssl_write(&msession->ssl,
  18894. static_cast<const unsigned char *>(buf), len);
  18895. } while (impl::mbedtls_is_session_ticket(ret));
  18896. if (ret > 0) {
  18897. err.code = ErrorCode::Success;
  18898. return static_cast<ssize_t>(ret);
  18899. }
  18900. if (ret == 0) {
  18901. err.code = ErrorCode::PeerClosed;
  18902. return 0;
  18903. }
  18904. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18905. err.backend_code = static_cast<uint64_t>(-ret);
  18906. impl::mbedtls_last_error() = ret;
  18907. return -1;
  18908. }
  18909. inline int pending(const_session_t session) {
  18910. if (!session) { return 0; }
  18911. auto msession =
  18912. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18913. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18914. (msession->has_peeked_byte ? 1 : 0);
  18915. }
  18916. inline void shutdown(session_t session, bool graceful) {
  18917. if (!session) { return; }
  18918. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18919. if (graceful) {
  18920. // Try to send close_notify, but don't block forever
  18921. int ret;
  18922. int attempts = 0;
  18923. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18924. attempts < 3) {
  18925. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18926. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18927. break;
  18928. }
  18929. attempts++;
  18930. }
  18931. }
  18932. }
  18933. inline bool is_peer_closed(session_t session, socket_t sock) {
  18934. if (!session || sock == INVALID_SOCKET) { return true; }
  18935. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18936. // Check if there's already decrypted or pushed-back data available.
  18937. // If so, the connection is definitely alive.
  18938. if (msession->has_peeked_byte ||
  18939. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18940. return false;
  18941. }
  18942. // Set socket to non-blocking to avoid blocking on read
  18943. detail::set_nonblocking(sock, true);
  18944. auto cleanup =
  18945. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18946. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18947. // on application data — e.g. a response that already arrived — push the
  18948. // byte back so the next read() delivers it instead of losing it.
  18949. unsigned char buf;
  18950. int ret;
  18951. do {
  18952. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18953. } while (impl::mbedtls_is_session_ticket(ret));
  18954. // If we got data or WANT_READ (would block), connection is alive
  18955. if (ret > 0) {
  18956. msession->peeked_byte = buf;
  18957. msession->has_peeked_byte = true;
  18958. return false;
  18959. }
  18960. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18961. // If we get a peer close notify or a connection reset, the peer is closed
  18962. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18963. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18964. }
  18965. inline cert_t get_peer_cert(const_session_t session) {
  18966. if (!session) { return nullptr; }
  18967. auto msession =
  18968. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18969. // Mbed TLS returns a pointer to the internal peer cert chain.
  18970. // WARNING: This pointer is only valid while the session is active.
  18971. // Do not use the certificate after calling free_session().
  18972. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18973. return const_cast<mbedtls_x509_crt *>(cert);
  18974. }
  18975. inline size_t get_peer_certs(const_session_t session,
  18976. std::vector<cert_t> &certs) {
  18977. certs.clear();
  18978. // Mbed TLS parses the whole received chain into a list headed by the peer
  18979. // certificate, owned by the session like get_peer_cert()'s result
  18980. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18981. crt && crt->raw.len > 0; crt = crt->next) {
  18982. certs.push_back(static_cast<cert_t>(crt));
  18983. }
  18984. return certs.size();
  18985. }
  18986. inline void free_cert(cert_t cert) {
  18987. // Mbed TLS: every cert_t handed out points into a session's or a context's
  18988. // chain, so there is nothing to free. Callers still call this for the other
  18989. // backends.
  18990. (void)cert;
  18991. }
  18992. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18993. if (!cert || !hostname) { return false; }
  18994. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18995. std::string host_str(hostname);
  18996. // Check if hostname is an IP address (IPv4 or IPv6)
  18997. unsigned char ip_bytes[16];
  18998. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18999. auto is_ip = ip_len > 0;
  19000. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  19001. // in buf.tag and the raw value in buf.p / buf.len.
  19002. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  19003. if (!san->buf.p || san->buf.len == 0) { continue; }
  19004. const unsigned char *p = san->buf.p;
  19005. size_t len = san->buf.len;
  19006. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  19007. if (is_ip) {
  19008. // For an IP host, only a matching iPAddress SAN of the same family
  19009. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  19010. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  19011. memcmp(p, ip_bytes, ip_len) == 0) {
  19012. return true;
  19013. }
  19014. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  19015. std::string san_name(reinterpret_cast<const char *>(p), len);
  19016. if (detail::match_hostname(san_name, host_str)) { return true; }
  19017. }
  19018. }
  19019. return false;
  19020. }
  19021. inline uint64_t hostname_mismatch_code() {
  19022. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  19023. }
  19024. inline long get_verify_result(const_session_t session) {
  19025. if (!session) { return -1; }
  19026. auto msession =
  19027. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19028. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  19029. // Return 0 (X509_V_OK equivalent) if verification passed
  19030. return flags == 0 ? 0 : static_cast<long>(flags);
  19031. }
  19032. inline std::string get_cert_subject_cn(cert_t cert) {
  19033. if (!cert) return "";
  19034. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19035. // Find the CN in the subject
  19036. const mbedtls_x509_name *name = &x509->subject;
  19037. while (name != nullptr) {
  19038. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  19039. return std::string(reinterpret_cast<const char *>(name->val.p),
  19040. name->val.len);
  19041. }
  19042. name = name->next;
  19043. }
  19044. return "";
  19045. }
  19046. inline std::string get_cert_issuer_name(cert_t cert) {
  19047. if (!cert) return "";
  19048. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19049. // Build a human-readable issuer name string
  19050. char buf[512];
  19051. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  19052. if (ret < 0) return "";
  19053. return std::string(buf);
  19054. }
  19055. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19056. sans.clear();
  19057. if (!cert) return false;
  19058. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19059. // Parse the Subject Alternative Name extension
  19060. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  19061. while (cur != nullptr) {
  19062. if (cur->buf.len > 0) {
  19063. const unsigned char *p = cur->buf.p;
  19064. size_t value_len = cur->buf.len;
  19065. SanEntry entry;
  19066. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  19067. case MBEDTLS_X509_SAN_DNS_NAME:
  19068. entry.type = SanType::DNS;
  19069. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19070. break;
  19071. case MBEDTLS_X509_SAN_IP_ADDRESS:
  19072. entry.type = SanType::IP;
  19073. if (value_len == 4) {
  19074. // IPv4
  19075. char buf[16];
  19076. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  19077. entry.value = buf;
  19078. } else if (value_len == 16) {
  19079. // IPv6
  19080. char buf[64];
  19081. snprintf(buf, sizeof(buf),
  19082. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19083. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19084. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  19085. p[10], p[11], p[12], p[13], p[14], p[15]);
  19086. entry.value = buf;
  19087. }
  19088. break;
  19089. case MBEDTLS_X509_SAN_RFC822_NAME:
  19090. entry.type = SanType::EMAIL;
  19091. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19092. break;
  19093. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  19094. entry.type = SanType::URI;
  19095. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19096. break;
  19097. default: entry.type = SanType::OTHER; break;
  19098. }
  19099. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19100. }
  19101. cur = cur->next;
  19102. }
  19103. return true;
  19104. }
  19105. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19106. time_t &not_after) {
  19107. if (!cert) return false;
  19108. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19109. // Convert mbedtls_x509_time to time_t
  19110. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  19111. struct tm tm_time = {};
  19112. tm_time.tm_year = t.year - 1900;
  19113. tm_time.tm_mon = t.mon - 1;
  19114. tm_time.tm_mday = t.day;
  19115. tm_time.tm_hour = t.hour;
  19116. tm_time.tm_min = t.min;
  19117. tm_time.tm_sec = t.sec;
  19118. #ifdef _WIN32
  19119. return _mkgmtime(&tm_time);
  19120. #else
  19121. return timegm(&tm_time);
  19122. #endif
  19123. };
  19124. not_before = to_time_t(x509->valid_from);
  19125. not_after = to_time_t(x509->valid_to);
  19126. return true;
  19127. }
  19128. inline std::string get_cert_serial(cert_t cert) {
  19129. if (!cert) return "";
  19130. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19131. // Convert serial number to hex string
  19132. std::string result;
  19133. result.reserve(x509->serial.len * 2);
  19134. for (size_t i = 0; i < x509->serial.len; i++) {
  19135. char hex[3];
  19136. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  19137. result += hex;
  19138. }
  19139. return result;
  19140. }
  19141. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19142. if (!cert) return false;
  19143. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  19144. if (!crt->raw.p || crt->raw.len == 0) return false;
  19145. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  19146. return true;
  19147. }
  19148. inline const char *get_sni(const_session_t session) {
  19149. if (!session) return nullptr;
  19150. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  19151. // For server: return SNI received from client during handshake
  19152. if (!msession->sni_hostname.empty()) {
  19153. return msession->sni_hostname.c_str();
  19154. }
  19155. // For client: return the hostname set via set_sni
  19156. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  19157. return nullptr;
  19158. }
  19159. inline uint64_t peek_error() {
  19160. // Mbed TLS doesn't have an error queue, return the last error
  19161. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  19162. }
  19163. inline uint64_t get_error() {
  19164. // Mbed TLS doesn't have an error queue, return and clear the last error
  19165. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  19166. impl::mbedtls_last_error() = 0;
  19167. return err;
  19168. }
  19169. inline std::string error_string(uint64_t code) {
  19170. char buf[256];
  19171. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  19172. return std::string(buf);
  19173. }
  19174. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19175. #ifdef CPPHTTPLIB_MBEDTLS_V4
  19176. // Parsing certificates needs PSA Crypto, and no context may exist yet
  19177. if (!detail::ensure_mbedtls_psa_crypto()) { return nullptr; }
  19178. #endif
  19179. if (!pem) { return nullptr; }
  19180. // mbedtls_x509_crt_parse expects null-terminated PEM
  19181. std::string pem_str(pem, len);
  19182. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  19183. if (!ca_chain) { return nullptr; }
  19184. mbedtls_x509_crt_init(ca_chain);
  19185. auto ret = mbedtls_x509_crt_parse(
  19186. ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  19187. pem_str.size() + 1);
  19188. if (ret != 0) {
  19189. mbedtls_x509_crt_free(ca_chain);
  19190. delete ca_chain;
  19191. return nullptr;
  19192. }
  19193. return static_cast<ca_store_t>(ca_chain);
  19194. }
  19195. inline void free_ca_store(ca_store_t store) {
  19196. if (store) {
  19197. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19198. mbedtls_x509_crt_free(ca_chain);
  19199. delete ca_chain;
  19200. }
  19201. }
  19202. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19203. if (!ctx || !store) { return false; }
  19204. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19205. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19206. // Free existing CA chain
  19207. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  19208. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  19209. // Copy the CA chain (deep copy)
  19210. // Parse from the raw data of the source cert
  19211. mbedtls_x509_crt *src = ca_chain;
  19212. while (src != nullptr) {
  19213. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  19214. src->raw.len);
  19215. if (ret != 0) {
  19216. free_ca_store(store);
  19217. return false;
  19218. }
  19219. src = src->next;
  19220. }
  19221. // This function takes ownership of the store; the chain was deep-copied
  19222. // above, so release the source
  19223. free_ca_store(store);
  19224. // Update the SSL config to use the new CA chain
  19225. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19226. return true;
  19227. }
  19228. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19229. certs.clear();
  19230. if (!ctx) { return 0; }
  19231. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19232. // Owned by the context; see free_cert()
  19233. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  19234. cert = cert->next) {
  19235. certs.push_back(static_cast<cert_t>(cert));
  19236. }
  19237. return certs.size();
  19238. }
  19239. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19240. std::vector<std::string> names;
  19241. if (!ctx) { return names; }
  19242. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19243. // Iterate through the CA chain
  19244. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  19245. while (cert != nullptr && cert->raw.len > 0) {
  19246. char buf[512];
  19247. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  19248. if (ret > 0) { names.push_back(buf); }
  19249. cert = cert->next;
  19250. }
  19251. return names;
  19252. }
  19253. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19254. const char *key_pem, const char *password) {
  19255. if (!ctx || !cert_pem || !key_pem) { return false; }
  19256. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19257. // Parse into new objects first, so that a bad pair leaves the old one in
  19258. // place, and swap them in after; the old ones are freed on the way out.
  19259. mbedtls_x509_crt cert;
  19260. mbedtls_pk_context key;
  19261. mbedtls_x509_crt_init(&cert);
  19262. mbedtls_pk_init(&key);
  19263. auto se = detail::scope_exit([&] {
  19264. mbedtls_x509_crt_free(&cert);
  19265. mbedtls_pk_free(&key);
  19266. });
  19267. // Parse certificate PEM
  19268. int ret = mbedtls_x509_crt_parse(
  19269. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  19270. strlen(cert_pem) + 1);
  19271. if (ret != 0) {
  19272. impl::mbedtls_last_error() = ret;
  19273. return false;
  19274. }
  19275. // Parse private key PEM
  19276. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  19277. ret = mbedtls_pk_parse_key(
  19278. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19279. strlen(key_pem) + 1,
  19280. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19281. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  19282. &mbed_ctx->ctr_drbg);
  19283. #else
  19284. ret = mbedtls_pk_parse_key(
  19285. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19286. strlen(key_pem) + 1,
  19287. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19288. password ? strlen(password) : 0);
  19289. #endif
  19290. if (ret != 0) {
  19291. impl::mbedtls_last_error() = ret;
  19292. return false;
  19293. }
  19294. std::swap(mbed_ctx->own_cert, cert);
  19295. std::swap(mbed_ctx->own_key, key);
  19296. // Configure SSL to use the new certificate and key
  19297. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  19298. &mbed_ctx->own_key);
  19299. if (ret != 0) {
  19300. impl::mbedtls_last_error() = ret;
  19301. return false;
  19302. }
  19303. return true;
  19304. }
  19305. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19306. if (!ctx || !ca_pem) { return false; }
  19307. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19308. // Parse into a new chain first, so that a bad one leaves the old in place
  19309. mbedtls_x509_crt chain;
  19310. mbedtls_x509_crt_init(&chain);
  19311. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  19312. // Parse CA PEM
  19313. int ret = mbedtls_x509_crt_parse(
  19314. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  19315. strlen(ca_pem) + 1);
  19316. if (ret != 0) {
  19317. impl::mbedtls_last_error() = ret;
  19318. return false;
  19319. }
  19320. std::swap(mbed_ctx->ca_chain, chain);
  19321. // Update SSL config to use new CA chain
  19322. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19323. return true;
  19324. }
  19325. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19326. if (!ctx) { return false; }
  19327. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19328. // create_session() hands each session its own copy to run.
  19329. mbed_ctx->verify_callback = std::move(callback);
  19330. impl::apply_verify_mode(*mbed_ctx);
  19331. return true;
  19332. }
  19333. inline long get_verify_error(const_session_t session) {
  19334. if (!session) { return -1; }
  19335. auto *msession =
  19336. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19337. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  19338. }
  19339. inline std::string verify_error_string(long error_code) {
  19340. if (error_code == 0) { return ""; }
  19341. char buf[256];
  19342. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  19343. static_cast<uint32_t>(error_code));
  19344. // Remove trailing newline if present
  19345. std::string result(buf);
  19346. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  19347. result.pop_back();
  19348. }
  19349. return result;
  19350. }
  19351. } // namespace tls
  19352. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  19353. /*
  19354. * Group 10: TLS abstraction layer - wolfSSL backend
  19355. */
  19356. /*
  19357. * wolfSSL Backend Implementation
  19358. */
  19359. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  19360. namespace tls {
  19361. namespace impl {
  19362. // wolfSSL session wrapper
  19363. struct WolfSSLSession {
  19364. WOLFSSL *ssl = nullptr;
  19365. socket_t sock = INVALID_SOCKET;
  19366. std::string hostname; // For client: set via set_sni
  19367. std::string sni_hostname; // For server: received from client via SNI callback
  19368. WolfSSLSession() = default;
  19369. ~WolfSSLSession() {
  19370. if (ssl) { wolfSSL_free(ssl); }
  19371. }
  19372. WolfSSLSession(const WolfSSLSession &) = delete;
  19373. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  19374. };
  19375. // Thread-local error code accessor for wolfSSL
  19376. inline uint64_t &wolfssl_last_error() {
  19377. static thread_local uint64_t err = 0;
  19378. return err;
  19379. }
  19380. // Helper to map wolfSSL error to ErrorCode.
  19381. // ssl_error is the value from wolfSSL_get_error().
  19382. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  19383. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  19384. int &out_errno) {
  19385. switch (ssl_error) {
  19386. case SSL_ERROR_NONE: return ErrorCode::Success;
  19387. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  19388. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  19389. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  19390. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  19391. // EOF without close_notify
  19392. case SOCKET_PEER_CLOSED_E: out_errno = 0; return ErrorCode::SyscallError;
  19393. default:
  19394. if (ssl) {
  19395. // wolfSSL stores the low-level error code as a negative value.
  19396. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  19397. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  19398. if (low_err == DOMAIN_NAME_MISMATCH) {
  19399. return ErrorCode::HostnameMismatch;
  19400. }
  19401. // Check verify result to distinguish cert verification from generic SSL
  19402. // errors.
  19403. long vr = wolfSSL_get_verify_result(ssl);
  19404. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  19405. }
  19406. return ErrorCode::Fatal;
  19407. }
  19408. }
  19409. // WolfSSLContext constructor/destructor implementations
  19410. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  19411. inline WolfSSLContext::~WolfSSLContext() {
  19412. if (ctx) { wolfSSL_CTX_free(ctx); }
  19413. }
  19414. // Thread-local storage for SNI captured during handshake
  19415. inline std::string &wolfssl_pending_sni() {
  19416. static thread_local std::string sni;
  19417. return sni;
  19418. }
  19419. // SNI callback for wolfSSL server to capture client's SNI hostname
  19420. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  19421. (void)ret;
  19422. (void)exArg;
  19423. void *name_data = nullptr;
  19424. unsigned short name_len =
  19425. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  19426. if (name_data && name_len > 0) {
  19427. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  19428. name_len);
  19429. } else {
  19430. wolfssl_pending_sni().clear();
  19431. }
  19432. return 0; // Continue regardless
  19433. }
  19434. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  19435. // runs the verify callback of its own context.
  19436. inline int context_ex_data_index() {
  19437. static const auto index =
  19438. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19439. return index;
  19440. }
  19441. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  19442. // other tls:: function takes.
  19443. inline int session_ex_data_index() {
  19444. static const auto index =
  19445. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19446. return index;
  19447. }
  19448. // A resumed session skips the client's certificate, so a server that checks
  19449. // one would let in a certificate checked against another server's CA, as
  19450. // wolfSSL shares its session cache between contexts, or against a CA since
  19451. // replaced by update_server_client_ca().
  19452. inline void disable_server_resumption(WolfSSLContext *wctx) {
  19453. if (!wctx->is_server) { return; }
  19454. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  19455. #ifdef HAVE_SESSION_TICKET
  19456. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  19457. #endif
  19458. }
  19459. // wolfSSL verify callback wrapper
  19460. inline int wolfssl_verify_callback(int preverify_ok,
  19461. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  19462. // Get the WOLFSSL object from the X509_STORE_CTX
  19463. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  19464. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  19465. if (!ssl) { return preverify_ok; }
  19466. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  19467. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  19468. if (!wctx) { return preverify_ok; }
  19469. std::shared_ptr<VerifyCallback> callback;
  19470. {
  19471. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  19472. callback = wctx->verify_callback;
  19473. }
  19474. if (!callback) { return preverify_ok; }
  19475. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  19476. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  19477. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  19478. VerifyContext verify_ctx;
  19479. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  19480. verify_ctx.cert = static_cast<cert_t>(cert);
  19481. verify_ctx.depth = depth;
  19482. verify_ctx.preverify_ok = (preverify_ok != 0);
  19483. verify_ctx.error_code = static_cast<long>(err);
  19484. if (err != 0) {
  19485. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  19486. } else {
  19487. verify_ctx.error_string = nullptr;
  19488. }
  19489. auto accepted = run_verify_callback(*callback, verify_ctx);
  19490. // A client verifying the server during the handshake, which is what
  19491. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  19492. if (!wolfSSL_is_server(ssl) &&
  19493. (wolfSSL_get_verify_mode(ssl) & WOLFSSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  19494. accepted = accepted && preverify_ok;
  19495. }
  19496. return accepted ? 1 : 0;
  19497. }
  19498. // Sets the verify mode from whether the peer's certificate is required and
  19499. // whether a verify callback is set.
  19500. inline void apply_verify_mode(WolfSSLContext &wctx) {
  19501. auto has_callback = static_cast<bool>(wctx.verify_callback);
  19502. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  19503. auto mode = wctx.verify_client
  19504. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19505. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  19506. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  19507. has_callback ? wolfssl_verify_callback : nullptr);
  19508. }
  19509. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  19510. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  19511. wolfSSL_CTX_set_default_passwd_cb(
  19512. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  19513. auto *pwd = static_cast<const char *>(userdata);
  19514. if (!pwd) return 0;
  19515. auto len = static_cast<int>(strlen(pwd));
  19516. if (len > size) len = size;
  19517. memcpy(buf, pwd, static_cast<size_t>(len));
  19518. return len;
  19519. });
  19520. }
  19521. } // namespace impl
  19522. inline ctx_t create_client_context() {
  19523. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19524. if (!ctx) { return nullptr; }
  19525. ctx->is_server = false;
  19526. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  19527. if (!method) {
  19528. delete ctx;
  19529. return nullptr;
  19530. }
  19531. ctx->ctx = wolfSSL_CTX_new(method);
  19532. if (!ctx->ctx ||
  19533. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19534. WOLFSSL_SUCCESS) {
  19535. delete ctx;
  19536. return nullptr;
  19537. }
  19538. // Default: verify peer certificate
  19539. ctx->verify_client = true;
  19540. impl::apply_verify_mode(*ctx);
  19541. return static_cast<ctx_t>(ctx);
  19542. }
  19543. inline ctx_t create_server_context() {
  19544. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19545. if (!ctx) { return nullptr; }
  19546. ctx->is_server = true;
  19547. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  19548. if (!method) {
  19549. delete ctx;
  19550. return nullptr;
  19551. }
  19552. ctx->ctx = wolfSSL_CTX_new(method);
  19553. if (!ctx->ctx ||
  19554. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19555. WOLFSSL_SUCCESS) {
  19556. delete ctx;
  19557. return nullptr;
  19558. }
  19559. // Default: don't verify client
  19560. impl::apply_verify_mode(*ctx);
  19561. // Enable SNI on server
  19562. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  19563. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  19564. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  19565. return static_cast<ctx_t>(ctx);
  19566. }
  19567. inline void free_context(ctx_t ctx) {
  19568. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  19569. }
  19570. inline bool set_min_version(ctx_t ctx, Version version) {
  19571. if (!ctx) { return false; }
  19572. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19573. int min_ver = WOLFSSL_TLSV1_2;
  19574. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  19575. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  19576. }
  19577. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  19578. if (!ctx || !pem) { return false; }
  19579. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19580. int ret = wolfSSL_CTX_load_verify_buffer(
  19581. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  19582. static_cast<long>(len), SSL_FILETYPE_PEM);
  19583. if (ret != SSL_SUCCESS) {
  19584. impl::wolfssl_last_error() =
  19585. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19586. return false;
  19587. }
  19588. wctx->ca_pem_data_.append(pem, len);
  19589. return true;
  19590. }
  19591. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  19592. if (!ctx || !file_path) { return false; }
  19593. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19594. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  19595. if (ret != SSL_SUCCESS) {
  19596. impl::wolfssl_last_error() =
  19597. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19598. return false;
  19599. }
  19600. return true;
  19601. }
  19602. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  19603. if (!ctx || !dir_path) { return false; }
  19604. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19605. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  19606. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  19607. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  19608. // immediately. Return true even on failure since the CA file may have
  19609. // already been loaded, matching OpenSSL's lenient behavior.
  19610. (void)ret;
  19611. return true;
  19612. }
  19613. inline bool load_system_certs(ctx_t ctx) {
  19614. if (!ctx) { return false; }
  19615. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19616. bool loaded = false;
  19617. #ifdef _WIN32
  19618. loaded = impl::enumerate_windows_system_certs(
  19619. [&](const unsigned char *data, size_t len) {
  19620. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19621. static_cast<long>(len),
  19622. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19623. });
  19624. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19625. loaded = impl::enumerate_macos_keychain_certs(
  19626. [&](const unsigned char *data, size_t len) {
  19627. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19628. static_cast<long>(len),
  19629. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19630. });
  19631. #else
  19632. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19633. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  19634. SSL_SUCCESS) {
  19635. loaded = true;
  19636. break;
  19637. }
  19638. }
  19639. if (!loaded) {
  19640. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19641. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  19642. SSL_SUCCESS) {
  19643. loaded = true;
  19644. break;
  19645. }
  19646. }
  19647. }
  19648. #endif
  19649. return loaded;
  19650. }
  19651. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19652. const char *password) {
  19653. if (!ctx || !cert || !key) { return false; }
  19654. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19655. // Load certificate
  19656. int ret = wolfSSL_CTX_use_certificate_buffer(
  19657. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  19658. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  19659. if (ret != SSL_SUCCESS) {
  19660. impl::wolfssl_last_error() =
  19661. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19662. return false;
  19663. }
  19664. // Set password callback if password is provided
  19665. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19666. // Load private key
  19667. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19668. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  19669. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  19670. if (ret != SSL_SUCCESS) {
  19671. impl::wolfssl_last_error() =
  19672. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19673. return false;
  19674. }
  19675. // Verify that the certificate and private key match
  19676. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19677. }
  19678. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19679. const char *key_path, const char *password) {
  19680. if (!ctx || !cert_path || !key_path) { return false; }
  19681. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19682. // Load certificate file
  19683. int ret =
  19684. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  19685. if (ret != SSL_SUCCESS) {
  19686. impl::wolfssl_last_error() =
  19687. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19688. return false;
  19689. }
  19690. // Set password callback if password is provided
  19691. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19692. // Load private key file
  19693. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  19694. if (ret != SSL_SUCCESS) {
  19695. impl::wolfssl_last_error() =
  19696. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19697. return false;
  19698. }
  19699. // Verify that the certificate and private key match
  19700. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19701. }
  19702. inline void set_verify_client(ctx_t ctx, bool require) {
  19703. if (!ctx) { return; }
  19704. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19705. wctx->verify_client = require;
  19706. impl::apply_verify_mode(*wctx);
  19707. }
  19708. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19709. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19710. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19711. auto session = new (std::nothrow) impl::WolfSSLSession();
  19712. if (!session) { return nullptr; }
  19713. session->sock = sock;
  19714. session->ssl = wolfSSL_new(wctx->ctx);
  19715. if (!session->ssl) {
  19716. impl::wolfssl_last_error() =
  19717. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19718. delete session;
  19719. return nullptr;
  19720. }
  19721. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19722. session) != WOLFSSL_SUCCESS) {
  19723. delete session;
  19724. return nullptr;
  19725. }
  19726. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19727. return static_cast<session_t>(session);
  19728. }
  19729. inline void free_session(session_t session) {
  19730. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19731. }
  19732. inline bool set_sni(session_t session, const char *hostname,
  19733. bool verify_hostname) {
  19734. if (!session || !hostname) { return false; }
  19735. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19736. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19737. static_cast<word16>(strlen(hostname)));
  19738. if (ret != WOLFSSL_SUCCESS) {
  19739. impl::wolfssl_last_error() =
  19740. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19741. return false;
  19742. }
  19743. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19744. // separately from the SNI extension sent above; skip it when hostname
  19745. // verification is disabled so only the chain is checked, matching OpenSSL.
  19746. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19747. wsession->hostname = hostname;
  19748. return true;
  19749. }
  19750. inline TlsError connect(session_t session) {
  19751. TlsError err;
  19752. if (!session) {
  19753. err.code = ErrorCode::Fatal;
  19754. return err;
  19755. }
  19756. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19757. int ret = wolfSSL_connect(wsession->ssl);
  19758. if (ret == SSL_SUCCESS) {
  19759. err.code = ErrorCode::Success;
  19760. } else {
  19761. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19762. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19763. err.backend_code = static_cast<uint64_t>(ssl_error);
  19764. impl::wolfssl_last_error() = err.backend_code;
  19765. }
  19766. return err;
  19767. }
  19768. inline TlsError accept(session_t session) {
  19769. TlsError err;
  19770. if (!session) {
  19771. err.code = ErrorCode::Fatal;
  19772. return err;
  19773. }
  19774. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19775. int ret = wolfSSL_accept(wsession->ssl);
  19776. if (ret == SSL_SUCCESS) {
  19777. err.code = ErrorCode::Success;
  19778. // Capture SNI from thread-local storage after successful handshake
  19779. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19780. impl::wolfssl_pending_sni().clear();
  19781. } else {
  19782. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19783. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19784. err.backend_code = static_cast<uint64_t>(ssl_error);
  19785. impl::wolfssl_last_error() = err.backend_code;
  19786. }
  19787. return err;
  19788. }
  19789. inline bool connect_nonblocking(session_t session, socket_t sock,
  19790. time_t timeout_sec, time_t timeout_usec,
  19791. TlsError *err,
  19792. const std::function<bool()> &interrupted) {
  19793. if (!session) {
  19794. if (err) { err->code = ErrorCode::Fatal; }
  19795. return false;
  19796. }
  19797. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19798. // Set socket to non-blocking mode
  19799. detail::set_nonblocking(sock, true);
  19800. auto cleanup =
  19801. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19802. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19803. int ret;
  19804. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19805. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19806. if (ssl_error == SSL_ERROR_WANT_READ) {
  19807. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  19808. continue;
  19809. }
  19810. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19811. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  19812. continue;
  19813. }
  19814. }
  19815. // Error or timeout
  19816. if (err) {
  19817. err->code =
  19818. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19819. err->backend_code = static_cast<uint64_t>(ssl_error);
  19820. }
  19821. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19822. return false;
  19823. }
  19824. if (err) { err->code = ErrorCode::Success; }
  19825. return true;
  19826. }
  19827. inline bool accept_nonblocking(session_t session, socket_t sock,
  19828. time_t timeout_sec, time_t timeout_usec,
  19829. TlsError *err) {
  19830. if (!session) {
  19831. if (err) { err->code = ErrorCode::Fatal; }
  19832. return false;
  19833. }
  19834. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19835. // Set socket to non-blocking mode
  19836. detail::set_nonblocking(sock, true);
  19837. auto cleanup =
  19838. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19839. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19840. int ret;
  19841. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19842. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19843. if (ssl_error == SSL_ERROR_WANT_READ) {
  19844. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19845. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19846. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19847. }
  19848. // Error or timeout
  19849. if (err) {
  19850. err->code =
  19851. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19852. err->backend_code = static_cast<uint64_t>(ssl_error);
  19853. }
  19854. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19855. return false;
  19856. }
  19857. if (err) { err->code = ErrorCode::Success; }
  19858. // Capture SNI from thread-local storage after successful handshake
  19859. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19860. impl::wolfssl_pending_sni().clear();
  19861. return true;
  19862. }
  19863. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19864. if (!session || !buf) {
  19865. err.code = ErrorCode::Fatal;
  19866. return -1;
  19867. }
  19868. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19869. constexpr auto max_len =
  19870. static_cast<size_t>((std::numeric_limits<int>::max)());
  19871. if (len > max_len) { len = max_len; }
  19872. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19873. if (ret > 0) {
  19874. err.code = ErrorCode::Success;
  19875. return static_cast<ssize_t>(ret);
  19876. }
  19877. // 0 is also returned for EOF without close_notify; get_error tells them apart
  19878. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19879. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19880. if (err.code == ErrorCode::PeerClosed) { return 0; }
  19881. err.backend_code = static_cast<uint64_t>(ssl_error);
  19882. impl::wolfssl_last_error() = err.backend_code;
  19883. return -1;
  19884. }
  19885. inline ssize_t write(session_t session, const void *buf, size_t len,
  19886. TlsError &err) {
  19887. if (!session || !buf) {
  19888. err.code = ErrorCode::Fatal;
  19889. return -1;
  19890. }
  19891. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19892. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19893. if (ret > 0) {
  19894. err.code = ErrorCode::Success;
  19895. return static_cast<ssize_t>(ret);
  19896. }
  19897. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19898. // Treat this as an error (return -1) so callers don't spin in a
  19899. // write loop adding zero to the offset.
  19900. if (ret == 0) {
  19901. err.code = ErrorCode::PeerClosed;
  19902. return -1;
  19903. }
  19904. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19905. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19906. err.backend_code = static_cast<uint64_t>(ssl_error);
  19907. impl::wolfssl_last_error() = err.backend_code;
  19908. return -1;
  19909. }
  19910. inline int pending(const_session_t session) {
  19911. if (!session) { return 0; }
  19912. auto wsession =
  19913. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19914. return wolfSSL_pending(wsession->ssl);
  19915. }
  19916. inline void shutdown(session_t session, bool graceful) {
  19917. if (!session) { return; }
  19918. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19919. if (graceful) {
  19920. int ret;
  19921. int attempts = 0;
  19922. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19923. attempts < 3) {
  19924. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19925. if (ssl_error != SSL_ERROR_WANT_READ &&
  19926. ssl_error != SSL_ERROR_WANT_WRITE) {
  19927. break;
  19928. }
  19929. attempts++;
  19930. }
  19931. } else {
  19932. wolfSSL_shutdown(wsession->ssl);
  19933. }
  19934. }
  19935. inline bool is_peer_closed(session_t session, socket_t sock) {
  19936. if (!session || sock == INVALID_SOCKET) { return true; }
  19937. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19938. // Check if there's already decrypted data available
  19939. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19940. // Set socket to non-blocking to avoid blocking on read
  19941. detail::set_nonblocking(sock, true);
  19942. auto cleanup =
  19943. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19944. // Peek 1 byte to check connection status without consuming data
  19945. unsigned char buf;
  19946. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19947. // If we got data or WANT_READ (would block), connection is alive
  19948. if (ret > 0) { return false; }
  19949. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19950. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19951. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19952. ret == 0;
  19953. }
  19954. inline cert_t get_peer_cert(const_session_t session) {
  19955. if (!session) { return nullptr; }
  19956. auto wsession =
  19957. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19958. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19959. return static_cast<cert_t>(cert);
  19960. }
  19961. inline size_t get_peer_certs(const_session_t session,
  19962. std::vector<cert_t> &certs) {
  19963. certs.clear();
  19964. if (!session) { return 0; }
  19965. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19966. #ifdef SESSION_CERTS
  19967. auto wsession =
  19968. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19969. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19970. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19971. for (int i = 0; i < count; i++) {
  19972. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19973. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19974. }
  19975. #endif
  19976. return certs.size();
  19977. }
  19978. inline void free_cert(cert_t cert) {
  19979. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19980. }
  19981. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19982. if (!cert || !hostname) { return false; }
  19983. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19984. std::string host_str(hostname);
  19985. // Check if hostname is an IP address (IPv4 or IPv6)
  19986. unsigned char ip_bytes[16];
  19987. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19988. auto is_ip = ip_len > 0;
  19989. // Check Subject Alternative Names
  19990. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19991. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19992. if (san_names) {
  19993. int san_count = wolfSSL_sk_num(san_names);
  19994. for (int i = 0; i < san_count; i++) {
  19995. auto *names =
  19996. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19997. if (!names) continue;
  19998. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19999. // DNS name
  20000. unsigned char *dns_name = nullptr;
  20001. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  20002. if (dns_name && dns_len > 0) {
  20003. std::string san_name(reinterpret_cast<char *>(dns_name),
  20004. static_cast<size_t>(dns_len));
  20005. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  20006. if (detail::match_hostname(san_name, host_str)) {
  20007. wolfSSL_sk_free(san_names);
  20008. return true;
  20009. }
  20010. }
  20011. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  20012. // IP address: only an iPAddress SAN of the same family (4 bytes for
  20013. // IPv4, 16 bytes for IPv6) may authenticate the host.
  20014. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  20015. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  20016. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  20017. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  20018. wolfSSL_sk_free(san_names);
  20019. return true;
  20020. }
  20021. }
  20022. }
  20023. wolfSSL_sk_free(san_names);
  20024. }
  20025. return false;
  20026. }
  20027. inline uint64_t hostname_mismatch_code() {
  20028. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  20029. }
  20030. inline long get_verify_result(const_session_t session) {
  20031. if (!session) { return -1; }
  20032. auto wsession =
  20033. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20034. long result = wolfSSL_get_verify_result(wsession->ssl);
  20035. return result;
  20036. }
  20037. inline std::string get_cert_subject_cn(cert_t cert) {
  20038. if (!cert) return "";
  20039. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20040. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  20041. if (!subject) return "";
  20042. char cn[256] = {};
  20043. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  20044. sizeof(cn));
  20045. if (cn_len <= 0) return "";
  20046. return std::string(cn, static_cast<size_t>(cn_len));
  20047. }
  20048. inline std::string get_cert_issuer_name(cert_t cert) {
  20049. if (!cert) return "";
  20050. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20051. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  20052. if (!issuer) return "";
  20053. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  20054. if (!name_str) return "";
  20055. std::string result(name_str);
  20056. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  20057. return result;
  20058. }
  20059. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  20060. sans.clear();
  20061. if (!cert) return false;
  20062. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20063. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  20064. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  20065. if (!san_names) return true; // No SANs is not an error
  20066. int count = wolfSSL_sk_num(san_names);
  20067. for (int i = 0; i < count; i++) {
  20068. auto *name =
  20069. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  20070. if (!name) continue;
  20071. SanEntry entry;
  20072. switch (name->type) {
  20073. case WOLFSSL_GEN_DNS: {
  20074. entry.type = SanType::DNS;
  20075. unsigned char *dns_name = nullptr;
  20076. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  20077. if (dns_name && dns_len > 0) {
  20078. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  20079. static_cast<size_t>(dns_len));
  20080. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  20081. }
  20082. break;
  20083. }
  20084. case WOLFSSL_GEN_IPADD: {
  20085. entry.type = SanType::IP;
  20086. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  20087. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  20088. if (ip_data && ip_len == 4) {
  20089. char buf[16];
  20090. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  20091. ip_data[2], ip_data[3]);
  20092. entry.value = buf;
  20093. } else if (ip_data && ip_len == 16) {
  20094. char buf[64];
  20095. snprintf(buf, sizeof(buf),
  20096. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  20097. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  20098. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  20099. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  20100. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  20101. ip_data[14], ip_data[15]);
  20102. entry.value = buf;
  20103. }
  20104. break;
  20105. }
  20106. case WOLFSSL_GEN_EMAIL:
  20107. entry.type = SanType::EMAIL;
  20108. {
  20109. unsigned char *email = nullptr;
  20110. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  20111. if (email && email_len > 0) {
  20112. entry.value = std::string(reinterpret_cast<char *>(email),
  20113. static_cast<size_t>(email_len));
  20114. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  20115. }
  20116. }
  20117. break;
  20118. case WOLFSSL_GEN_URI:
  20119. entry.type = SanType::URI;
  20120. {
  20121. unsigned char *uri = nullptr;
  20122. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  20123. &uri, name->d.uniformResourceIdentifier);
  20124. if (uri && uri_len > 0) {
  20125. entry.value = std::string(reinterpret_cast<char *>(uri),
  20126. static_cast<size_t>(uri_len));
  20127. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  20128. }
  20129. }
  20130. break;
  20131. default: entry.type = SanType::OTHER; break;
  20132. }
  20133. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  20134. }
  20135. wolfSSL_sk_free(san_names);
  20136. return true;
  20137. }
  20138. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  20139. time_t &not_after) {
  20140. if (!cert) return false;
  20141. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20142. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  20143. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  20144. if (!nb || !na) return false;
  20145. // wolfSSL_ASN1_TIME_to_tm is available
  20146. struct tm tm_nb = {}, tm_na = {};
  20147. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  20148. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  20149. #ifdef _WIN32
  20150. not_before = _mkgmtime(&tm_nb);
  20151. not_after = _mkgmtime(&tm_na);
  20152. #else
  20153. not_before = timegm(&tm_nb);
  20154. not_after = timegm(&tm_na);
  20155. #endif
  20156. return true;
  20157. }
  20158. inline std::string get_cert_serial(cert_t cert) {
  20159. if (!cert) return "";
  20160. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20161. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  20162. if (!serial_asn1) return "";
  20163. // Get the serial number data
  20164. int len = serial_asn1->length;
  20165. unsigned char *data = serial_asn1->data;
  20166. if (!data || len <= 0) return "";
  20167. std::string result;
  20168. result.reserve(static_cast<size_t>(len) * 2);
  20169. for (int i = 0; i < len; i++) {
  20170. char hex[3];
  20171. snprintf(hex, sizeof(hex), "%02X", data[i]);
  20172. result += hex;
  20173. }
  20174. return result;
  20175. }
  20176. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  20177. if (!cert) return false;
  20178. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20179. int der_len = 0;
  20180. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  20181. if (!der_data || der_len <= 0) return false;
  20182. der.assign(der_data, der_data + der_len);
  20183. return true;
  20184. }
  20185. inline const char *get_sni(const_session_t session) {
  20186. if (!session) return nullptr;
  20187. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  20188. // For server: return SNI received from client during handshake
  20189. if (!wsession->sni_hostname.empty()) {
  20190. return wsession->sni_hostname.c_str();
  20191. }
  20192. // For client: return the hostname set via set_sni
  20193. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  20194. return nullptr;
  20195. }
  20196. inline uint64_t peek_error() {
  20197. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20198. }
  20199. inline uint64_t get_error() {
  20200. uint64_t err = impl::wolfssl_last_error();
  20201. impl::wolfssl_last_error() = 0;
  20202. return err;
  20203. }
  20204. inline std::string error_string(uint64_t code) {
  20205. char buf[256];
  20206. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  20207. return std::string(buf);
  20208. }
  20209. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  20210. if (!pem || len == 0) { return nullptr; }
  20211. // Validate by attempting to load into a temporary ctx
  20212. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  20213. if (!tmp_ctx) { return nullptr; }
  20214. int ret = wolfSSL_CTX_load_verify_buffer(
  20215. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  20216. static_cast<long>(len), SSL_FILETYPE_PEM);
  20217. wolfSSL_CTX_free(tmp_ctx);
  20218. if (ret != SSL_SUCCESS) { return nullptr; }
  20219. return static_cast<ca_store_t>(
  20220. new impl::WolfSSLCAStore{std::string(pem, len)});
  20221. }
  20222. inline void free_ca_store(ca_store_t store) {
  20223. delete static_cast<impl::WolfSSLCAStore *>(store);
  20224. }
  20225. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  20226. if (!ctx || !store) { return false; }
  20227. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20228. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  20229. int ret = wolfSSL_CTX_load_verify_buffer(
  20230. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  20231. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  20232. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  20233. // This function takes ownership of the store; the PEM data was copied into
  20234. // the context, so release the source
  20235. free_ca_store(store);
  20236. return ret == SSL_SUCCESS;
  20237. }
  20238. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  20239. certs.clear();
  20240. if (!ctx) { return 0; }
  20241. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20242. if (wctx->ca_pem_data_.empty()) { return 0; }
  20243. const std::string &pem = wctx->ca_pem_data_;
  20244. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20245. const std::string end_marker = "-----END CERTIFICATE-----";
  20246. size_t pos = 0;
  20247. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20248. size_t end_pos = pem.find(end_marker, pos);
  20249. if (end_pos == std::string::npos) { break; }
  20250. end_pos += end_marker.size();
  20251. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20252. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20253. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20254. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20255. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  20256. pos = end_pos;
  20257. }
  20258. return certs.size();
  20259. }
  20260. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  20261. std::vector<std::string> names;
  20262. if (!ctx) { return names; }
  20263. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20264. if (wctx->ca_pem_data_.empty()) { return names; }
  20265. const std::string &pem = wctx->ca_pem_data_;
  20266. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20267. const std::string end_marker = "-----END CERTIFICATE-----";
  20268. size_t pos = 0;
  20269. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20270. size_t end_pos = pem.find(end_marker, pos);
  20271. if (end_pos == std::string::npos) { break; }
  20272. end_pos += end_marker.size();
  20273. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20274. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20275. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20276. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20277. if (x509) {
  20278. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  20279. if (subject) {
  20280. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  20281. if (name_str) {
  20282. names.push_back(name_str);
  20283. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  20284. }
  20285. }
  20286. wolfSSL_X509_free(x509);
  20287. }
  20288. pos = end_pos;
  20289. }
  20290. return names;
  20291. }
  20292. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  20293. const char *key_pem, const char *password) {
  20294. if (!ctx || !cert_pem || !key_pem) { return false; }
  20295. // Try the pair on a scratch context first, so that a bad one leaves the
  20296. // server's certificate and key as they were
  20297. auto tmp = create_server_context();
  20298. if (!tmp) { return false; }
  20299. auto se = detail::scope_exit([&] { free_context(tmp); });
  20300. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  20301. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  20302. }
  20303. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  20304. if (!ctx || !ca_pem) { return false; }
  20305. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20306. // Replace the CAs rather than add to them, as the other backends do, once
  20307. // the new ones are known to load
  20308. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  20309. if (!store) { return false; }
  20310. free_ca_store(store);
  20311. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  20312. wctx->ca_pem_data_.clear();
  20313. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  20314. }
  20315. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  20316. if (!ctx) { return false; }
  20317. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20318. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  20319. : nullptr;
  20320. {
  20321. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  20322. // A handshake running the previous callback keeps it until it returns.
  20323. wctx->verify_callback.swap(stored);
  20324. }
  20325. impl::apply_verify_mode(*wctx);
  20326. return true;
  20327. }
  20328. inline long get_verify_error(const_session_t session) {
  20329. if (!session) { return -1; }
  20330. auto *wsession =
  20331. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20332. return wolfSSL_get_verify_result(wsession->ssl);
  20333. }
  20334. inline std::string verify_error_string(long error_code) {
  20335. if (error_code == 0) { return ""; }
  20336. const char *str =
  20337. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  20338. return str ? std::string(str) : std::string();
  20339. }
  20340. } // namespace tls
  20341. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  20342. // WebSocket implementation
  20343. namespace ws {
  20344. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  20345. bool fin) {
  20346. std::lock_guard<std::mutex> lock(write_mutex_);
  20347. if (closed_) { return false; }
  20348. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  20349. }
  20350. inline ReadResult WebSocket::read(std::string &msg) {
  20351. // Answers a control frame; any other opcode here is a protocol error.
  20352. // Returns false when the connection is done.
  20353. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  20354. switch (op) {
  20355. case Opcode::Ping: {
  20356. std::lock_guard<std::mutex> lock(write_mutex_);
  20357. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  20358. payload.size(), true, !is_server_);
  20359. return true;
  20360. }
  20361. case Opcode::Pong: {
  20362. std::lock_guard<std::mutex> lock(ping_mutex_);
  20363. unacked_pings_ = 0;
  20364. return true;
  20365. }
  20366. case Opcode::Close: {
  20367. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  20368. // malformed, which is answered with a protocol error instead.
  20369. if (closed_.exchange(true)) { return false; }
  20370. auto reply = payload;
  20371. if (!impl::is_valid_close_payload(payload)) {
  20372. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  20373. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  20374. }
  20375. std::lock_guard<std::mutex> lock(write_mutex_);
  20376. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  20377. reply.size(), true, !is_server_);
  20378. return false;
  20379. }
  20380. default: closed_ = true; return false;
  20381. }
  20382. };
  20383. std::unique_lock<std::mutex> read_lock(read_mutex_);
  20384. // A server going down closes the connection rather than wait on it: its
  20385. // listen() waits for this handler to return.
  20386. auto going_away = [&]() -> ReadResult {
  20387. read_lock.unlock();
  20388. close(CloseStatus::GoingAway, "server stopping");
  20389. return Fail;
  20390. };
  20391. while (!closed_) {
  20392. Opcode opcode;
  20393. std::string payload;
  20394. bool fin;
  20395. impl::FrameRead r =
  20396. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  20397. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  20398. if (r != impl::FrameRead::Ok && server_stopping()) { return going_away(); }
  20399. // A timeout landed on a frame boundary of an open connection: it is
  20400. // untouched and still usable, so hand control back without closing it.
  20401. // That is only useful to a caller who asked for the timeout; the
  20402. // compile-time default is a backstop against a peer gone quiet, and
  20403. // elapsing it closes the connection so a plain `while (ws.read(msg))` loop
  20404. // ends. A wait that a pong timeout cut short finds the connection closed.
  20405. if (r == impl::FrameRead::Timeout && read_timeout_set_ && !closed_) {
  20406. return Timeout;
  20407. }
  20408. if (r != impl::FrameRead::Ok) {
  20409. closed_ = true;
  20410. return Fail;
  20411. }
  20412. switch (opcode) {
  20413. case Opcode::Text:
  20414. case Opcode::Binary: {
  20415. auto result = opcode == Opcode::Text ? Text : Binary;
  20416. msg = std::move(payload);
  20417. // Handle fragmentation
  20418. if (!fin) {
  20419. while (true) {
  20420. // As in the loop over frames above, close() ends the read even while
  20421. // the peer keeps sending fragments
  20422. if (closed_) { return Fail; }
  20423. Opcode cont_opcode;
  20424. std::string cont_payload;
  20425. bool cont_fin;
  20426. // Only what is left of the limit, but room for a control frame,
  20427. // which may come between the fragments.
  20428. auto max_len =
  20429. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  20430. ? size_t(0)
  20431. : (std::max)(size_t(125),
  20432. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  20433. msg.size());
  20434. // A timeout is not reportable here: half of a fragmented message is
  20435. // already in `msg` and read() has no way to resume it, so it is a
  20436. // failure like any other. Timeouts are only ever seen on a message
  20437. // boundary.
  20438. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  20439. cont_fin, is_server_,
  20440. max_len) != impl::FrameRead::Ok) {
  20441. if (server_stopping()) { return going_away(); }
  20442. closed_ = true;
  20443. return Fail;
  20444. }
  20445. // RFC 6455 5.4: the fragments are continuation frames, with only
  20446. // control frames between them.
  20447. if (cont_opcode != Opcode::Continuation) {
  20448. if (handle_control(cont_opcode, cont_payload)) { continue; }
  20449. return Fail;
  20450. }
  20451. msg += cont_payload;
  20452. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  20453. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  20454. closed_ = true;
  20455. return Fail;
  20456. }
  20457. if (cont_fin) { break; }
  20458. }
  20459. }
  20460. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  20461. if (result == Text && !impl::is_valid_utf8(msg)) {
  20462. // close() takes the read lock to wait for the peer's Close reply, so
  20463. // it must not run while this thread still holds it.
  20464. read_lock.unlock();
  20465. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  20466. return Fail;
  20467. }
  20468. return result;
  20469. }
  20470. default:
  20471. if (handle_control(opcode, payload)) { continue; }
  20472. return Fail;
  20473. }
  20474. }
  20475. return Fail;
  20476. }
  20477. inline bool WebSocket::send(const std::string &data) {
  20478. return send_frame(Opcode::Text, data.data(), data.size());
  20479. }
  20480. inline bool WebSocket::send(const char *data, size_t len) {
  20481. return send_frame(Opcode::Binary, data, len);
  20482. }
  20483. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  20484. if (closed_.exchange(true)) { return; }
  20485. ping_cv_.notify_all();
  20486. std::string payload;
  20487. auto code = static_cast<uint16_t>(status);
  20488. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  20489. payload.push_back(static_cast<char>(code & 0xFF));
  20490. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  20491. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  20492. // cut back to a whole UTF-8 character
  20493. auto short_reason = reason.substr(0, 123);
  20494. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  20495. short_reason.pop_back();
  20496. }
  20497. payload += short_reason;
  20498. // A code that may not be sent, such as NoStatus, goes without a payload
  20499. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  20500. {
  20501. std::lock_guard<std::mutex> lock(write_mutex_);
  20502. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  20503. payload.size(), true, !is_server_);
  20504. }
  20505. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  20506. // Close response before closing the TCP connection.
  20507. //
  20508. // Wait only when no other thread is parsing frames. When one is, it is the
  20509. // thread positioned to see the peer's reply, and reading here would take
  20510. // bytes out of the message it is assembling. Bailing out also leaves the
  20511. // stream, including its read timeout, entirely to that thread.
  20512. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  20513. if (!read_lock.owns_lock()) { return; }
  20514. // A max timeout turns a negative (unbounded) read timeout into 0
  20515. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20516. strm_.set_max_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND * 1000);
  20517. // The max timeout cuts a trickled frame short, the deadline a frame flood
  20518. auto deadline =
  20519. detail::deadline_after(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20520. Opcode op;
  20521. std::string resp;
  20522. bool fin;
  20523. while (std::chrono::steady_clock::now() < deadline &&
  20524. impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  20525. impl::FrameRead::Ok) {
  20526. if (op == Opcode::Close) { break; }
  20527. }
  20528. }
  20529. inline WebSocket::~WebSocket() {
  20530. {
  20531. std::lock_guard<std::mutex> lock(ping_mutex_);
  20532. closed_ = true;
  20533. }
  20534. ping_cv_.notify_all();
  20535. if (ping_thread_.joinable()) { ping_thread_.join(); }
  20536. // A server's stream outlives this object
  20537. strm_.set_read_interrupt(nullptr);
  20538. }
  20539. // A pong timeout ends a read() blocked on the silent peer, and so does the
  20540. // server stopping: its listen() waits for every handler to return.
  20541. inline void WebSocket::interrupt_reads() {
  20542. auto watches_pongs = ping_interval_sec_ > 0 && max_missed_pongs_ > 0;
  20543. if (!watches_pongs && !server_stopping_) { return; }
  20544. strm_.set_read_interrupt(
  20545. [this] { return pong_timed_out_.load() || server_stopping(); });
  20546. }
  20547. inline void WebSocket::start_heartbeat() {
  20548. if (ping_interval_sec_ <= 0) { return; }
  20549. ping_thread_ = std::thread([this]() {
  20550. std::unique_lock<std::mutex> lock(ping_mutex_);
  20551. // The predicate keeps a spurious wakeup from sending a ping early
  20552. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  20553. [this]() { return closed_.load(); })) {
  20554. // If the peer has failed to respond to the previous pings, give up.
  20555. // RFC 6455 does not define a pong-timeout mechanism; this is an
  20556. // opt-in liveness check controlled by max_missed_pongs_.
  20557. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  20558. lock.unlock();
  20559. close(CloseStatus::GoingAway, "pong timeout");
  20560. pong_timed_out_ = true;
  20561. return;
  20562. }
  20563. lock.unlock();
  20564. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  20565. lock.lock();
  20566. closed_ = true;
  20567. break;
  20568. }
  20569. lock.lock();
  20570. unacked_pings_++;
  20571. }
  20572. });
  20573. }
  20574. inline const Request &WebSocket::request() const { return req_; }
  20575. inline bool WebSocket::is_open() const { return !closed_; }
  20576. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  20577. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  20578. // poll(), where 0 would instead mean "return immediately", so hand it the
  20579. // negative poll uses for an unbounded wait.
  20580. if (sec == 0 && usec == 0) { sec = -1; }
  20581. strm_.set_read_timeout(sec, usec);
  20582. read_timeout_set_ = true;
  20583. }
  20584. // WebSocketClient implementation
  20585. inline WebSocketClient::WebSocketClient(
  20586. const std::string &scheme_host_port_path, const Headers &headers)
  20587. : headers_(headers) {
  20588. detail::UrlComponents uc;
  20589. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  20590. !uc.host.empty() && !uc.path.empty()) {
  20591. auto &scheme = uc.scheme;
  20592. #ifdef CPPHTTPLIB_SSL_ENABLED
  20593. if (scheme != "ws" && scheme != "wss") {
  20594. #else
  20595. if (scheme != "ws") {
  20596. #endif
  20597. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  20598. std::string msg = "'" + scheme + "' scheme is not supported.";
  20599. throw std::invalid_argument(msg);
  20600. #endif
  20601. return;
  20602. }
  20603. auto is_ssl = scheme == "wss";
  20604. host_ = std::move(uc.host);
  20605. port_ = is_ssl ? 443 : 80;
  20606. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  20607. path_ = std::move(uc.path);
  20608. if (!uc.query.empty()) { path_ += uc.query; }
  20609. #ifdef CPPHTTPLIB_SSL_ENABLED
  20610. is_ssl_ = is_ssl;
  20611. if (is_ssl_) {
  20612. // The context lives as long as the client so that CA configuration
  20613. // survives reconnects; sessions are created per connection.
  20614. tls_ctx_ = tls::create_client_context();
  20615. if (!tls_ctx_) { return; }
  20616. }
  20617. #else
  20618. if (is_ssl) { return; }
  20619. #endif
  20620. is_valid_ = true;
  20621. }
  20622. }
  20623. #ifdef CPPHTTPLIB_SSL_ENABLED
  20624. inline WebSocketClient::WebSocketClient(
  20625. const std::string &scheme_host_port_path, const PemMemory &pem,
  20626. const Headers &headers)
  20627. : WebSocketClient(scheme_host_port_path, headers) {
  20628. // For ws:// URLs the client certificate is silently ignored, consistent
  20629. // with the TLS-only setters such as set_ca_cert_path().
  20630. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  20631. std::string cert_buf, key_buf;
  20632. if (!tls::set_client_cert_pem(
  20633. tls_ctx_,
  20634. detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  20635. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  20636. pem.private_key_password)) {
  20637. tls::free_context(tls_ctx_);
  20638. tls_ctx_ = nullptr;
  20639. is_valid_ = false;
  20640. }
  20641. }
  20642. }
  20643. #endif
  20644. inline WebSocketClient::~WebSocketClient() {
  20645. shutdown_and_close();
  20646. #ifdef CPPHTTPLIB_SSL_ENABLED
  20647. if (tls_ctx_) {
  20648. tls::free_context(tls_ctx_);
  20649. tls_ctx_ = nullptr;
  20650. }
  20651. #endif
  20652. }
  20653. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  20654. inline void WebSocketClient::shutdown_and_close() {
  20655. // Send the close frame while the TLS session is still alive: ws_ holds an
  20656. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  20657. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  20658. if (ws_ && ws_->is_open()) { ws_->close(); }
  20659. ws_.reset();
  20660. #ifdef CPPHTTPLIB_SSL_ENABLED
  20661. if (is_ssl_) {
  20662. if (tls_session_) {
  20663. tls::shutdown(tls_session_, true);
  20664. tls::free_session(tls_session_);
  20665. tls_session_ = nullptr;
  20666. }
  20667. }
  20668. #endif
  20669. if (sock_ != INVALID_SOCKET) {
  20670. detail::shutdown_socket(sock_);
  20671. detail::close_socket(sock_);
  20672. sock_ = INVALID_SOCKET;
  20673. }
  20674. }
  20675. // The handshakes belong to establishing the connection, so an unset read
  20676. // timeout leaves them bounded by the connection timeout instead of forever.
  20677. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  20678. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  20679. return {connection_timeout_sec_, connection_timeout_usec_};
  20680. }
  20681. return {read_timeout_sec_, read_timeout_usec_};
  20682. }
  20683. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  20684. Error &error, int &ssl_error,
  20685. uint64_t &ssl_backend_error) {
  20686. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  20687. // The streams wait with poll(), where 0 instead means "return immediately",
  20688. // so they are given the negative poll uses for an unbounded wait.
  20689. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  20690. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  20691. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  20692. #ifdef CPPHTTPLIB_SSL_ENABLED
  20693. if (is_ssl_) {
  20694. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  20695. // is not safe to call concurrently on one client to begin with, since
  20696. // nothing else here is guarded either.
  20697. if (server_certificate_verification_ && !certs_loaded_) {
  20698. uint64_t backend_error = 0;
  20699. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  20700. ca_cert_dir_path_, custom_ca_loaded_,
  20701. system_ca_mode_, backend_error);
  20702. certs_loaded_ = true;
  20703. }
  20704. detail::ClientTlsSessionOptions options;
  20705. options.server_hostname_verification = server_hostname_verification_;
  20706. options.session_verifier = session_verifier_;
  20707. auto timeout = handshake_timeout();
  20708. detail::ClientTlsSessionError tls_error;
  20709. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  20710. server_certificate_verification_,
  20711. timeout.first, timeout.second,
  20712. &tls_error, options)) {
  20713. error = tls_error.error;
  20714. ssl_error = tls_error.ssl_error;
  20715. ssl_backend_error = tls_error.backend_error;
  20716. return false;
  20717. }
  20718. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  20719. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  20720. write_timeout_usec_));
  20721. return true;
  20722. }
  20723. #else
  20724. (void)error;
  20725. (void)ssl_error;
  20726. (void)ssl_backend_error;
  20727. #endif
  20728. strm = std::unique_ptr<Stream>(
  20729. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20730. write_timeout_sec_, write_timeout_usec_));
  20731. return true;
  20732. }
  20733. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20734. #ifdef CPPHTTPLIB_SSL_ENABLED
  20735. auto is_ssl = is_ssl_;
  20736. #else
  20737. auto is_ssl = false;
  20738. #endif
  20739. if (!req.has_header("Host")) {
  20740. req.headers.emplace("Host", detail::make_default_host_header_value(
  20741. host_, port_, is_ssl, address_family_));
  20742. }
  20743. detail::add_default_user_agent_header(req);
  20744. detail::add_authorization_header(req, basic_auth_username_,
  20745. basic_auth_password_,
  20746. bearer_token_auth_token_, false);
  20747. }
  20748. inline Result WebSocketClient::connect() {
  20749. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20750. shutdown_and_close();
  20751. auto error = Error::Success;
  20752. if (!create_and_connect_socket(error)) {
  20753. return Result{error, -1, Headers{}};
  20754. }
  20755. if (is_proxy_enabled()) {
  20756. Response proxy_res;
  20757. if (!connect_with_proxy(proxy_res, error)) {
  20758. shutdown_and_close();
  20759. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  20760. }
  20761. }
  20762. std::unique_ptr<Stream> strm;
  20763. auto stream_error = Error::SSLConnection;
  20764. int ssl_error = 0;
  20765. uint64_t ssl_backend_error = 0;
  20766. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20767. shutdown_and_close();
  20768. #ifdef CPPHTTPLIB_SSL_ENABLED
  20769. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20770. #else
  20771. return Result{stream_error, -1, Headers{}};
  20772. #endif
  20773. }
  20774. Request req;
  20775. req.method = "GET";
  20776. req.path = path_;
  20777. req.headers = headers_;
  20778. prepare_default_headers(req);
  20779. detail::WebSocketUpgradeResponse upgrade;
  20780. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20781. shutdown_and_close();
  20782. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20783. }
  20784. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20785. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20786. websocket_ping_interval_sec_,
  20787. websocket_max_missed_pongs_));
  20788. // The stream was created with the timeout already; tell the WebSocket
  20789. // whether it came from the caller, so read() knows to report it as Timeout.
  20790. ws_->read_timeout_set_ = read_timeout_set_;
  20791. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20792. }
  20793. inline ReadResult WebSocketClient::read(std::string &msg) {
  20794. if (!ws_) { return Fail; }
  20795. return ws_->read(msg);
  20796. }
  20797. inline bool WebSocketClient::send(const std::string &data) {
  20798. if (!ws_) { return false; }
  20799. return ws_->send(data);
  20800. }
  20801. inline bool WebSocketClient::send(const char *data, size_t len) {
  20802. if (!ws_) { return false; }
  20803. return ws_->send(data, len);
  20804. }
  20805. inline void WebSocketClient::close(CloseStatus status,
  20806. const std::string &reason) {
  20807. if (ws_) { ws_->close(status, reason); }
  20808. }
  20809. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20810. inline const std::string &WebSocketClient::subprotocol() const {
  20811. return subprotocol_;
  20812. }
  20813. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20814. read_timeout_sec_ = sec;
  20815. read_timeout_usec_ = usec;
  20816. read_timeout_set_ = true;
  20817. // The members above only seed the next connect(); read() consults the
  20818. // stream, so an already-open connection has to be told directly.
  20819. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20820. }
  20821. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20822. write_timeout_sec_ = sec;
  20823. write_timeout_usec_ = usec;
  20824. }
  20825. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20826. websocket_ping_interval_sec_ = sec;
  20827. }
  20828. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20829. websocket_max_missed_pongs_ = count;
  20830. }
  20831. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20832. inline void WebSocketClient::set_address_family(int family) {
  20833. address_family_ = family;
  20834. }
  20835. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20836. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20837. socket_options_ = std::move(socket_options);
  20838. }
  20839. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20840. connection_timeout_sec_ = sec;
  20841. connection_timeout_usec_ = usec;
  20842. }
  20843. inline void WebSocketClient::set_interface(const std::string &intf) {
  20844. interface_ = intf;
  20845. }
  20846. inline void WebSocketClient::set_hostname_addr_map(
  20847. std::map<std::string, std::string> addr_map) {
  20848. set_direct_hostname_addr_map(std::move(addr_map));
  20849. }
  20850. inline void WebSocketClient::set_direct_hostname_addr_map(
  20851. std::map<std::string, std::string> addr_map) {
  20852. addr_map_ = std::move(addr_map);
  20853. }
  20854. inline void WebSocketClient::set_tunnel_hostname_addr_map(
  20855. std::map<std::string, std::string> addr_map) {
  20856. tunnel_addr_map_ = std::move(addr_map);
  20857. }
  20858. inline bool WebSocketClient::is_proxy_enabled() const {
  20859. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  20860. if (no_proxy_entries_.empty()) { return true; }
  20861. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  20862. no_proxy_entries_);
  20863. }
  20864. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  20865. std::string connect_host;
  20866. std::string ip;
  20867. auto port = port_;
  20868. if (is_proxy_enabled()) {
  20869. connect_host = proxy_host_;
  20870. port = proxy_port_;
  20871. } else {
  20872. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20873. }
  20874. sock_ = detail::create_client_socket(
  20875. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  20876. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20877. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20878. write_timeout_usec_, interface_, error);
  20879. if (sock_ != INVALID_SOCKET) { return true; }
  20880. if (error == Error::Success) { error = Error::Connection; }
  20881. return false;
  20882. }
  20883. inline bool WebSocketClient::send_proxy_connect(Request &req,
  20884. Response &proxy_res,
  20885. Error &error) {
  20886. auto timeout = handshake_timeout();
  20887. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  20888. write_timeout_sec_, write_timeout_usec_);
  20889. if (!detail::write_request_head(strm, req, error)) { return false; }
  20890. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  20891. error = Error::Read;
  20892. return false;
  20893. }
  20894. return true;
  20895. }
  20896. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  20897. // forward an Upgrade request.
  20898. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  20899. Error &error) {
  20900. Request req;
  20901. req.method = "CONNECT";
  20902. req.path =
  20903. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  20904. req.headers.emplace("Host", req.path);
  20905. detail::add_default_user_agent_header(req);
  20906. detail::add_authorization_header(req, proxy_basic_auth_username_,
  20907. proxy_basic_auth_password_,
  20908. proxy_bearer_token_auth_token_, true);
  20909. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20910. #ifdef CPPHTTPLIB_SSL_ENABLED
  20911. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  20912. std::map<std::string, std::string> auth;
  20913. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  20914. !proxy_digest_auth_username_.empty() &&
  20915. !proxy_digest_auth_password_.empty() &&
  20916. detail::parse_www_authenticate(proxy_res, auth, true)) {
  20917. proxy_res = Response();
  20918. shutdown_and_close();
  20919. if (!create_and_connect_socket(error)) { return false; }
  20920. req.headers.erase("Proxy-Authorization");
  20921. req.headers.insert(detail::make_digest_authentication_header(
  20922. req, req.path, auth, 1, detail::random_string(10),
  20923. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  20924. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20925. }
  20926. #endif
  20927. if (proxy_res.status != StatusCode::OK_200) {
  20928. error = Error::ProxyConnection;
  20929. return false;
  20930. }
  20931. return true;
  20932. }
  20933. inline void WebSocketClient::set_basic_auth(const std::string &username,
  20934. const std::string &password) {
  20935. basic_auth_username_ = username;
  20936. basic_auth_password_ = password;
  20937. }
  20938. inline void WebSocketClient::set_bearer_token_auth(const std::string &token) {
  20939. bearer_token_auth_token_ = token;
  20940. }
  20941. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  20942. proxy_host_ = host;
  20943. proxy_port_ = port;
  20944. }
  20945. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  20946. const std::string &password) {
  20947. proxy_basic_auth_username_ = username;
  20948. proxy_basic_auth_password_ = password;
  20949. }
  20950. inline void
  20951. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  20952. proxy_bearer_token_auth_token_ = token;
  20953. }
  20954. inline void
  20955. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  20956. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  20957. }
  20958. #ifdef CPPHTTPLIB_SSL_ENABLED
  20959. inline void
  20960. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20961. const std::string &ca_cert_dir_path) {
  20962. ca_cert_file_path_ = ca_cert_file_path;
  20963. ca_cert_dir_path_ = ca_cert_dir_path;
  20964. }
  20965. inline void
  20966. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  20967. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  20968. }
  20969. inline void WebSocketClient::set_session_verifier(
  20970. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  20971. session_verifier_ = std::move(verifier);
  20972. }
  20973. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20974. if (store && tls_ctx_) {
  20975. // set_ca_store takes ownership of store
  20976. tls::set_ca_store(tls_ctx_, store);
  20977. } else if (store) {
  20978. tls::free_ca_store(store);
  20979. }
  20980. custom_ca_loaded_ = true;
  20981. }
  20982. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20983. std::size_t size) {
  20984. if (tls_ctx_ && ca_cert && size > 0) {
  20985. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20986. }
  20987. custom_ca_loaded_ = true;
  20988. }
  20989. inline void
  20990. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20991. server_certificate_verification_ = enabled;
  20992. }
  20993. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20994. server_hostname_verification_ = enabled;
  20995. }
  20996. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20997. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20998. }
  20999. inline void
  21000. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  21001. const std::string &password) {
  21002. proxy_digest_auth_username_ = username;
  21003. proxy_digest_auth_password_ = password;
  21004. }
  21005. #endif // CPPHTTPLIB_SSL_ENABLED
  21006. } // namespace ws
  21007. // ----------------------------------------------------------------------------
  21008. } // namespace httplib
  21009. #endif // CPPHTTPLIB_HTTPLIB_H