httplib.h 849 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561
  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.66.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x004200"
  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. detail::UrlComponents uc;
  14132. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  14133. uc)) {
  14134. return false;
  14135. }
  14136. // Only follow http/https redirects
  14137. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  14138. return false;
  14139. }
  14140. auto scheme = is_ssl() ? "https" : "http";
  14141. auto next_scheme = std::move(uc.scheme);
  14142. auto next_host = std::move(uc.host);
  14143. auto port_str = std::move(uc.port);
  14144. auto next_path = std::move(uc.path);
  14145. auto next_query = std::move(uc.query);
  14146. auto next_port = port_;
  14147. if (!port_str.empty()) {
  14148. if (!detail::parse_port(port_str, next_port)) { return false; }
  14149. } else if (!next_scheme.empty()) {
  14150. next_port = next_scheme == "https" ? 443 : 80;
  14151. }
  14152. if (next_scheme.empty()) { next_scheme = scheme; }
  14153. if (next_host.empty()) { next_host = host_; }
  14154. if (next_path.empty()) { next_path = "/"; }
  14155. // An absolute or absolute-path location can have dot segments too.
  14156. if (next_path[0] == '/') {
  14157. next_path = detail::remove_dot_segments(next_path);
  14158. }
  14159. auto path = std::move(next_path) + next_query;
  14160. // A Unix socket client sends "Host: localhost", so a Location naming
  14161. // localhost names this client too.
  14162. auto is_same_host = next_host == host_ ||
  14163. (address_family_ == AF_UNIX && next_host == "localhost");
  14164. // Same host redirect - use current client
  14165. if (next_scheme == scheme && is_same_host && next_port == port_) {
  14166. return detail::redirect(*this, req, res, path, location, error);
  14167. }
  14168. // Cross-host/scheme redirect - create new client with robust setup
  14169. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  14170. path, location, error);
  14171. }
  14172. // New method for robust redirect client creation
  14173. inline bool ClientImpl::create_redirect_client(
  14174. const std::string &scheme, const std::string &host, int port, Request &req,
  14175. Response &res, const std::string &path, const std::string &location,
  14176. Error &error) {
  14177. // Determine if we need SSL
  14178. auto need_ssl = (scheme == "https");
  14179. // Clean up request headers that are host/client specific
  14180. // Remove headers that should not be carried over to new host
  14181. auto headers_to_remove = std::vector<std::string>{
  14182. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  14183. for (const auto &header_name : headers_to_remove) {
  14184. auto it = req.headers.find(header_name);
  14185. while (it != req.headers.end()) {
  14186. it = req.headers.erase(it);
  14187. it = req.headers.find(header_name);
  14188. }
  14189. }
  14190. // Create appropriate client type and handle redirect
  14191. if (need_ssl) {
  14192. #ifdef CPPHTTPLIB_SSL_ENABLED
  14193. // Create SSL client for HTTPS redirect
  14194. SSLClient redirect_client(host, port);
  14195. // Setup basic client configuration first
  14196. setup_redirect_client(redirect_client);
  14197. redirect_client.enable_server_certificate_verification(
  14198. server_certificate_verification_);
  14199. redirect_client.enable_server_hostname_verification(
  14200. server_hostname_verification_);
  14201. redirect_client.system_ca_mode_ = system_ca_mode_;
  14202. // Transfer CA certificate to redirect client
  14203. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  14204. if (is_ssl()) {
  14205. auto &self = static_cast<SSLClient &>(*this);
  14206. // A store given to set_ca_cert_store() lives only in this client's
  14207. // context, which then holds all that is trusted.
  14208. if (self.ca_cert_store_set_) {
  14209. std::string pem;
  14210. {
  14211. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  14212. pem = detail::ca_certs_to_pem(self.ctx_);
  14213. }
  14214. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  14215. redirect_client.ca_cert_store_set_ = true;
  14216. } else if (self.custom_ca_loaded_) {
  14217. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  14218. ca_cert_pem_.size());
  14219. }
  14220. redirect_client.set_session_verifier(self.session_verifier_);
  14221. if (self.server_certificate_verifier_) {
  14222. redirect_client.set_server_certificate_verifier(
  14223. self.server_certificate_verifier_);
  14224. }
  14225. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  14226. redirect_client.enable_windows_cert_verification_ =
  14227. self.enable_windows_cert_verification_;
  14228. #endif
  14229. }
  14230. // Client certificates are set through constructor for SSLClient
  14231. // NOTE: SSLClient constructor already takes client_cert_path and
  14232. // client_key_path so we need to create it properly if client certs are
  14233. // needed
  14234. // Execute the redirect
  14235. return detail::redirect(redirect_client, req, res, path, location, error);
  14236. #else
  14237. // SSL not supported - set appropriate error
  14238. error = Error::SSLConnection;
  14239. return false;
  14240. #endif
  14241. } else {
  14242. // HTTP redirect
  14243. ClientImpl redirect_client(host, port);
  14244. // Setup client with robust configuration
  14245. setup_redirect_client(redirect_client);
  14246. // Execute the redirect
  14247. return detail::redirect(redirect_client, req, res, path, location, error);
  14248. }
  14249. }
  14250. // New method for robust client setup (based on basic_manual_redirect.cpp
  14251. // logic)
  14252. template <typename ClientType>
  14253. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  14254. // Copy basic settings first
  14255. client.set_connection_timeout(connection_timeout_sec_,
  14256. connection_timeout_usec_);
  14257. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14258. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  14259. client.set_max_timeout(max_timeout_msec_);
  14260. if (has_payload_max_length_) {
  14261. client.set_payload_max_length(payload_max_length_);
  14262. }
  14263. client.set_keep_alive(keep_alive_);
  14264. client.set_follow_location(
  14265. true); // Enable redirects to handle multi-step redirects
  14266. client.set_path_encode(path_encode_);
  14267. client.set_compress(compress_);
  14268. client.set_decompress(decompress_);
  14269. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  14270. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  14271. // 15.4, credentials must not be forwarded when redirecting to a different
  14272. // host. This function is only called for cross-host redirects; same-host
  14273. // redirects are handled directly in ClientImpl::redirect().
  14274. // Copy the proxy configuration unconditionally; the per-target bypass is
  14275. // re-evaluated at send time, so a later hop to a non-bypassed host can
  14276. // still use the proxy.
  14277. client.no_proxy_entries_ = no_proxy_entries_;
  14278. if (!proxy_host_.empty() && proxy_port_ != -1) {
  14279. client.set_proxy(proxy_host_, proxy_port_);
  14280. if (!proxy_basic_auth_username_.empty() ||
  14281. !proxy_basic_auth_password_.empty()) {
  14282. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  14283. proxy_basic_auth_password_);
  14284. }
  14285. if (!proxy_bearer_token_auth_token_.empty()) {
  14286. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  14287. }
  14288. #ifdef CPPHTTPLIB_SSL_ENABLED
  14289. if (!proxy_digest_auth_username_.empty()) {
  14290. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  14291. proxy_digest_auth_password_);
  14292. }
  14293. #endif
  14294. }
  14295. // Copy network and socket settings
  14296. client.addr_map_ = addr_map_;
  14297. client.tunnel_addr_map_ = tunnel_addr_map_;
  14298. // A Unix socket client reaches every host through its own socket, as curl's
  14299. // --unix-socket does, unless the caller mapped that host elsewhere. The
  14300. // Location's host is never taken as a socket path.
  14301. if (address_family_ == AF_UNIX) {
  14302. auto &target = client.addr_map_[client.host()];
  14303. if (target.empty()) { target = detail::addr_map_target(addr_map_, host_); }
  14304. }
  14305. client.set_address_family(address_family_);
  14306. client.set_tcp_nodelay(tcp_nodelay_);
  14307. client.set_ipv6_v6only(ipv6_v6only_);
  14308. if (socket_options_) { client.set_socket_options(socket_options_); }
  14309. if (!interface_.empty()) { client.set_interface(interface_); }
  14310. // Copy logging and headers. Not the error logger: a failure comes back to
  14311. // this client's send(), which reports it with the caller's request.
  14312. if (logger_) { client.set_logger(logger_); }
  14313. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  14314. // Each new client should generate its own headers based on its target host
  14315. }
  14316. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  14317. const Request &req,
  14318. Error &error) const {
  14319. auto is_shutting_down = []() { return false; };
  14320. if (req.is_chunked_content_provider_) {
  14321. auto compressor = compress_ ? detail::create_compressor().first
  14322. : std::unique_ptr<detail::compressor>();
  14323. if (!compressor) {
  14324. compressor = detail::make_unique<detail::nocompressor>();
  14325. }
  14326. return detail::write_content_chunked(strm, req.content_provider_,
  14327. is_shutting_down, *compressor, error);
  14328. } else {
  14329. return detail::write_content_with_progress(
  14330. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  14331. req.upload_progress, error);
  14332. }
  14333. }
  14334. // What goes on the request line for req: its path, encoded and without the
  14335. // fragment, with `req.params` as the query when the path has none.
  14336. inline std::string ClientImpl::make_request_target(const Request &req) const {
  14337. auto target = detail::encode_request_target(req.path, path_encode_);
  14338. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  14339. target = append_query_params(target, req.params);
  14340. }
  14341. return target;
  14342. }
  14343. inline void ClientImpl::add_credential_headers(Request &req) {
  14344. // A CONNECT request is read by the proxy; everything sent through the tunnel
  14345. // it opens is read by the origin. Each credential goes only to its own hop.
  14346. auto is_connect = req.method == "CONNECT";
  14347. if (!is_connect) {
  14348. detail::add_authorization_header(req, basic_auth_username_,
  14349. basic_auth_password_,
  14350. bearer_token_auth_token_, false);
  14351. }
  14352. // Proxy-Authorization is only sent when the proxy reads this message —
  14353. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  14354. // would leak proxy credentials to the destination server.
  14355. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  14356. detail::add_authorization_header(req, proxy_basic_auth_username_,
  14357. proxy_basic_auth_password_,
  14358. proxy_bearer_token_auth_token_, true);
  14359. }
  14360. }
  14361. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  14362. bool close_connection, Error &error,
  14363. bool skip_body, bool &rejected_locally) {
  14364. rejected_locally = false;
  14365. // Prepare additional headers
  14366. if (close_connection) {
  14367. if (!req.has_header("Connection")) {
  14368. req.set_header("Connection", "close");
  14369. }
  14370. }
  14371. std::string ct_for_defaults;
  14372. if (!req.has_header("Content-Type") && !req.body.empty()) {
  14373. ct_for_defaults = "text/plain";
  14374. }
  14375. prepare_default_headers(req, false, ct_for_defaults);
  14376. if (req.body.empty()) {
  14377. if (req.content_provider_) {
  14378. if (!req.is_chunked_content_provider_) {
  14379. if (!req.has_header("Content-Length")) {
  14380. auto length = std::to_string(req.content_length_);
  14381. req.set_header("Content-Length", length);
  14382. }
  14383. }
  14384. } else {
  14385. if (req.method == "POST" || req.method == "PUT" ||
  14386. req.method == "PATCH") {
  14387. req.set_header("Content-Length", "0");
  14388. }
  14389. }
  14390. }
  14391. add_credential_headers(req);
  14392. // Request line and headers
  14393. {
  14394. detail::BufferStream bstrm;
  14395. auto path_with_query = make_request_target(req);
  14396. // The query already came in through `req.path`; still populate
  14397. // `req.params` for handlers/users who read them.
  14398. auto query_part = detail::query_of(req.path);
  14399. if (!query_part.empty()) {
  14400. detail::parse_query_text(query_part, req.params);
  14401. }
  14402. // Write request line and headers
  14403. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  14404. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  14405. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  14406. // fail the request cleanly instead of emitting a request-line-less,
  14407. // header-injecting request.
  14408. error = Error::Write;
  14409. rejected_locally = true;
  14410. return false;
  14411. }
  14412. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14413. error)) {
  14414. rejected_locally = true;
  14415. return false;
  14416. }
  14417. // Flush buffer
  14418. auto &data = bstrm.get_buffer();
  14419. if (!detail::write_data(strm, data.data(), data.size())) {
  14420. error = Error::Write;
  14421. return false;
  14422. }
  14423. }
  14424. // After sending request line and headers, wait briefly for an early server
  14425. // response (e.g. 4xx) and avoid sending a potentially large request body
  14426. // unnecessarily. This workaround is only enabled on Windows because Unix
  14427. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  14428. // buffering can accept large writes even when the peer already responded.
  14429. // Check the stream first (which covers SSL via `is_readable()`), then
  14430. // fall back to select on the socket. Only perform the wait for very large
  14431. // request bodies to avoid interfering with normal small requests and
  14432. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  14433. // response. Skip this check when using Expect: 100-continue, as the protocol
  14434. // handles early responses properly.
  14435. #if defined(_WIN32)
  14436. if (!skip_body &&
  14437. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  14438. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  14439. auto start = std::chrono::high_resolution_clock::now();
  14440. for (;;) {
  14441. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  14442. // from SSL internals. If the underlying socket is readable, assume an
  14443. // early response may be present.
  14444. auto sock = strm.socket();
  14445. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  14446. return false;
  14447. }
  14448. // Fallback to stream-level check for non-socket streams or when the
  14449. // socket isn't reporting readable. Avoid using `is_readable()` for
  14450. // SSL, since `SSL_pending()` may report buffered records that do not
  14451. // indicate a complete application-level response yet.
  14452. if (!is_ssl() && strm.is_readable()) { return false; }
  14453. auto now = std::chrono::high_resolution_clock::now();
  14454. auto elapsed =
  14455. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  14456. .count();
  14457. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  14458. break;
  14459. }
  14460. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  14461. }
  14462. }
  14463. #endif
  14464. // Body
  14465. if (skip_body) { return true; }
  14466. return write_request_body(strm, req, error);
  14467. }
  14468. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  14469. Error &error) {
  14470. if (req.body.empty()) {
  14471. return write_content_with_provider(strm, req, error);
  14472. }
  14473. if (req.upload_progress) {
  14474. auto body_size = req.body.size();
  14475. size_t written = 0;
  14476. auto data = req.body.data();
  14477. while (written < body_size) {
  14478. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  14479. if (!detail::write_data(strm, data + written, to_write)) {
  14480. error = Error::Write;
  14481. return false;
  14482. }
  14483. written += to_write;
  14484. if (!req.upload_progress(written, body_size)) {
  14485. error = Error::Canceled;
  14486. return false;
  14487. }
  14488. }
  14489. } else {
  14490. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14491. error = Error::Write;
  14492. return false;
  14493. }
  14494. }
  14495. return true;
  14496. }
  14497. inline std::unique_ptr<Response>
  14498. ClientImpl::send_with_content_provider_and_receiver(
  14499. Request &req, const char *body, size_t content_length,
  14500. ContentProvider content_provider,
  14501. ContentProviderWithoutLength content_provider_without_length,
  14502. const std::string &content_type, ContentReceiver content_receiver,
  14503. Error &error) {
  14504. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14505. auto enc = compress_
  14506. ? detail::create_compressor()
  14507. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14508. nullptr, nullptr);
  14509. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14510. // A compressed or chunked body is framed by the library, not the caller
  14511. if (enc.second || content_provider_without_length) {
  14512. req.headers.erase("Content-Length");
  14513. }
  14514. if (enc.first && !content_provider_without_length) {
  14515. auto &compressor = enc.first;
  14516. if (content_provider) {
  14517. auto ok = true;
  14518. auto finished = false;
  14519. size_t offset = 0;
  14520. DataSink data_sink;
  14521. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14522. if (ok) {
  14523. auto last = offset + data_len == content_length;
  14524. auto ret = compressor->compress(
  14525. data, data_len, last,
  14526. [&](const char *compressed_data, size_t compressed_data_len) {
  14527. req.body.append(compressed_data, compressed_data_len);
  14528. return true;
  14529. });
  14530. if (ret) {
  14531. offset += data_len;
  14532. } else {
  14533. ok = false;
  14534. }
  14535. }
  14536. return ok;
  14537. };
  14538. // As in detail::write_content_with_progress(): the body is framed by
  14539. // content_length, so a provider that finishes early has truncated it.
  14540. // Stop and report that instead of calling the provider forever.
  14541. data_sink.done = [&]() { finished = true; };
  14542. while (ok && !finished && offset < content_length) {
  14543. if (!content_provider(offset, content_length - offset, data_sink)) {
  14544. error = Error::Canceled;
  14545. output_error_log(error, &req);
  14546. return nullptr;
  14547. }
  14548. }
  14549. // A short body here means either the provider stopped early or the
  14550. // compressor gave up. The branch below reports a failing compressor as
  14551. // Error::Compression, so keep the two distinguishable.
  14552. if (offset < content_length) {
  14553. error = ok ? Error::Write : Error::Compression;
  14554. output_error_log(error, &req);
  14555. return nullptr;
  14556. }
  14557. } else {
  14558. if (!compressor->compress(body, content_length, true,
  14559. [&](const char *data, size_t data_len) {
  14560. req.body.append(data, data_len);
  14561. return true;
  14562. })) {
  14563. error = Error::Compression;
  14564. output_error_log(error, &req);
  14565. return nullptr;
  14566. }
  14567. }
  14568. } else {
  14569. if (content_provider) {
  14570. req.content_length_ = content_length;
  14571. req.content_provider_ = std::move(content_provider);
  14572. req.is_chunked_content_provider_ = false;
  14573. } else if (content_provider_without_length) {
  14574. req.content_length_ = 0;
  14575. req.content_provider_ = detail::ContentProviderAdapter(
  14576. std::move(content_provider_without_length));
  14577. req.is_chunked_content_provider_ = true;
  14578. req.set_header("Transfer-Encoding", "chunked");
  14579. } else {
  14580. req.body.assign(body, content_length);
  14581. }
  14582. }
  14583. if (content_receiver) {
  14584. req.content_receiver =
  14585. [content_receiver](const char *data, size_t data_length,
  14586. size_t /*offset*/, size_t /*total_length*/) {
  14587. return content_receiver(data, data_length);
  14588. };
  14589. }
  14590. auto res = detail::make_unique<Response>();
  14591. return send(req, *res, error) ? std::move(res) : nullptr;
  14592. }
  14593. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14594. const std::string &method, const std::string &path, const Headers &headers,
  14595. const char *body, size_t content_length, ContentProvider content_provider,
  14596. ContentProviderWithoutLength content_provider_without_length,
  14597. const std::string &content_type, ContentReceiver content_receiver,
  14598. UploadProgress progress) {
  14599. Request req;
  14600. req.method = method;
  14601. req.headers = headers;
  14602. req.path = path;
  14603. req.upload_progress = std::move(progress);
  14604. if (max_timeout_msec_ > 0) {
  14605. req.start_time_ = std::chrono::steady_clock::now();
  14606. }
  14607. auto error = Error::Success;
  14608. #ifdef CPPHTTPLIB_SSL_ENABLED
  14609. // Hold the request lock until the Result has read this request's TLS error
  14610. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14611. #endif
  14612. auto res = send_with_content_provider_and_receiver(
  14613. req, body, content_length, std::move(content_provider),
  14614. std::move(content_provider_without_length), content_type,
  14615. std::move(content_receiver), error);
  14616. #ifdef CPPHTTPLIB_SSL_ENABLED
  14617. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14618. last_backend_error_};
  14619. #else
  14620. return Result{std::move(res), error, std::move(req.headers)};
  14621. #endif
  14622. }
  14623. inline void ClientImpl::output_log(const Request &req,
  14624. const Response &res) const {
  14625. if (logger_) {
  14626. std::lock_guard<std::mutex> guard(logger_mutex_);
  14627. logger_(req, res);
  14628. }
  14629. }
  14630. inline void ClientImpl::output_error_log(const Error &err,
  14631. const Request *req) const {
  14632. if (error_logger_) {
  14633. std::lock_guard<std::mutex> guard(logger_mutex_);
  14634. error_logger_(err, req);
  14635. }
  14636. }
  14637. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14638. Response &res, bool close_connection,
  14639. Error &error) {
  14640. // Auto-add Expect: 100-continue for large bodies
  14641. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14642. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14643. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14644. req.set_header("Expect", "100-continue");
  14645. }
  14646. }
  14647. // Check for Expect: 100-continue
  14648. auto expect_100_continue =
  14649. detail::has_header_token(req.headers, "Expect", "100-continue");
  14650. // Send request (skip body if using Expect: 100-continue)
  14651. auto rejected_locally = false;
  14652. auto write_request_success =
  14653. write_request(strm, req, close_connection, error, expect_100_continue,
  14654. rejected_locally);
  14655. // A failed write normally still reads the response below, since the server
  14656. // may have answered early (e.g. 413/414) and closed while the body was being
  14657. // sent. A request rejected before any byte reached the socket gets no such
  14658. // response, and waiting for one would block until the read timeout.
  14659. if (rejected_locally) { return false; }
  14660. #ifdef CPPHTTPLIB_SSL_ENABLED
  14661. if (is_ssl() && !expect_100_continue) {
  14662. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14663. if (!is_proxy_enabled) {
  14664. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14665. error = Error::SSLPeerCouldBeClosed_;
  14666. return false;
  14667. }
  14668. }
  14669. }
  14670. #endif
  14671. // Handle Expect: 100-continue.
  14672. //
  14673. // Wait for an interim/early response by attempting to read the status line
  14674. // under a short timeout, instead of trusting raw socket readability. Over
  14675. // TLS, post-handshake records (e.g. session tickets) make the socket
  14676. // readable without any HTTP response being available; relying on
  14677. // `select_read` there caused the body to be withheld forever and the
  14678. // request to fail with `Read` (#2458). If no status line arrives within the
  14679. // timeout, send the body anyway (matching curl's behavior).
  14680. auto status_line_read = false;
  14681. if (expect_100_continue && write_request_success) {
  14682. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14683. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14684. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14685. strm.set_read_timeout(sec, usec);
  14686. status_line_read = read_response_line(strm, req, res, false);
  14687. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14688. }
  14689. if (!status_line_read) {
  14690. // No interim response within the timeout: send the body and handle the
  14691. // response as usual.
  14692. if (!write_request_body(strm, req, error)) { return false; }
  14693. expect_100_continue = false; // Switch to normal response handling
  14694. }
  14695. }
  14696. // Receive response and headers
  14697. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14698. if ((!status_line_read &&
  14699. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14700. !detail::read_headers(strm, res.headers)) {
  14701. if (write_request_success) { error = Error::Read; }
  14702. return false;
  14703. }
  14704. if (!write_request_success) { return false; }
  14705. // Handle Expect: 100-continue response
  14706. if (expect_100_continue) {
  14707. if (res.status == StatusCode::Continue_100) {
  14708. // Server accepted, send the body
  14709. if (!write_request_body(strm, req, error)) { return false; }
  14710. // Read the actual response
  14711. res.headers.clear();
  14712. res.body.clear();
  14713. if (!read_response_line(strm, req, res) ||
  14714. !detail::read_headers(strm, res.headers)) {
  14715. error = Error::Read;
  14716. return false;
  14717. }
  14718. } else {
  14719. // A final response came first, so the body this request declared was
  14720. // never sent, and the server may still be waiting for it. The
  14721. // connection cannot carry another request.
  14722. std::lock_guard<std::mutex> guard(socket_mutex_);
  14723. socket_should_be_closed_when_request_is_done_ = true;
  14724. }
  14725. }
  14726. // Body
  14727. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14728. req.method != "CONNECT") {
  14729. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14730. // whose final transfer coding is not chunked is not ambiguous: its body
  14731. // runs until the server closes the connection, so it is not rejected.
  14732. // HEAD/204 are excluded above and a 304 carries no body.
  14733. if (res.status != StatusCode::NotModified_304) {
  14734. if (detail::has_conflicting_content_length(res.headers)) {
  14735. error = Error::Read;
  14736. return false;
  14737. }
  14738. if (detail::has_faulty_transfer_encoding(res)) {
  14739. std::lock_guard<std::mutex> guard(socket_mutex_);
  14740. socket_should_be_closed_when_request_is_done_ = true;
  14741. }
  14742. }
  14743. auto redirect = follow_location_ && detail::is_redirect(res);
  14744. if (req.response_handler && !redirect) {
  14745. if (!req.response_handler(res)) {
  14746. error = Error::Canceled;
  14747. return false;
  14748. }
  14749. }
  14750. auto out =
  14751. req.content_receiver
  14752. ? static_cast<ContentReceiverWithProgress>(
  14753. [&](const char *buf, size_t n, size_t off, size_t len) {
  14754. if (redirect) { return true; }
  14755. auto ret = req.content_receiver(buf, n, off, len);
  14756. if (!ret) { error = Error::Canceled; }
  14757. return ret;
  14758. })
  14759. : static_cast<ContentReceiverWithProgress>(
  14760. [&](const char *buf, size_t n, size_t /*off*/,
  14761. size_t /*len*/) {
  14762. assert(res.body.size() + n <= res.body.max_size());
  14763. if (payload_max_length_ > 0 &&
  14764. (res.body.size() >= payload_max_length_ ||
  14765. n > payload_max_length_ - res.body.size())) {
  14766. return false;
  14767. }
  14768. res.body.append(buf, n);
  14769. return true;
  14770. });
  14771. auto progress = [&](size_t current, size_t total) {
  14772. if (!req.download_progress || redirect) { return true; }
  14773. auto ret = req.download_progress(current, total);
  14774. if (!ret) { error = Error::Canceled; }
  14775. return ret;
  14776. };
  14777. if (res.has_header("Content-Length")) {
  14778. if (!req.content_receiver) {
  14779. auto len = res.get_header_value_u64("Content-Length");
  14780. if (len > res.body.max_size()) {
  14781. error = Error::Read;
  14782. return false;
  14783. }
  14784. // Content-Length is only the server's claim, so reserve no more than
  14785. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14786. // body has arrived. A longer body grows as it is read.
  14787. auto reserve_len =
  14788. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14789. if (payload_max_length_ > 0) {
  14790. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14791. }
  14792. res.body.reserve(reserve_len);
  14793. }
  14794. }
  14795. if (res.status != StatusCode::NotModified_304) {
  14796. auto content_status = 0;
  14797. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14798. ? (std::numeric_limits<size_t>::max)()
  14799. : payload_max_length_;
  14800. if (!detail::read_content(strm, res, max_length, content_status,
  14801. std::move(progress), std::move(out),
  14802. decompress_)) {
  14803. if (error != Error::Canceled) {
  14804. // Tell the caller apart from a plain read failure when the body was
  14805. // over the payload limit or could not be decoded because of its
  14806. // Content-Encoding.
  14807. switch (content_status) {
  14808. case StatusCode::PayloadTooLarge_413:
  14809. error = Error::ExceedMaxPayloadSize;
  14810. break;
  14811. case StatusCode::UnsupportedMediaType_415:
  14812. error = Error::UnsupportedContentEncoding;
  14813. break;
  14814. case StatusCode::InternalServerError_500:
  14815. error = Error::Compression;
  14816. break;
  14817. default: error = Error::Read; break;
  14818. }
  14819. }
  14820. return false;
  14821. }
  14822. }
  14823. }
  14824. // Log
  14825. output_log(req, res);
  14826. return true;
  14827. }
  14828. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14829. const std::string &boundary, const UploadFormDataItems &items,
  14830. const FormDataProviderItems &provider_items) const {
  14831. size_t cur_item = 0;
  14832. size_t cur_start = 0;
  14833. // cur_item and cur_start are copied to within the std::function and
  14834. // maintain state between successive calls
  14835. return [&, cur_item, cur_start](size_t offset,
  14836. DataSink &sink) mutable -> bool {
  14837. if (!offset && !items.empty()) {
  14838. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14839. return true;
  14840. } else if (cur_item < provider_items.size()) {
  14841. if (!cur_start) {
  14842. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14843. provider_items[cur_item], boundary);
  14844. offset += begin.size();
  14845. cur_start = offset;
  14846. sink.os << begin;
  14847. }
  14848. DataSink cur_sink;
  14849. auto has_data = true;
  14850. cur_sink.write = sink.write;
  14851. // Forward is_writable so a provider item asking whether it may keep
  14852. // going gets the outer sink's answer rather than the default `true`.
  14853. cur_sink.is_writable = sink.is_writable;
  14854. cur_sink.done = [&]() { has_data = false; };
  14855. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14856. return false;
  14857. }
  14858. if (!has_data) {
  14859. sink.os << detail::serialize_multipart_formdata_item_end();
  14860. cur_item++;
  14861. cur_start = 0;
  14862. }
  14863. return true;
  14864. } else {
  14865. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14866. sink.done();
  14867. return true;
  14868. }
  14869. };
  14870. }
  14871. inline bool ClientImpl::process_socket(
  14872. const Socket &socket,
  14873. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14874. std::function<bool(Stream &strm)> callback) {
  14875. return detail::process_client_socket(
  14876. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14877. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14878. }
  14879. inline bool ClientImpl::is_ssl() const { return false; }
  14880. inline Result ClientImpl::Get(const std::string &path,
  14881. DownloadProgress progress) {
  14882. return Get(path, Headers(), std::move(progress));
  14883. }
  14884. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14885. DownloadProgress progress) {
  14886. return Get(path, params, Headers(), std::move(progress));
  14887. }
  14888. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14889. const Headers &headers,
  14890. DownloadProgress progress) {
  14891. if (params.empty()) { return Get(path, headers); }
  14892. std::string path_with_query = append_query_params(path, params);
  14893. return Get(path_with_query, headers, std::move(progress));
  14894. }
  14895. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14896. DownloadProgress progress) {
  14897. Request req;
  14898. req.method = "GET";
  14899. req.path = path;
  14900. req.headers = headers;
  14901. req.download_progress = std::move(progress);
  14902. if (max_timeout_msec_ > 0) {
  14903. req.start_time_ = std::chrono::steady_clock::now();
  14904. }
  14905. return send_(std::move(req));
  14906. }
  14907. inline Result ClientImpl::Get(const std::string &path,
  14908. ContentReceiver content_receiver,
  14909. DownloadProgress progress) {
  14910. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14911. std::move(progress));
  14912. }
  14913. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14914. ContentReceiver content_receiver,
  14915. DownloadProgress progress) {
  14916. return Get(path, headers, nullptr, std::move(content_receiver),
  14917. std::move(progress));
  14918. }
  14919. inline Result ClientImpl::Get(const std::string &path,
  14920. ResponseHandler response_handler,
  14921. ContentReceiver content_receiver,
  14922. DownloadProgress progress) {
  14923. return Get(path, Headers(), std::move(response_handler),
  14924. std::move(content_receiver), std::move(progress));
  14925. }
  14926. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14927. ResponseHandler response_handler,
  14928. ContentReceiver content_receiver,
  14929. DownloadProgress progress) {
  14930. Request req;
  14931. req.method = "GET";
  14932. req.path = path;
  14933. req.headers = headers;
  14934. req.response_handler = std::move(response_handler);
  14935. req.content_receiver =
  14936. [content_receiver](const char *data, size_t data_length,
  14937. size_t /*offset*/, size_t /*total_length*/) {
  14938. return content_receiver(data, data_length);
  14939. };
  14940. req.download_progress = std::move(progress);
  14941. if (max_timeout_msec_ > 0) {
  14942. req.start_time_ = std::chrono::steady_clock::now();
  14943. }
  14944. return send_(std::move(req));
  14945. }
  14946. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14947. const Headers &headers,
  14948. ContentReceiver content_receiver,
  14949. DownloadProgress progress) {
  14950. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14951. std::move(progress));
  14952. }
  14953. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14954. const Headers &headers,
  14955. ResponseHandler response_handler,
  14956. ContentReceiver content_receiver,
  14957. DownloadProgress progress) {
  14958. if (params.empty()) {
  14959. return Get(path, headers, std::move(response_handler),
  14960. std::move(content_receiver), std::move(progress));
  14961. }
  14962. std::string path_with_query = append_query_params(path, params);
  14963. return Get(path_with_query, headers, std::move(response_handler),
  14964. std::move(content_receiver), std::move(progress));
  14965. }
  14966. inline Result ClientImpl::Head(const std::string &path) {
  14967. return Head(path, Headers());
  14968. }
  14969. inline Result ClientImpl::Head(const std::string &path,
  14970. const Headers &headers) {
  14971. Request req;
  14972. req.method = "HEAD";
  14973. req.headers = headers;
  14974. req.path = path;
  14975. if (max_timeout_msec_ > 0) {
  14976. req.start_time_ = std::chrono::steady_clock::now();
  14977. }
  14978. return send_(std::move(req));
  14979. }
  14980. inline Result ClientImpl::Post(const std::string &path) {
  14981. return Post(path, std::string(), std::string());
  14982. }
  14983. inline Result ClientImpl::Post(const std::string &path,
  14984. const Headers &headers) {
  14985. return Post(path, headers, nullptr, 0, std::string());
  14986. }
  14987. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14988. size_t content_length,
  14989. const std::string &content_type,
  14990. UploadProgress progress) {
  14991. return Post(path, Headers(), body, content_length, content_type, progress);
  14992. }
  14993. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14994. const std::string &content_type,
  14995. UploadProgress progress) {
  14996. return Post(path, Headers(), body, content_type, progress);
  14997. }
  14998. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14999. return Post(path, Headers(), params);
  15000. }
  15001. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  15002. ContentProvider content_provider,
  15003. const std::string &content_type,
  15004. UploadProgress progress) {
  15005. return Post(path, Headers(), content_length, std::move(content_provider),
  15006. content_type, progress);
  15007. }
  15008. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  15009. ContentProvider content_provider,
  15010. const std::string &content_type,
  15011. ContentReceiver content_receiver,
  15012. UploadProgress progress) {
  15013. return Post(path, Headers(), content_length, std::move(content_provider),
  15014. content_type, std::move(content_receiver), progress);
  15015. }
  15016. inline Result ClientImpl::Post(const std::string &path,
  15017. ContentProviderWithoutLength content_provider,
  15018. const std::string &content_type,
  15019. UploadProgress progress) {
  15020. return Post(path, Headers(), std::move(content_provider), content_type,
  15021. progress);
  15022. }
  15023. inline Result ClientImpl::Post(const std::string &path,
  15024. ContentProviderWithoutLength content_provider,
  15025. const std::string &content_type,
  15026. ContentReceiver content_receiver,
  15027. UploadProgress progress) {
  15028. return Post(path, Headers(), std::move(content_provider), content_type,
  15029. std::move(content_receiver), progress);
  15030. }
  15031. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15032. const Params &params) {
  15033. auto query = detail::params_to_query_str(params);
  15034. return Post(path, headers, query, "application/x-www-form-urlencoded");
  15035. }
  15036. inline Result ClientImpl::Post(const std::string &path,
  15037. const UploadFormDataItems &items,
  15038. UploadProgress progress) {
  15039. return Post(path, Headers(), items, progress);
  15040. }
  15041. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15042. const UploadFormDataItems &items,
  15043. UploadProgress progress) {
  15044. const auto &boundary = detail::make_multipart_data_boundary();
  15045. const auto &content_type =
  15046. detail::serialize_multipart_formdata_get_content_type(boundary);
  15047. auto content_length = detail::get_multipart_content_length(items, boundary);
  15048. return Post(path, headers, content_length,
  15049. detail::make_multipart_content_provider(items, boundary),
  15050. content_type, progress);
  15051. }
  15052. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15053. const UploadFormDataItems &items,
  15054. const std::string &boundary,
  15055. UploadProgress progress) {
  15056. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15057. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15058. }
  15059. const auto &content_type =
  15060. detail::serialize_multipart_formdata_get_content_type(boundary);
  15061. auto content_length = detail::get_multipart_content_length(items, boundary);
  15062. return Post(path, headers, content_length,
  15063. detail::make_multipart_content_provider(items, boundary),
  15064. content_type, progress);
  15065. }
  15066. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15067. const char *body, size_t content_length,
  15068. const std::string &content_type,
  15069. UploadProgress progress) {
  15070. return send_with_content_provider_and_receiver(
  15071. "POST", path, headers, body, content_length, nullptr, nullptr,
  15072. content_type, nullptr, progress);
  15073. }
  15074. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15075. const std::string &body,
  15076. const std::string &content_type,
  15077. UploadProgress progress) {
  15078. return send_with_content_provider_and_receiver(
  15079. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  15080. content_type, nullptr, progress);
  15081. }
  15082. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15083. size_t content_length,
  15084. ContentProvider content_provider,
  15085. const std::string &content_type,
  15086. UploadProgress progress) {
  15087. return send_with_content_provider_and_receiver(
  15088. "POST", path, headers, nullptr, content_length,
  15089. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15090. }
  15091. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15092. size_t content_length,
  15093. ContentProvider content_provider,
  15094. const std::string &content_type,
  15095. ContentReceiver content_receiver,
  15096. DownloadProgress progress) {
  15097. return send_with_content_provider_and_receiver(
  15098. "POST", path, headers, nullptr, content_length,
  15099. std::move(content_provider), nullptr, content_type,
  15100. std::move(content_receiver), std::move(progress));
  15101. }
  15102. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15103. ContentProviderWithoutLength content_provider,
  15104. const std::string &content_type,
  15105. UploadProgress progress) {
  15106. return send_with_content_provider_and_receiver(
  15107. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15108. content_type, nullptr, progress);
  15109. }
  15110. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15111. ContentProviderWithoutLength content_provider,
  15112. const std::string &content_type,
  15113. ContentReceiver content_receiver,
  15114. DownloadProgress progress) {
  15115. return send_with_content_provider_and_receiver(
  15116. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15117. content_type, std::move(content_receiver), std::move(progress));
  15118. }
  15119. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15120. const UploadFormDataItems &items,
  15121. const FormDataProviderItems &provider_items,
  15122. UploadProgress progress) {
  15123. const auto &boundary = detail::make_multipart_data_boundary();
  15124. const auto &content_type =
  15125. detail::serialize_multipart_formdata_get_content_type(boundary);
  15126. return send_with_content_provider_and_receiver(
  15127. "POST", path, headers, nullptr, 0, nullptr,
  15128. get_multipart_content_provider(boundary, items, provider_items),
  15129. content_type, nullptr, progress);
  15130. }
  15131. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15132. const std::string &body,
  15133. const std::string &content_type,
  15134. ContentReceiver content_receiver,
  15135. DownloadProgress progress) {
  15136. Request req;
  15137. req.method = "POST";
  15138. req.path = path;
  15139. req.headers = headers;
  15140. req.body = body;
  15141. req.content_receiver =
  15142. [content_receiver](const char *data, size_t data_length,
  15143. size_t /*offset*/, size_t /*total_length*/) {
  15144. return content_receiver(data, data_length);
  15145. };
  15146. req.download_progress = std::move(progress);
  15147. if (max_timeout_msec_ > 0) {
  15148. req.start_time_ = std::chrono::steady_clock::now();
  15149. }
  15150. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15151. return send_(std::move(req));
  15152. }
  15153. inline Result ClientImpl::Put(const std::string &path) {
  15154. return Put(path, std::string(), std::string());
  15155. }
  15156. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  15157. return Put(path, headers, nullptr, 0, std::string());
  15158. }
  15159. inline Result ClientImpl::Put(const std::string &path, const char *body,
  15160. size_t content_length,
  15161. const std::string &content_type,
  15162. UploadProgress progress) {
  15163. return Put(path, Headers(), body, content_length, content_type, progress);
  15164. }
  15165. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  15166. const std::string &content_type,
  15167. UploadProgress progress) {
  15168. return Put(path, Headers(), body, content_type, progress);
  15169. }
  15170. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  15171. return Put(path, Headers(), params);
  15172. }
  15173. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  15174. ContentProvider content_provider,
  15175. const std::string &content_type,
  15176. UploadProgress progress) {
  15177. return Put(path, Headers(), content_length, std::move(content_provider),
  15178. content_type, progress);
  15179. }
  15180. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  15181. ContentProvider content_provider,
  15182. const std::string &content_type,
  15183. ContentReceiver content_receiver,
  15184. UploadProgress progress) {
  15185. return Put(path, Headers(), content_length, std::move(content_provider),
  15186. content_type, std::move(content_receiver), progress);
  15187. }
  15188. inline Result ClientImpl::Put(const std::string &path,
  15189. ContentProviderWithoutLength content_provider,
  15190. const std::string &content_type,
  15191. UploadProgress progress) {
  15192. return Put(path, Headers(), std::move(content_provider), content_type,
  15193. progress);
  15194. }
  15195. inline Result ClientImpl::Put(const std::string &path,
  15196. ContentProviderWithoutLength content_provider,
  15197. const std::string &content_type,
  15198. ContentReceiver content_receiver,
  15199. UploadProgress progress) {
  15200. return Put(path, Headers(), std::move(content_provider), content_type,
  15201. std::move(content_receiver), progress);
  15202. }
  15203. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15204. const Params &params) {
  15205. auto query = detail::params_to_query_str(params);
  15206. return Put(path, headers, query, "application/x-www-form-urlencoded");
  15207. }
  15208. inline Result ClientImpl::Put(const std::string &path,
  15209. const UploadFormDataItems &items,
  15210. UploadProgress progress) {
  15211. return Put(path, Headers(), items, progress);
  15212. }
  15213. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15214. const UploadFormDataItems &items,
  15215. UploadProgress progress) {
  15216. const auto &boundary = detail::make_multipart_data_boundary();
  15217. const auto &content_type =
  15218. detail::serialize_multipart_formdata_get_content_type(boundary);
  15219. auto content_length = detail::get_multipart_content_length(items, boundary);
  15220. return Put(path, headers, content_length,
  15221. detail::make_multipart_content_provider(items, boundary),
  15222. content_type, progress);
  15223. }
  15224. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15225. const UploadFormDataItems &items,
  15226. const std::string &boundary,
  15227. UploadProgress progress) {
  15228. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15229. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15230. }
  15231. const auto &content_type =
  15232. detail::serialize_multipart_formdata_get_content_type(boundary);
  15233. auto content_length = detail::get_multipart_content_length(items, boundary);
  15234. return Put(path, headers, content_length,
  15235. detail::make_multipart_content_provider(items, boundary),
  15236. content_type, progress);
  15237. }
  15238. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15239. const char *body, size_t content_length,
  15240. const std::string &content_type,
  15241. UploadProgress progress) {
  15242. return send_with_content_provider_and_receiver(
  15243. "PUT", path, headers, body, content_length, nullptr, nullptr,
  15244. content_type, nullptr, progress);
  15245. }
  15246. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15247. const std::string &body,
  15248. const std::string &content_type,
  15249. UploadProgress progress) {
  15250. return send_with_content_provider_and_receiver(
  15251. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  15252. content_type, nullptr, progress);
  15253. }
  15254. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15255. size_t content_length,
  15256. ContentProvider content_provider,
  15257. const std::string &content_type,
  15258. UploadProgress progress) {
  15259. return send_with_content_provider_and_receiver(
  15260. "PUT", path, headers, nullptr, content_length,
  15261. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15262. }
  15263. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15264. size_t content_length,
  15265. ContentProvider content_provider,
  15266. const std::string &content_type,
  15267. ContentReceiver content_receiver,
  15268. UploadProgress progress) {
  15269. return send_with_content_provider_and_receiver(
  15270. "PUT", path, headers, nullptr, content_length,
  15271. std::move(content_provider), nullptr, content_type,
  15272. std::move(content_receiver), progress);
  15273. }
  15274. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15275. ContentProviderWithoutLength content_provider,
  15276. const std::string &content_type,
  15277. UploadProgress progress) {
  15278. return send_with_content_provider_and_receiver(
  15279. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15280. content_type, nullptr, progress);
  15281. }
  15282. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15283. ContentProviderWithoutLength content_provider,
  15284. const std::string &content_type,
  15285. ContentReceiver content_receiver,
  15286. UploadProgress progress) {
  15287. return send_with_content_provider_and_receiver(
  15288. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15289. content_type, std::move(content_receiver), progress);
  15290. }
  15291. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15292. const UploadFormDataItems &items,
  15293. const FormDataProviderItems &provider_items,
  15294. UploadProgress progress) {
  15295. const auto &boundary = detail::make_multipart_data_boundary();
  15296. const auto &content_type =
  15297. detail::serialize_multipart_formdata_get_content_type(boundary);
  15298. return send_with_content_provider_and_receiver(
  15299. "PUT", path, headers, nullptr, 0, nullptr,
  15300. get_multipart_content_provider(boundary, items, provider_items),
  15301. content_type, nullptr, progress);
  15302. }
  15303. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15304. const std::string &body,
  15305. const std::string &content_type,
  15306. ContentReceiver content_receiver,
  15307. DownloadProgress progress) {
  15308. Request req;
  15309. req.method = "PUT";
  15310. req.path = path;
  15311. req.headers = headers;
  15312. req.body = body;
  15313. req.content_receiver =
  15314. [content_receiver](const char *data, size_t data_length,
  15315. size_t /*offset*/, size_t /*total_length*/) {
  15316. return content_receiver(data, data_length);
  15317. };
  15318. req.download_progress = std::move(progress);
  15319. if (max_timeout_msec_ > 0) {
  15320. req.start_time_ = std::chrono::steady_clock::now();
  15321. }
  15322. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15323. return send_(std::move(req));
  15324. }
  15325. inline Result ClientImpl::Patch(const std::string &path) {
  15326. return Patch(path, std::string(), std::string());
  15327. }
  15328. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15329. UploadProgress progress) {
  15330. return Patch(path, headers, nullptr, 0, std::string(), progress);
  15331. }
  15332. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  15333. size_t content_length,
  15334. const std::string &content_type,
  15335. UploadProgress progress) {
  15336. return Patch(path, Headers(), body, content_length, content_type, progress);
  15337. }
  15338. inline Result ClientImpl::Patch(const std::string &path,
  15339. const std::string &body,
  15340. const std::string &content_type,
  15341. UploadProgress progress) {
  15342. return Patch(path, Headers(), body, content_type, progress);
  15343. }
  15344. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  15345. return Patch(path, Headers(), params);
  15346. }
  15347. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15348. ContentProvider content_provider,
  15349. const std::string &content_type,
  15350. UploadProgress progress) {
  15351. return Patch(path, Headers(), content_length, std::move(content_provider),
  15352. content_type, progress);
  15353. }
  15354. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15355. ContentProvider content_provider,
  15356. const std::string &content_type,
  15357. ContentReceiver content_receiver,
  15358. UploadProgress progress) {
  15359. return Patch(path, Headers(), content_length, std::move(content_provider),
  15360. content_type, std::move(content_receiver), progress);
  15361. }
  15362. inline Result ClientImpl::Patch(const std::string &path,
  15363. ContentProviderWithoutLength content_provider,
  15364. const std::string &content_type,
  15365. UploadProgress progress) {
  15366. return Patch(path, Headers(), std::move(content_provider), content_type,
  15367. progress);
  15368. }
  15369. inline Result ClientImpl::Patch(const std::string &path,
  15370. ContentProviderWithoutLength content_provider,
  15371. const std::string &content_type,
  15372. ContentReceiver content_receiver,
  15373. UploadProgress progress) {
  15374. return Patch(path, Headers(), std::move(content_provider), content_type,
  15375. std::move(content_receiver), progress);
  15376. }
  15377. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15378. const Params &params) {
  15379. auto query = detail::params_to_query_str(params);
  15380. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  15381. }
  15382. inline Result ClientImpl::Patch(const std::string &path,
  15383. const UploadFormDataItems &items,
  15384. UploadProgress progress) {
  15385. return Patch(path, Headers(), items, progress);
  15386. }
  15387. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15388. const UploadFormDataItems &items,
  15389. UploadProgress progress) {
  15390. const auto &boundary = detail::make_multipart_data_boundary();
  15391. const auto &content_type =
  15392. detail::serialize_multipart_formdata_get_content_type(boundary);
  15393. auto content_length = detail::get_multipart_content_length(items, boundary);
  15394. return Patch(path, headers, content_length,
  15395. detail::make_multipart_content_provider(items, boundary),
  15396. content_type, progress);
  15397. }
  15398. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15399. const UploadFormDataItems &items,
  15400. const std::string &boundary,
  15401. UploadProgress progress) {
  15402. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15403. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15404. }
  15405. const auto &content_type =
  15406. detail::serialize_multipart_formdata_get_content_type(boundary);
  15407. auto content_length = detail::get_multipart_content_length(items, boundary);
  15408. return Patch(path, headers, content_length,
  15409. detail::make_multipart_content_provider(items, boundary),
  15410. content_type, progress);
  15411. }
  15412. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15413. const char *body, size_t content_length,
  15414. const std::string &content_type,
  15415. UploadProgress progress) {
  15416. return send_with_content_provider_and_receiver(
  15417. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  15418. content_type, nullptr, progress);
  15419. }
  15420. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15421. const std::string &body,
  15422. const std::string &content_type,
  15423. UploadProgress progress) {
  15424. return send_with_content_provider_and_receiver(
  15425. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  15426. content_type, nullptr, progress);
  15427. }
  15428. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15429. size_t content_length,
  15430. ContentProvider content_provider,
  15431. const std::string &content_type,
  15432. UploadProgress progress) {
  15433. return send_with_content_provider_and_receiver(
  15434. "PATCH", path, headers, nullptr, content_length,
  15435. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15436. }
  15437. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15438. size_t content_length,
  15439. ContentProvider content_provider,
  15440. const std::string &content_type,
  15441. ContentReceiver content_receiver,
  15442. UploadProgress progress) {
  15443. return send_with_content_provider_and_receiver(
  15444. "PATCH", path, headers, nullptr, content_length,
  15445. std::move(content_provider), nullptr, content_type,
  15446. std::move(content_receiver), progress);
  15447. }
  15448. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15449. ContentProviderWithoutLength content_provider,
  15450. const std::string &content_type,
  15451. UploadProgress progress) {
  15452. return send_with_content_provider_and_receiver(
  15453. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15454. content_type, nullptr, progress);
  15455. }
  15456. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15457. ContentProviderWithoutLength content_provider,
  15458. const std::string &content_type,
  15459. ContentReceiver content_receiver,
  15460. UploadProgress progress) {
  15461. return send_with_content_provider_and_receiver(
  15462. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15463. content_type, std::move(content_receiver), progress);
  15464. }
  15465. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15466. const UploadFormDataItems &items,
  15467. const FormDataProviderItems &provider_items,
  15468. UploadProgress progress) {
  15469. const auto &boundary = detail::make_multipart_data_boundary();
  15470. const auto &content_type =
  15471. detail::serialize_multipart_formdata_get_content_type(boundary);
  15472. return send_with_content_provider_and_receiver(
  15473. "PATCH", path, headers, nullptr, 0, nullptr,
  15474. get_multipart_content_provider(boundary, items, provider_items),
  15475. content_type, nullptr, progress);
  15476. }
  15477. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15478. const std::string &body,
  15479. const std::string &content_type,
  15480. ContentReceiver content_receiver,
  15481. DownloadProgress progress) {
  15482. Request req;
  15483. req.method = "PATCH";
  15484. req.path = path;
  15485. req.headers = headers;
  15486. req.body = body;
  15487. req.content_receiver =
  15488. [content_receiver](const char *data, size_t data_length,
  15489. size_t /*offset*/, size_t /*total_length*/) {
  15490. return content_receiver(data, data_length);
  15491. };
  15492. req.download_progress = std::move(progress);
  15493. if (max_timeout_msec_ > 0) {
  15494. req.start_time_ = std::chrono::steady_clock::now();
  15495. }
  15496. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15497. return send_(std::move(req));
  15498. }
  15499. inline Result ClientImpl::Delete(const std::string &path,
  15500. DownloadProgress progress) {
  15501. return Delete(path, Headers(), std::string(), std::string(), progress);
  15502. }
  15503. inline Result ClientImpl::Delete(const std::string &path,
  15504. const Headers &headers,
  15505. DownloadProgress progress) {
  15506. return Delete(path, headers, std::string(), std::string(), progress);
  15507. }
  15508. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15509. size_t content_length,
  15510. const std::string &content_type,
  15511. DownloadProgress progress) {
  15512. return Delete(path, Headers(), body, content_length, content_type, progress);
  15513. }
  15514. inline Result ClientImpl::Delete(const std::string &path,
  15515. const std::string &body,
  15516. const std::string &content_type,
  15517. DownloadProgress progress) {
  15518. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15519. progress);
  15520. }
  15521. inline Result ClientImpl::Delete(const std::string &path,
  15522. const Headers &headers,
  15523. const std::string &body,
  15524. const std::string &content_type,
  15525. DownloadProgress progress) {
  15526. return Delete(path, headers, body.data(), body.size(), content_type,
  15527. progress);
  15528. }
  15529. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15530. DownloadProgress progress) {
  15531. return Delete(path, Headers(), params, progress);
  15532. }
  15533. inline Result ClientImpl::Delete(const std::string &path,
  15534. const Headers &headers, const Params &params,
  15535. DownloadProgress progress) {
  15536. auto query = detail::params_to_query_str(params);
  15537. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15538. progress);
  15539. }
  15540. inline Result ClientImpl::Delete(const std::string &path,
  15541. const Headers &headers, const char *body,
  15542. size_t content_length,
  15543. const std::string &content_type,
  15544. DownloadProgress progress) {
  15545. Request req;
  15546. req.method = "DELETE";
  15547. req.headers = headers;
  15548. req.path = path;
  15549. req.download_progress = std::move(progress);
  15550. if (max_timeout_msec_ > 0) {
  15551. req.start_time_ = std::chrono::steady_clock::now();
  15552. }
  15553. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15554. req.body.assign(body, content_length);
  15555. return send_(std::move(req));
  15556. }
  15557. inline Result ClientImpl::Options(const std::string &path) {
  15558. return Options(path, Headers());
  15559. }
  15560. inline Result ClientImpl::Options(const std::string &path,
  15561. const Headers &headers) {
  15562. Request req;
  15563. req.method = "OPTIONS";
  15564. req.headers = headers;
  15565. req.path = path;
  15566. if (max_timeout_msec_ > 0) {
  15567. req.start_time_ = std::chrono::steady_clock::now();
  15568. }
  15569. return send_(std::move(req));
  15570. }
  15571. inline void ClientImpl::stop() {
  15572. std::lock_guard<std::mutex> guard(socket_mutex_);
  15573. stop_requested_ = true;
  15574. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15575. // do is to shutdown_socket, so that threads using this socket suddenly
  15576. // discover they can't read/write any more and error out. Everything else
  15577. // (closing the socket, shutting ssl down) is unsafe because these actions
  15578. // are not thread-safe.
  15579. if (socket_requests_in_flight_ > 0) {
  15580. shutdown_socket(socket_);
  15581. // Aside from that, we set a flag for the socket to be closed when we're
  15582. // done.
  15583. socket_should_be_closed_when_request_is_done_ = true;
  15584. return;
  15585. }
  15586. disconnect(/*gracefully=*/true);
  15587. }
  15588. inline std::string ClientImpl::host() const { return host_; }
  15589. inline int ClientImpl::port() const { return port_; }
  15590. inline size_t ClientImpl::is_socket_open() const {
  15591. std::lock_guard<std::mutex> guard(socket_mutex_);
  15592. return socket_.is_open();
  15593. }
  15594. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15595. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15596. connection_timeout_sec_ = sec;
  15597. connection_timeout_usec_ = usec;
  15598. }
  15599. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15600. read_timeout_sec_ = sec;
  15601. read_timeout_usec_ = usec;
  15602. }
  15603. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15604. write_timeout_sec_ = sec;
  15605. write_timeout_usec_ = usec;
  15606. }
  15607. inline void ClientImpl::set_max_timeout(time_t msec) {
  15608. max_timeout_msec_ = msec;
  15609. }
  15610. inline void ClientImpl::set_basic_auth(const std::string &username,
  15611. const std::string &password) {
  15612. basic_auth_username_ = username;
  15613. basic_auth_password_ = password;
  15614. }
  15615. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15616. bearer_token_auth_token_ = token;
  15617. }
  15618. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15619. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15620. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15621. inline void
  15622. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15623. set_direct_hostname_addr_map(std::move(addr_map));
  15624. }
  15625. inline void ClientImpl::set_direct_hostname_addr_map(
  15626. std::map<std::string, std::string> addr_map) {
  15627. addr_map_ = std::move(addr_map);
  15628. }
  15629. inline void ClientImpl::set_tunnel_hostname_addr_map(
  15630. std::map<std::string, std::string> addr_map) {
  15631. tunnel_addr_map_ = std::move(addr_map);
  15632. }
  15633. inline void ClientImpl::set_default_headers(Headers headers) {
  15634. default_headers_ = std::move(headers);
  15635. }
  15636. inline void ClientImpl::set_header_writer(
  15637. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15638. header_writer_ = writer;
  15639. }
  15640. inline void ClientImpl::set_address_family(int family) {
  15641. address_family_ = family;
  15642. }
  15643. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15644. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15645. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15646. socket_options_ = std::move(socket_options);
  15647. }
  15648. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15649. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15650. inline void ClientImpl::set_payload_max_length(size_t length) {
  15651. payload_max_length_ = length;
  15652. has_payload_max_length_ = true;
  15653. }
  15654. inline void ClientImpl::set_interface(const std::string &intf) {
  15655. interface_ = intf;
  15656. }
  15657. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15658. proxy_host_ = host;
  15659. proxy_port_ = port;
  15660. std::lock_guard<std::mutex> guard(socket_mutex_);
  15661. disconnect(/*gracefully=*/true);
  15662. }
  15663. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15664. const std::string &password) {
  15665. proxy_basic_auth_username_ = username;
  15666. proxy_basic_auth_password_ = password;
  15667. }
  15668. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15669. proxy_bearer_token_auth_token_ = token;
  15670. }
  15671. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15672. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  15673. std::lock_guard<std::mutex> guard(socket_mutex_);
  15674. disconnect(/*gracefully=*/true);
  15675. }
  15676. #ifdef CPPHTTPLIB_SSL_ENABLED
  15677. inline void ClientImpl::set_digest_auth(const std::string &username,
  15678. const std::string &password) {
  15679. digest_auth_username_ = username;
  15680. digest_auth_password_ = password;
  15681. }
  15682. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15683. const std::string &ca_cert_dir_path) {
  15684. ca_cert_file_path_ = ca_cert_file_path;
  15685. ca_cert_dir_path_ = ca_cert_dir_path;
  15686. }
  15687. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15688. const std::string &password) {
  15689. proxy_digest_auth_username_ = username;
  15690. proxy_digest_auth_password_ = password;
  15691. }
  15692. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15693. if (server_certificate_verification_ == enabled) { return; }
  15694. server_certificate_verification_ = enabled;
  15695. tls_settings_changed();
  15696. }
  15697. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15698. if (server_hostname_verification_ == enabled) { return; }
  15699. server_hostname_verification_ = enabled;
  15700. tls_settings_changed();
  15701. }
  15702. inline void ClientImpl::enable_system_ca(bool enabled) {
  15703. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15704. }
  15705. #endif
  15706. inline void ClientImpl::set_logger(Logger logger) {
  15707. logger_ = std::move(logger);
  15708. }
  15709. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15710. error_logger_ = std::move(error_logger);
  15711. }
  15712. /*
  15713. * SSL/TLS Common Implementation
  15714. */
  15715. inline ClientConnection::~ClientConnection() {
  15716. #ifdef CPPHTTPLIB_SSL_ENABLED
  15717. if (session) {
  15718. tls::shutdown(session, true);
  15719. tls::free_session(session);
  15720. session = nullptr;
  15721. }
  15722. #endif
  15723. if (sock != INVALID_SOCKET) {
  15724. detail::close_socket(sock);
  15725. sock = INVALID_SOCKET;
  15726. }
  15727. }
  15728. // Universal client implementation
  15729. inline Client::Client(const std::string &scheme_host_port)
  15730. : Client(scheme_host_port, std::string(), std::string()) {}
  15731. inline Client::Client(const std::string &scheme_host_port,
  15732. const std::string &client_cert_path,
  15733. const std::string &client_key_path) {
  15734. detail::UrlComponents uc;
  15735. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15736. auto &scheme = uc.scheme;
  15737. #ifdef CPPHTTPLIB_SSL_ENABLED
  15738. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15739. #else
  15740. if (!scheme.empty() && scheme != "http") {
  15741. #endif
  15742. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15743. std::string msg = "'" + scheme + "' scheme is not supported.";
  15744. throw std::invalid_argument(msg);
  15745. #endif
  15746. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15747. return;
  15748. }
  15749. auto is_ssl = scheme == "https";
  15750. auto host = std::move(uc.host);
  15751. auto port = is_ssl ? 443 : 80;
  15752. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15753. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15754. return;
  15755. }
  15756. if (is_ssl) {
  15757. #ifdef CPPHTTPLIB_SSL_ENABLED
  15758. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15759. client_key_path);
  15760. is_ssl_ = is_ssl;
  15761. #endif
  15762. } else {
  15763. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15764. client_key_path);
  15765. }
  15766. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  15767. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  15768. // A URL, but not one this client can use, such as one with userinfo. A
  15769. // Unix socket path may have "//" further on.
  15770. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15771. } else {
  15772. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15773. // if port param below changes.
  15774. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15775. client_cert_path, client_key_path);
  15776. }
  15777. }
  15778. inline Client::Client(const std::string &host, int port)
  15779. : Client(host, port, std::string(), std::string()) {}
  15780. inline Client::Client(const std::string &host, int port,
  15781. const std::string &client_cert_path,
  15782. const std::string &client_key_path)
  15783. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15784. client_key_path)) {}
  15785. inline Client::~Client() = default;
  15786. inline bool Client::is_valid() const {
  15787. return cli_ != nullptr && cli_->is_valid();
  15788. }
  15789. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15790. return cli_->Get(path, std::move(progress));
  15791. }
  15792. inline Result Client::Get(const std::string &path, const Headers &headers,
  15793. DownloadProgress progress) {
  15794. return cli_->Get(path, headers, std::move(progress));
  15795. }
  15796. inline Result Client::Get(const std::string &path,
  15797. ContentReceiver content_receiver,
  15798. DownloadProgress progress) {
  15799. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15800. }
  15801. inline Result Client::Get(const std::string &path, const Headers &headers,
  15802. ContentReceiver content_receiver,
  15803. DownloadProgress progress) {
  15804. return cli_->Get(path, headers, std::move(content_receiver),
  15805. std::move(progress));
  15806. }
  15807. inline Result Client::Get(const std::string &path,
  15808. ResponseHandler response_handler,
  15809. ContentReceiver content_receiver,
  15810. DownloadProgress progress) {
  15811. return cli_->Get(path, std::move(response_handler),
  15812. std::move(content_receiver), std::move(progress));
  15813. }
  15814. inline Result Client::Get(const std::string &path, const Headers &headers,
  15815. ResponseHandler response_handler,
  15816. ContentReceiver content_receiver,
  15817. DownloadProgress progress) {
  15818. return cli_->Get(path, headers, std::move(response_handler),
  15819. std::move(content_receiver), std::move(progress));
  15820. }
  15821. inline Result Client::Get(const std::string &path, const Params &params,
  15822. DownloadProgress progress) {
  15823. return cli_->Get(path, params, std::move(progress));
  15824. }
  15825. inline Result Client::Get(const std::string &path, const Params &params,
  15826. const Headers &headers, DownloadProgress progress) {
  15827. return cli_->Get(path, params, headers, std::move(progress));
  15828. }
  15829. inline Result Client::Get(const std::string &path, const Params &params,
  15830. const Headers &headers,
  15831. ContentReceiver content_receiver,
  15832. DownloadProgress progress) {
  15833. return cli_->Get(path, params, headers, std::move(content_receiver),
  15834. std::move(progress));
  15835. }
  15836. inline Result Client::Get(const std::string &path, const Params &params,
  15837. const Headers &headers,
  15838. ResponseHandler response_handler,
  15839. ContentReceiver content_receiver,
  15840. DownloadProgress progress) {
  15841. return cli_->Get(path, params, headers, std::move(response_handler),
  15842. std::move(content_receiver), std::move(progress));
  15843. }
  15844. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15845. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15846. return cli_->Head(path, headers);
  15847. }
  15848. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15849. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15850. return cli_->Post(path, headers);
  15851. }
  15852. inline Result Client::Post(const std::string &path, const char *body,
  15853. size_t content_length,
  15854. const std::string &content_type,
  15855. UploadProgress progress) {
  15856. return cli_->Post(path, body, content_length, content_type, progress);
  15857. }
  15858. inline Result Client::Post(const std::string &path, const Headers &headers,
  15859. const char *body, size_t content_length,
  15860. const std::string &content_type,
  15861. UploadProgress progress) {
  15862. return cli_->Post(path, headers, body, content_length, content_type,
  15863. progress);
  15864. }
  15865. inline Result Client::Post(const std::string &path, const std::string &body,
  15866. const std::string &content_type,
  15867. UploadProgress progress) {
  15868. return cli_->Post(path, body, content_type, progress);
  15869. }
  15870. inline Result Client::Post(const std::string &path, const Headers &headers,
  15871. const std::string &body,
  15872. const std::string &content_type,
  15873. UploadProgress progress) {
  15874. return cli_->Post(path, headers, body, content_type, progress);
  15875. }
  15876. inline Result Client::Post(const std::string &path, size_t content_length,
  15877. ContentProvider content_provider,
  15878. const std::string &content_type,
  15879. UploadProgress progress) {
  15880. return cli_->Post(path, content_length, std::move(content_provider),
  15881. content_type, progress);
  15882. }
  15883. inline Result Client::Post(const std::string &path, size_t content_length,
  15884. ContentProvider content_provider,
  15885. const std::string &content_type,
  15886. ContentReceiver content_receiver,
  15887. UploadProgress progress) {
  15888. return cli_->Post(path, content_length, std::move(content_provider),
  15889. content_type, std::move(content_receiver), progress);
  15890. }
  15891. inline Result Client::Post(const std::string &path,
  15892. ContentProviderWithoutLength content_provider,
  15893. const std::string &content_type,
  15894. UploadProgress progress) {
  15895. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15896. }
  15897. inline Result Client::Post(const std::string &path,
  15898. ContentProviderWithoutLength content_provider,
  15899. const std::string &content_type,
  15900. ContentReceiver content_receiver,
  15901. UploadProgress progress) {
  15902. return cli_->Post(path, std::move(content_provider), content_type,
  15903. std::move(content_receiver), progress);
  15904. }
  15905. inline Result Client::Post(const std::string &path, const Headers &headers,
  15906. size_t content_length,
  15907. ContentProvider content_provider,
  15908. const std::string &content_type,
  15909. UploadProgress progress) {
  15910. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15911. content_type, progress);
  15912. }
  15913. inline Result Client::Post(const std::string &path, const Headers &headers,
  15914. size_t content_length,
  15915. ContentProvider content_provider,
  15916. const std::string &content_type,
  15917. ContentReceiver content_receiver,
  15918. DownloadProgress progress) {
  15919. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15920. content_type, std::move(content_receiver), progress);
  15921. }
  15922. inline Result Client::Post(const std::string &path, const Headers &headers,
  15923. ContentProviderWithoutLength content_provider,
  15924. const std::string &content_type,
  15925. UploadProgress progress) {
  15926. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15927. progress);
  15928. }
  15929. inline Result Client::Post(const std::string &path, const Headers &headers,
  15930. ContentProviderWithoutLength content_provider,
  15931. const std::string &content_type,
  15932. ContentReceiver content_receiver,
  15933. DownloadProgress progress) {
  15934. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15935. std::move(content_receiver), progress);
  15936. }
  15937. inline Result Client::Post(const std::string &path, const Params &params) {
  15938. return cli_->Post(path, params);
  15939. }
  15940. inline Result Client::Post(const std::string &path, const Headers &headers,
  15941. const Params &params) {
  15942. return cli_->Post(path, headers, params);
  15943. }
  15944. inline Result Client::Post(const std::string &path,
  15945. const UploadFormDataItems &items,
  15946. UploadProgress progress) {
  15947. return cli_->Post(path, items, progress);
  15948. }
  15949. inline Result Client::Post(const std::string &path, const Headers &headers,
  15950. const UploadFormDataItems &items,
  15951. UploadProgress progress) {
  15952. return cli_->Post(path, headers, items, progress);
  15953. }
  15954. inline Result Client::Post(const std::string &path, const Headers &headers,
  15955. const UploadFormDataItems &items,
  15956. const std::string &boundary,
  15957. UploadProgress progress) {
  15958. return cli_->Post(path, headers, items, boundary, progress);
  15959. }
  15960. inline Result Client::Post(const std::string &path, const Headers &headers,
  15961. const UploadFormDataItems &items,
  15962. const FormDataProviderItems &provider_items,
  15963. UploadProgress progress) {
  15964. return cli_->Post(path, headers, items, provider_items, progress);
  15965. }
  15966. inline Result Client::Post(const std::string &path, const Headers &headers,
  15967. const std::string &body,
  15968. const std::string &content_type,
  15969. ContentReceiver content_receiver,
  15970. DownloadProgress progress) {
  15971. return cli_->Post(path, headers, body, content_type,
  15972. std::move(content_receiver), progress);
  15973. }
  15974. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15975. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15976. return cli_->Put(path, headers);
  15977. }
  15978. inline Result Client::Put(const std::string &path, const char *body,
  15979. size_t content_length,
  15980. const std::string &content_type,
  15981. UploadProgress progress) {
  15982. return cli_->Put(path, body, content_length, content_type, progress);
  15983. }
  15984. inline Result Client::Put(const std::string &path, const Headers &headers,
  15985. const char *body, size_t content_length,
  15986. const std::string &content_type,
  15987. UploadProgress progress) {
  15988. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15989. }
  15990. inline Result Client::Put(const std::string &path, const std::string &body,
  15991. const std::string &content_type,
  15992. UploadProgress progress) {
  15993. return cli_->Put(path, body, content_type, progress);
  15994. }
  15995. inline Result Client::Put(const std::string &path, const Headers &headers,
  15996. const std::string &body,
  15997. const std::string &content_type,
  15998. UploadProgress progress) {
  15999. return cli_->Put(path, headers, body, content_type, progress);
  16000. }
  16001. inline Result Client::Put(const std::string &path, size_t content_length,
  16002. ContentProvider content_provider,
  16003. const std::string &content_type,
  16004. UploadProgress progress) {
  16005. return cli_->Put(path, content_length, std::move(content_provider),
  16006. content_type, progress);
  16007. }
  16008. inline Result Client::Put(const std::string &path, size_t content_length,
  16009. ContentProvider content_provider,
  16010. const std::string &content_type,
  16011. ContentReceiver content_receiver,
  16012. UploadProgress progress) {
  16013. return cli_->Put(path, content_length, std::move(content_provider),
  16014. content_type, std::move(content_receiver), progress);
  16015. }
  16016. inline Result Client::Put(const std::string &path,
  16017. ContentProviderWithoutLength content_provider,
  16018. const std::string &content_type,
  16019. UploadProgress progress) {
  16020. return cli_->Put(path, std::move(content_provider), content_type, progress);
  16021. }
  16022. inline Result Client::Put(const std::string &path,
  16023. ContentProviderWithoutLength content_provider,
  16024. const std::string &content_type,
  16025. ContentReceiver content_receiver,
  16026. UploadProgress progress) {
  16027. return cli_->Put(path, std::move(content_provider), content_type,
  16028. std::move(content_receiver), progress);
  16029. }
  16030. inline Result Client::Put(const std::string &path, const Headers &headers,
  16031. size_t content_length,
  16032. ContentProvider content_provider,
  16033. const std::string &content_type,
  16034. UploadProgress progress) {
  16035. return cli_->Put(path, headers, content_length, std::move(content_provider),
  16036. content_type, progress);
  16037. }
  16038. inline Result Client::Put(const std::string &path, const Headers &headers,
  16039. size_t content_length,
  16040. ContentProvider content_provider,
  16041. const std::string &content_type,
  16042. ContentReceiver content_receiver,
  16043. UploadProgress progress) {
  16044. return cli_->Put(path, headers, content_length, std::move(content_provider),
  16045. content_type, std::move(content_receiver), progress);
  16046. }
  16047. inline Result Client::Put(const std::string &path, const Headers &headers,
  16048. ContentProviderWithoutLength content_provider,
  16049. const std::string &content_type,
  16050. UploadProgress progress) {
  16051. return cli_->Put(path, headers, std::move(content_provider), content_type,
  16052. progress);
  16053. }
  16054. inline Result Client::Put(const std::string &path, const Headers &headers,
  16055. ContentProviderWithoutLength content_provider,
  16056. const std::string &content_type,
  16057. ContentReceiver content_receiver,
  16058. UploadProgress progress) {
  16059. return cli_->Put(path, headers, std::move(content_provider), content_type,
  16060. std::move(content_receiver), progress);
  16061. }
  16062. inline Result Client::Put(const std::string &path, const Params &params) {
  16063. return cli_->Put(path, params);
  16064. }
  16065. inline Result Client::Put(const std::string &path, const Headers &headers,
  16066. const Params &params) {
  16067. return cli_->Put(path, headers, params);
  16068. }
  16069. inline Result Client::Put(const std::string &path,
  16070. const UploadFormDataItems &items,
  16071. UploadProgress progress) {
  16072. return cli_->Put(path, items, progress);
  16073. }
  16074. inline Result Client::Put(const std::string &path, const Headers &headers,
  16075. const UploadFormDataItems &items,
  16076. UploadProgress progress) {
  16077. return cli_->Put(path, headers, items, progress);
  16078. }
  16079. inline Result Client::Put(const std::string &path, const Headers &headers,
  16080. const UploadFormDataItems &items,
  16081. const std::string &boundary,
  16082. UploadProgress progress) {
  16083. return cli_->Put(path, headers, items, boundary, progress);
  16084. }
  16085. inline Result Client::Put(const std::string &path, const Headers &headers,
  16086. const UploadFormDataItems &items,
  16087. const FormDataProviderItems &provider_items,
  16088. UploadProgress progress) {
  16089. return cli_->Put(path, headers, items, provider_items, progress);
  16090. }
  16091. inline Result Client::Put(const std::string &path, const Headers &headers,
  16092. const std::string &body,
  16093. const std::string &content_type,
  16094. ContentReceiver content_receiver,
  16095. DownloadProgress progress) {
  16096. return cli_->Put(path, headers, body, content_type, content_receiver,
  16097. progress);
  16098. }
  16099. inline Result Client::Patch(const std::string &path) {
  16100. return cli_->Patch(path);
  16101. }
  16102. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  16103. return cli_->Patch(path, headers);
  16104. }
  16105. inline Result Client::Patch(const std::string &path, const char *body,
  16106. size_t content_length,
  16107. const std::string &content_type,
  16108. UploadProgress progress) {
  16109. return cli_->Patch(path, body, content_length, content_type, progress);
  16110. }
  16111. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16112. const char *body, size_t content_length,
  16113. const std::string &content_type,
  16114. UploadProgress progress) {
  16115. return cli_->Patch(path, headers, body, content_length, content_type,
  16116. progress);
  16117. }
  16118. inline Result Client::Patch(const std::string &path, const std::string &body,
  16119. const std::string &content_type,
  16120. UploadProgress progress) {
  16121. return cli_->Patch(path, body, content_type, progress);
  16122. }
  16123. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16124. const std::string &body,
  16125. const std::string &content_type,
  16126. UploadProgress progress) {
  16127. return cli_->Patch(path, headers, body, content_type, progress);
  16128. }
  16129. inline Result Client::Patch(const std::string &path, size_t content_length,
  16130. ContentProvider content_provider,
  16131. const std::string &content_type,
  16132. UploadProgress progress) {
  16133. return cli_->Patch(path, content_length, std::move(content_provider),
  16134. content_type, progress);
  16135. }
  16136. inline Result Client::Patch(const std::string &path, size_t content_length,
  16137. ContentProvider content_provider,
  16138. const std::string &content_type,
  16139. ContentReceiver content_receiver,
  16140. UploadProgress progress) {
  16141. return cli_->Patch(path, content_length, std::move(content_provider),
  16142. content_type, std::move(content_receiver), progress);
  16143. }
  16144. inline Result Client::Patch(const std::string &path,
  16145. ContentProviderWithoutLength content_provider,
  16146. const std::string &content_type,
  16147. UploadProgress progress) {
  16148. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  16149. }
  16150. inline Result Client::Patch(const std::string &path,
  16151. ContentProviderWithoutLength content_provider,
  16152. const std::string &content_type,
  16153. ContentReceiver content_receiver,
  16154. UploadProgress progress) {
  16155. return cli_->Patch(path, std::move(content_provider), content_type,
  16156. std::move(content_receiver), progress);
  16157. }
  16158. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16159. size_t content_length,
  16160. ContentProvider content_provider,
  16161. const std::string &content_type,
  16162. UploadProgress progress) {
  16163. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  16164. content_type, progress);
  16165. }
  16166. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16167. size_t content_length,
  16168. ContentProvider content_provider,
  16169. const std::string &content_type,
  16170. ContentReceiver content_receiver,
  16171. UploadProgress progress) {
  16172. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  16173. content_type, std::move(content_receiver), progress);
  16174. }
  16175. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16176. ContentProviderWithoutLength content_provider,
  16177. const std::string &content_type,
  16178. UploadProgress progress) {
  16179. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16180. progress);
  16181. }
  16182. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16183. ContentProviderWithoutLength content_provider,
  16184. const std::string &content_type,
  16185. ContentReceiver content_receiver,
  16186. UploadProgress progress) {
  16187. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16188. std::move(content_receiver), progress);
  16189. }
  16190. inline Result Client::Patch(const std::string &path, const Params &params) {
  16191. return cli_->Patch(path, params);
  16192. }
  16193. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16194. const Params &params) {
  16195. return cli_->Patch(path, headers, params);
  16196. }
  16197. inline Result Client::Patch(const std::string &path,
  16198. const UploadFormDataItems &items,
  16199. UploadProgress progress) {
  16200. return cli_->Patch(path, items, progress);
  16201. }
  16202. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16203. const UploadFormDataItems &items,
  16204. UploadProgress progress) {
  16205. return cli_->Patch(path, headers, items, progress);
  16206. }
  16207. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16208. const UploadFormDataItems &items,
  16209. const std::string &boundary,
  16210. UploadProgress progress) {
  16211. return cli_->Patch(path, headers, items, boundary, progress);
  16212. }
  16213. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16214. const UploadFormDataItems &items,
  16215. const FormDataProviderItems &provider_items,
  16216. UploadProgress progress) {
  16217. return cli_->Patch(path, headers, items, provider_items, progress);
  16218. }
  16219. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16220. const std::string &body,
  16221. const std::string &content_type,
  16222. ContentReceiver content_receiver,
  16223. DownloadProgress progress) {
  16224. return cli_->Patch(path, headers, body, content_type, content_receiver,
  16225. progress);
  16226. }
  16227. inline Result Client::Delete(const std::string &path,
  16228. DownloadProgress progress) {
  16229. return cli_->Delete(path, progress);
  16230. }
  16231. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16232. DownloadProgress progress) {
  16233. return cli_->Delete(path, headers, progress);
  16234. }
  16235. inline Result Client::Delete(const std::string &path, const char *body,
  16236. size_t content_length,
  16237. const std::string &content_type,
  16238. DownloadProgress progress) {
  16239. return cli_->Delete(path, body, content_length, content_type, progress);
  16240. }
  16241. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16242. const char *body, size_t content_length,
  16243. const std::string &content_type,
  16244. DownloadProgress progress) {
  16245. return cli_->Delete(path, headers, body, content_length, content_type,
  16246. progress);
  16247. }
  16248. inline Result Client::Delete(const std::string &path, const std::string &body,
  16249. const std::string &content_type,
  16250. DownloadProgress progress) {
  16251. return cli_->Delete(path, body, content_type, progress);
  16252. }
  16253. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16254. const std::string &body,
  16255. const std::string &content_type,
  16256. DownloadProgress progress) {
  16257. return cli_->Delete(path, headers, body, content_type, progress);
  16258. }
  16259. inline Result Client::Delete(const std::string &path, const Params &params,
  16260. DownloadProgress progress) {
  16261. return cli_->Delete(path, params, progress);
  16262. }
  16263. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16264. const Params &params, DownloadProgress progress) {
  16265. return cli_->Delete(path, headers, params, progress);
  16266. }
  16267. inline Result Client::Options(const std::string &path) {
  16268. return cli_->Options(path);
  16269. }
  16270. inline Result Client::Options(const std::string &path, const Headers &headers) {
  16271. return cli_->Options(path, headers);
  16272. }
  16273. inline ClientImpl::StreamHandle
  16274. Client::open_stream(const std::string &method, const std::string &path,
  16275. const Params &params, const Headers &headers,
  16276. const std::string &body, const std::string &content_type) {
  16277. return cli_->open_stream(method, path, params, headers, body, content_type);
  16278. }
  16279. inline bool Client::send(Request &req, Response &res, Error &error) {
  16280. return cli_->send(req, res, error);
  16281. }
  16282. inline Result Client::send(const Request &req) { return cli_->send(req); }
  16283. inline void Client::stop() { cli_->stop(); }
  16284. inline std::string Client::host() const { return cli_->host(); }
  16285. inline int Client::port() const { return cli_->port(); }
  16286. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  16287. inline socket_t Client::socket() const { return cli_->socket(); }
  16288. inline void
  16289. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  16290. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  16291. }
  16292. inline void Client::set_direct_hostname_addr_map(
  16293. std::map<std::string, std::string> addr_map) {
  16294. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  16295. }
  16296. inline void Client::set_tunnel_hostname_addr_map(
  16297. std::map<std::string, std::string> addr_map) {
  16298. cli_->set_tunnel_hostname_addr_map(std::move(addr_map));
  16299. }
  16300. inline void Client::set_default_headers(Headers headers) {
  16301. cli_->set_default_headers(std::move(headers));
  16302. }
  16303. inline void Client::set_header_writer(
  16304. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  16305. cli_->set_header_writer(writer);
  16306. }
  16307. inline void Client::set_address_family(int family) {
  16308. cli_->set_address_family(family);
  16309. }
  16310. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  16311. inline void Client::set_socket_options(SocketOptions socket_options) {
  16312. cli_->set_socket_options(std::move(socket_options));
  16313. }
  16314. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  16315. cli_->set_connection_timeout(sec, usec);
  16316. }
  16317. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  16318. cli_->set_read_timeout(sec, usec);
  16319. }
  16320. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  16321. cli_->set_write_timeout(sec, usec);
  16322. }
  16323. inline void Client::set_basic_auth(const std::string &username,
  16324. const std::string &password) {
  16325. cli_->set_basic_auth(username, password);
  16326. }
  16327. inline void Client::set_bearer_token_auth(const std::string &token) {
  16328. cli_->set_bearer_token_auth(token);
  16329. }
  16330. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  16331. inline void Client::set_follow_location(bool on) {
  16332. cli_->set_follow_location(on);
  16333. }
  16334. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  16335. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  16336. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  16337. inline void Client::set_payload_max_length(size_t length) {
  16338. cli_->set_payload_max_length(length);
  16339. }
  16340. inline void Client::set_interface(const std::string &intf) {
  16341. cli_->set_interface(intf);
  16342. }
  16343. inline void Client::set_proxy(const std::string &host, int port) {
  16344. cli_->set_proxy(host, port);
  16345. }
  16346. inline void Client::set_proxy_basic_auth(const std::string &username,
  16347. const std::string &password) {
  16348. cli_->set_proxy_basic_auth(username, password);
  16349. }
  16350. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  16351. cli_->set_proxy_bearer_token_auth(token);
  16352. }
  16353. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  16354. cli_->set_no_proxy(patterns);
  16355. }
  16356. inline void Client::set_logger(Logger logger) {
  16357. cli_->set_logger(std::move(logger));
  16358. }
  16359. inline void Client::set_error_logger(ErrorLogger error_logger) {
  16360. cli_->set_error_logger(std::move(error_logger));
  16361. }
  16362. /*
  16363. * Group 6: SSL Server and Client implementation
  16364. */
  16365. #ifdef CPPHTTPLIB_SSL_ENABLED
  16366. // SSL HTTP server implementation
  16367. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  16368. const char *client_ca_cert_file_path,
  16369. const char *client_ca_cert_dir_path,
  16370. const char *private_key_password) {
  16371. using namespace tls;
  16372. ctx_ = create_server_context();
  16373. if (!ctx_) { return; }
  16374. // Load server certificate and private key
  16375. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  16376. private_key_password)) {
  16377. last_ssl_error_ = static_cast<int>(get_error());
  16378. free_context(ctx_);
  16379. ctx_ = nullptr;
  16380. return;
  16381. }
  16382. // Load client CA certificates for client authentication
  16383. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  16384. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  16385. client_ca_cert_dir_path)) {
  16386. last_ssl_error_ = static_cast<int>(get_error());
  16387. free_context(ctx_);
  16388. ctx_ = nullptr;
  16389. return;
  16390. }
  16391. // Enable client certificate verification
  16392. set_verify_client(ctx_, true);
  16393. }
  16394. }
  16395. inline SSLServer::SSLServer(const PemMemory &pem) {
  16396. using namespace tls;
  16397. ctx_ = create_server_context();
  16398. if (ctx_) {
  16399. std::string cert_buf, key_buf;
  16400. if (!set_server_cert_pem(
  16401. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16402. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16403. pem.private_key_password)) {
  16404. last_ssl_error_ = static_cast<int>(get_error());
  16405. free_context(ctx_);
  16406. ctx_ = nullptr;
  16407. } else if (pem.client_ca_pem) {
  16408. auto ca_len = pem.client_ca_pem_len ? pem.client_ca_pem_len
  16409. : strlen(pem.client_ca_pem);
  16410. if (!load_ca_pem(ctx_, pem.client_ca_pem, ca_len)) {
  16411. last_ssl_error_ = static_cast<int>(get_error());
  16412. free_context(ctx_);
  16413. ctx_ = nullptr;
  16414. } else {
  16415. set_verify_client(ctx_, true);
  16416. }
  16417. }
  16418. }
  16419. }
  16420. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  16421. using namespace tls;
  16422. ctx_ = create_server_context();
  16423. if (ctx_) {
  16424. if (!setup_callback(ctx_)) {
  16425. free_context(ctx_);
  16426. ctx_ = nullptr;
  16427. }
  16428. }
  16429. }
  16430. inline SSLServer::~SSLServer() {
  16431. if (ctx_) { tls::free_context(ctx_); }
  16432. }
  16433. inline bool SSLServer::is_valid() const {
  16434. return ctx_ != nullptr && Server::is_valid();
  16435. }
  16436. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  16437. using namespace tls;
  16438. session_t session = nullptr;
  16439. {
  16440. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16441. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  16442. session = create_session(static_cast<ctx_t>(ctx_), sock);
  16443. if (session) { handshakes_in_progress_++; }
  16444. }
  16445. if (!session) {
  16446. last_ssl_error_ = static_cast<int>(get_error());
  16447. detail::shutdown_socket(sock);
  16448. detail::close_socket(sock);
  16449. return false;
  16450. }
  16451. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  16452. bool handshake_done = false;
  16453. bool ret = false;
  16454. bool websocket_upgraded = false;
  16455. auto cleanup = detail::scope_exit([&] {
  16456. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  16457. free_session(session);
  16458. if (handshake_done) {
  16459. detail::drain_and_close_socket(sock);
  16460. } else {
  16461. detail::shutdown_socket(sock);
  16462. detail::close_socket(sock);
  16463. }
  16464. });
  16465. // Perform TLS accept handshake with timeout
  16466. TlsError tls_err;
  16467. auto accepted = false;
  16468. {
  16469. auto handshake_left = detail::scope_exit([&] {
  16470. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16471. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  16472. });
  16473. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  16474. read_timeout_usec_, &tls_err);
  16475. }
  16476. if (!accepted) {
  16477. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16478. // Map TlsError to legacy ssl_error for backward compatibility
  16479. if (tls_err.code == ErrorCode::WantRead) {
  16480. last_ssl_error_ = SSL_ERROR_WANT_READ;
  16481. } else if (tls_err.code == ErrorCode::WantWrite) {
  16482. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  16483. } else {
  16484. last_ssl_error_ = SSL_ERROR_SSL;
  16485. }
  16486. #else
  16487. last_ssl_error_ = static_cast<int>(get_error());
  16488. #endif
  16489. return false;
  16490. }
  16491. handshake_done = true;
  16492. std::string remote_addr;
  16493. int remote_port = 0;
  16494. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  16495. std::string local_addr;
  16496. int local_port = 0;
  16497. detail::get_local_ip_and_port(sock, local_addr, local_port);
  16498. ret = serve_guarded([&]() {
  16499. return detail::process_server_socket_ssl(
  16500. svr_sock_, session, sock, keep_alive_max_count_,
  16501. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  16502. write_timeout_sec_, write_timeout_usec_,
  16503. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  16504. return process_request(
  16505. strm, remote_addr, remote_port, local_addr, local_port,
  16506. close_connection, connection_closed,
  16507. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16508. });
  16509. });
  16510. return ret;
  16511. }
  16512. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16513. const char *key_pem,
  16514. const char *client_ca_pem,
  16515. const char *password) {
  16516. if (!ctx_) { return false; }
  16517. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16518. updates_pending_++;
  16519. auto se = detail::scope_exit([&] {
  16520. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16521. });
  16522. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16523. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16524. return false;
  16525. }
  16526. if (client_ca_pem) {
  16527. if (!tls::update_server_client_ca(ctx_, client_ca_pem)) { return false; }
  16528. // As in the constructors, a client CA makes client certificates required
  16529. tls::set_verify_client(ctx_, true);
  16530. }
  16531. return true;
  16532. }
  16533. // SSL HTTP client implementation
  16534. inline SSLClient::~SSLClient() {
  16535. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16536. // base function rather than the derived function once we get to the
  16537. // base class destructor, and won't free the SSL (causing a leak).
  16538. // This must happen before the context is freed below: some backends
  16539. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16540. // context, so freeing the context first leaves close_notify reading
  16541. // freed memory.
  16542. shutdown_ssl_impl(socket_, true);
  16543. if (ctx_) {
  16544. tls::free_context(ctx_);
  16545. ctx_ = nullptr;
  16546. }
  16547. }
  16548. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16549. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16550. shutdown_ssl_impl(socket, shutdown_gracefully);
  16551. }
  16552. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16553. bool shutdown_gracefully) {
  16554. if (socket.sock == INVALID_SOCKET) {
  16555. assert(socket.ssl == nullptr);
  16556. return;
  16557. }
  16558. if (socket.ssl) {
  16559. tls::shutdown(socket.ssl, shutdown_gracefully);
  16560. {
  16561. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16562. tls::free_session(socket.ssl);
  16563. }
  16564. socket.ssl = nullptr;
  16565. }
  16566. assert(socket.ssl == nullptr);
  16567. }
  16568. inline bool SSLClient::process_socket(
  16569. const Socket &socket,
  16570. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16571. std::function<bool(Stream &strm)> callback) {
  16572. assert(socket.ssl);
  16573. return detail::process_client_socket_ssl(
  16574. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16575. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16576. [&](detail::SSLSocketStream &strm) {
  16577. auto ret = callback(strm);
  16578. // A request that failed after the handshake reports Error::Read or
  16579. // Error::Write; keep the TLS error behind it, such as a fatal alert
  16580. // from the server, for Result::ssl_error() and ssl_backend_error()
  16581. const auto &tls_error = strm.tls_error();
  16582. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  16583. last_ssl_error_ = static_cast<int>(tls_error.code);
  16584. last_backend_error_ = tls_error.backend_code;
  16585. }
  16586. return ret;
  16587. });
  16588. }
  16589. inline bool SSLClient::is_ssl() const { return true; }
  16590. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16591. if (!is_valid()) {
  16592. error = Error::SSLConnection;
  16593. return false;
  16594. }
  16595. return ClientImpl::create_and_connect_socket(socket, error);
  16596. }
  16597. inline bool SSLClient::setup_proxy_connection(
  16598. Socket &socket,
  16599. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16600. Response &res, bool &success, Error &error) {
  16601. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16602. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16603. return false;
  16604. }
  16605. if (!initialize_ssl(socket, error)) {
  16606. shutdown_socket(socket);
  16607. close_socket(socket);
  16608. success = false;
  16609. return false;
  16610. }
  16611. return true;
  16612. }
  16613. // Assumes that socket is a connection being opened, which no other thread uses
  16614. inline bool SSLClient::connect_with_proxy(
  16615. Socket &socket,
  16616. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16617. Response &res, bool &success, Error &error) {
  16618. success = true;
  16619. auto connect_target =
  16620. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  16621. auto retargeted = connect_target !=
  16622. detail::make_host_and_port_string_always_port(host_, port_);
  16623. Response proxy_res;
  16624. if (!detail::process_client_socket(
  16625. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16626. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16627. start_time, [&](Stream &strm) {
  16628. strm.set_read_interrupt(stop_interrupt());
  16629. Request req2;
  16630. req2.method = "CONNECT";
  16631. req2.path = connect_target;
  16632. if (retargeted) { req2.set_header("Host", connect_target); }
  16633. if (max_timeout_msec_ > 0) {
  16634. req2.start_time_ = std::chrono::steady_clock::now();
  16635. }
  16636. return process_request(strm, req2, proxy_res, false, error);
  16637. })) {
  16638. // Thread-safe to close everything because we are assuming there are no
  16639. // requests in flight
  16640. shutdown_ssl(socket, true);
  16641. shutdown_socket(socket);
  16642. close_socket(socket);
  16643. success = false;
  16644. return false;
  16645. }
  16646. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16647. if (!proxy_digest_auth_username_.empty() &&
  16648. !proxy_digest_auth_password_.empty()) {
  16649. std::map<std::string, std::string> auth;
  16650. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16651. // Close the current socket and create a new one for the authenticated
  16652. // request
  16653. shutdown_ssl(socket, true);
  16654. shutdown_socket(socket);
  16655. close_socket(socket);
  16656. // Create a new socket for the authenticated CONNECT request
  16657. if (!ensure_socket_connection(socket, error)) {
  16658. success = false;
  16659. return false;
  16660. }
  16661. proxy_res = Response();
  16662. if (!detail::process_client_socket(
  16663. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16664. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16665. start_time, [&](Stream &strm) {
  16666. strm.set_read_interrupt(stop_interrupt());
  16667. Request req3;
  16668. req3.method = "CONNECT";
  16669. req3.path = connect_target;
  16670. if (retargeted) { req3.set_header("Host", connect_target); }
  16671. req3.headers.insert(detail::make_digest_authentication_header(
  16672. req3, make_request_target(req3), auth, 1,
  16673. detail::random_string(10), proxy_digest_auth_username_,
  16674. proxy_digest_auth_password_, true));
  16675. if (max_timeout_msec_ > 0) {
  16676. req3.start_time_ = std::chrono::steady_clock::now();
  16677. }
  16678. return process_request(strm, req3, proxy_res, false, error);
  16679. })) {
  16680. // Thread-safe to close everything because we are assuming there are
  16681. // no requests in flight
  16682. shutdown_ssl(socket, true);
  16683. shutdown_socket(socket);
  16684. close_socket(socket);
  16685. success = false;
  16686. return false;
  16687. }
  16688. }
  16689. }
  16690. }
  16691. // If status code is not 200, proxy request is failed.
  16692. // Set error to ProxyConnection. A 407 is returned as the response of the
  16693. // request, so the caller sees the proxy asks for credentials; any other
  16694. // status would read as the answer of the origin, which it never reached.
  16695. if (proxy_res.status != StatusCode::OK_200) {
  16696. error = Error::ProxyConnection;
  16697. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16698. res = std::move(proxy_res);
  16699. } else {
  16700. success = false;
  16701. }
  16702. // Thread-safe to close everything because we are assuming there are
  16703. // no requests in flight
  16704. shutdown_ssl(socket, true);
  16705. shutdown_socket(socket);
  16706. close_socket(socket);
  16707. return false;
  16708. }
  16709. return true;
  16710. }
  16711. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16712. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16713. if (is_proxy_enabled_for_host(host_)) { return true; }
  16714. if (!initialize_ssl(socket, error)) {
  16715. shutdown_socket(socket);
  16716. close_socket(socket);
  16717. return false;
  16718. }
  16719. return true;
  16720. }
  16721. // SSL HTTP client implementation
  16722. inline SSLClient::SSLClient(const std::string &host)
  16723. : SSLClient(host, 443, std::string(), std::string()) {}
  16724. inline SSLClient::SSLClient(const std::string &host, int port)
  16725. : SSLClient(host, port, std::string(), std::string()) {}
  16726. inline void SSLClient::init_ctx() {
  16727. ctx_ = tls::create_client_context();
  16728. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16729. }
  16730. inline void SSLClient::reset_ctx_on_error() {
  16731. last_backend_error_ = tls::get_error();
  16732. tls::free_context(ctx_);
  16733. ctx_ = nullptr;
  16734. }
  16735. inline SSLClient::SSLClient(const std::string &host, int port,
  16736. const std::string &client_cert_path,
  16737. const std::string &client_key_path,
  16738. const std::string &private_key_password)
  16739. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16740. init_ctx();
  16741. if (!ctx_) { return; }
  16742. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16743. const char *password =
  16744. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16745. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16746. client_key_path.c_str(), password)) {
  16747. reset_ctx_on_error();
  16748. }
  16749. }
  16750. }
  16751. inline SSLClient::SSLClient(const std::string &host, int port,
  16752. const PemMemory &pem)
  16753. : ClientImpl(host, port) {
  16754. init_ctx();
  16755. if (!ctx_) { return; }
  16756. if (pem.cert_pem && pem.key_pem) {
  16757. std::string cert_buf, key_buf;
  16758. if (!tls::set_client_cert_pem(
  16759. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16760. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16761. pem.private_key_password)) {
  16762. reset_ctx_on_error();
  16763. }
  16764. }
  16765. }
  16766. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16767. if (ca_cert_store && ctx_) {
  16768. // set_ca_store takes ownership of ca_cert_store
  16769. tls::set_ca_store(ctx_, ca_cert_store);
  16770. ca_cert_store_set_ = true;
  16771. } else if (ca_cert_store) {
  16772. tls::free_ca_store(ca_cert_store);
  16773. }
  16774. custom_ca_loaded_ = true;
  16775. tls_settings_changed();
  16776. }
  16777. inline void
  16778. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16779. if (!ctx_) { return; }
  16780. server_certificate_verifier_ = verifier;
  16781. {
  16782. // Under the lock that creating a session from ctx_ takes
  16783. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16784. tls::set_verify_callback(ctx_, std::move(verifier));
  16785. }
  16786. tls_settings_changed();
  16787. }
  16788. inline void SSLClient::set_session_verifier(
  16789. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16790. session_verifier_ = std::move(verifier);
  16791. tls_settings_changed();
  16792. }
  16793. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16794. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16795. if (enable_windows_cert_verification_ == enabled) { return; }
  16796. enable_windows_cert_verification_ = enabled;
  16797. tls_settings_changed();
  16798. }
  16799. #endif
  16800. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16801. std::size_t size) {
  16802. if (ctx_ && ca_cert && size > 0) {
  16803. // Every PEM loaded, for redirect transfer
  16804. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  16805. ca_cert_pem_ += '\n';
  16806. }
  16807. ca_cert_pem_.append(ca_cert, size);
  16808. tls::load_ca_pem(ctx_, ca_cert, size);
  16809. }
  16810. custom_ca_loaded_ = true;
  16811. tls_settings_changed();
  16812. }
  16813. inline bool SSLClient::load_certs() {
  16814. auto ret = true;
  16815. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16816. // one client is shared across concurrent requests here.
  16817. std::call_once(initialize_cert_, [&]() {
  16818. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16819. ret = detail::load_client_ca_config(ctx_, ca_cert_file_path_,
  16820. ca_cert_dir_path_, custom_ca_loaded_,
  16821. system_ca_mode_, last_backend_error_);
  16822. });
  16823. return ret;
  16824. }
  16825. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16826. // Load CA certificates if server verification is enabled
  16827. if (server_certificate_verification_) {
  16828. if (!load_certs()) {
  16829. error = Error::SSLLoadingCerts;
  16830. return false;
  16831. }
  16832. }
  16833. detail::ClientTlsSessionOptions options;
  16834. options.server_hostname_verification = server_hostname_verification_;
  16835. options.session_verifier = session_verifier_;
  16836. options.interrupted = stop_interrupt();
  16837. options.ctx_mutex = &ctx_mutex_;
  16838. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16839. // Skip Schannel when a custom CA cert is specified, as the Windows
  16840. // certificate store would not know about user-provided CA certificates.
  16841. // Also skip when system CA trust is explicitly disabled.
  16842. options.windows_cert_verification =
  16843. enable_windows_cert_verification_ &&
  16844. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16845. ca_cert_dir_path_.empty() && !custom_ca_loaded_;
  16846. // Only a verifier set through set_server_certificate_verifier() is seen
  16847. // here, not one installed with tls::set_verify_callback() directly.
  16848. options.server_certificate_verifier_set =
  16849. static_cast<bool>(server_certificate_verifier_);
  16850. #endif
  16851. tls::session_t session = nullptr;
  16852. // Use scope_exit to ensure session is freed on error paths
  16853. bool success = false;
  16854. auto session_guard = detail::scope_exit([&] {
  16855. if (!success) { tls::free_session(session); }
  16856. });
  16857. detail::ClientTlsSessionError tls_error;
  16858. if (!detail::setup_client_tls_session(
  16859. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16860. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16861. options)) {
  16862. error = tls_error.error;
  16863. last_ssl_error_ = tls_error.ssl_error;
  16864. last_backend_error_ = tls_error.backend_error;
  16865. return false;
  16866. }
  16867. success = true;
  16868. socket.ssl = session;
  16869. return true;
  16870. }
  16871. inline void Client::set_digest_auth(const std::string &username,
  16872. const std::string &password) {
  16873. cli_->set_digest_auth(username, password);
  16874. }
  16875. inline void Client::set_proxy_digest_auth(const std::string &username,
  16876. const std::string &password) {
  16877. cli_->set_proxy_digest_auth(username, password);
  16878. }
  16879. inline void Client::enable_server_certificate_verification(bool enabled) {
  16880. cli_->enable_server_certificate_verification(enabled);
  16881. }
  16882. inline void Client::enable_server_hostname_verification(bool enabled) {
  16883. cli_->enable_server_hostname_verification(enabled);
  16884. }
  16885. inline void Client::enable_system_ca(bool enabled) {
  16886. cli_->enable_system_ca(enabled);
  16887. }
  16888. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16889. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16890. if (is_ssl_) {
  16891. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16892. enabled);
  16893. }
  16894. }
  16895. #endif
  16896. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16897. const std::string &ca_cert_dir_path) {
  16898. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16899. }
  16900. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16901. if (is_ssl_) {
  16902. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16903. } else if (ca_cert_store) {
  16904. tls::free_ca_store(ca_cert_store);
  16905. }
  16906. }
  16907. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16908. if (is_ssl_) {
  16909. // Use the PEM-based path so the CA data is retained for redirect transfer
  16910. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16911. }
  16912. }
  16913. inline void
  16914. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16915. if (is_ssl_) {
  16916. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16917. std::move(verifier));
  16918. }
  16919. }
  16920. inline void Client::set_session_verifier(
  16921. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16922. if (is_ssl_) {
  16923. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16924. }
  16925. }
  16926. inline tls::ctx_t Client::tls_context() const {
  16927. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16928. return nullptr;
  16929. }
  16930. #endif // CPPHTTPLIB_SSL_ENABLED
  16931. /*
  16932. * Group 7: TLS abstraction layer - Common API
  16933. */
  16934. #ifdef CPPHTTPLIB_SSL_ENABLED
  16935. namespace tls {
  16936. // Helper for PeerCert construction
  16937. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16938. return PeerCert(get_peer_cert(session));
  16939. }
  16940. namespace impl {
  16941. // set_verify_callback() can replace a callback while handshakes on other
  16942. // threads run it, so they share it, and take their reference under this lock.
  16943. inline std::mutex &verify_callback_mutex() {
  16944. static std::mutex mutex;
  16945. return mutex;
  16946. }
  16947. // The TLS libraries are C, so an exception from a verify callback must not
  16948. // unwind through them. It rejects the certificate instead.
  16949. inline bool run_verify_callback(const VerifyCallback &callback,
  16950. const VerifyContext &ctx) {
  16951. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  16952. return callback(ctx);
  16953. #else
  16954. try {
  16955. return callback(ctx);
  16956. } catch (...) { return false; }
  16957. #endif
  16958. }
  16959. // Check if a string is an IPv4 address
  16960. inline bool is_ipv4_address(const std::string &str) {
  16961. int dots = 0;
  16962. for (char c : str) {
  16963. if (c == '.') {
  16964. dots++;
  16965. } else if (!detail::is_ascii_digit(c)) {
  16966. return false;
  16967. }
  16968. }
  16969. return dots == 3;
  16970. }
  16971. // Parse IPv4 address string to bytes
  16972. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16973. const char *p = str.c_str();
  16974. for (int i = 0; i < 4; i++) {
  16975. if (i > 0) {
  16976. if (*p != '.') { return false; }
  16977. p++;
  16978. }
  16979. int val = 0;
  16980. int digits = 0;
  16981. while (detail::is_ascii_digit(*p)) {
  16982. val = val * 10 + (*p - '0');
  16983. if (val > 255) { return false; }
  16984. p++;
  16985. digits++;
  16986. }
  16987. if (digits == 0) { return false; }
  16988. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16989. if (digits > 1 && *(p - digits) == '0') { return false; }
  16990. out[i] = static_cast<unsigned char>(val);
  16991. }
  16992. return *p == '\0';
  16993. }
  16994. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16995. // `out` must have room for at least 16 bytes. Returns the address length
  16996. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16997. // literal. Used to match a host against iPAddress SANs the same way the
  16998. // OpenSSL backend does via X509_check_ip.
  16999. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  17000. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  17001. struct in6_addr addr6 = {};
  17002. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  17003. memcpy(out, &addr6, 16);
  17004. return 16;
  17005. }
  17006. return 0;
  17007. }
  17008. #ifdef _WIN32
  17009. // Enumerate Windows system certificates and call callback with DER data
  17010. template <typename Callback>
  17011. inline bool enumerate_windows_system_certs(Callback cb) {
  17012. bool loaded = false;
  17013. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17014. for (auto store_name : store_names) {
  17015. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  17016. if (hStore) {
  17017. PCCERT_CONTEXT pContext = nullptr;
  17018. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17019. nullptr) {
  17020. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  17021. loaded = true;
  17022. }
  17023. }
  17024. CertCloseStore(hStore, 0);
  17025. }
  17026. }
  17027. return loaded;
  17028. }
  17029. #endif
  17030. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17031. // The trust a certificate's Trust Settings give it for SSL server
  17032. // verification (SecTrustSettings.h). An empty array trusts it as a root.
  17033. // Otherwise the first usage-constraints dictionary that applies decides: one
  17034. // naming a policy other than SSL, a host name or an application does not
  17035. // apply, and a result left out means TrustRoot. Keychain Access writes "Never
  17036. // Trust" as kSecTrustSettingsResultDeny.
  17037. inline SecTrustSettingsResult
  17038. macos_ssl_trust_settings_result(CFArrayRef trust_settings) {
  17039. auto count = CFArrayGetCount(trust_settings);
  17040. if (count == 0) { return kSecTrustSettingsResultTrustRoot; }
  17041. for (CFIndex i = 0; i < count; i++) {
  17042. auto value = CFArrayGetValueAtIndex(trust_settings, i);
  17043. if (!value || CFGetTypeID(value) != CFDictionaryGetTypeID()) { continue; }
  17044. auto constraint = static_cast<CFDictionaryRef>(value);
  17045. auto policy_value =
  17046. CFDictionaryGetValue(constraint, kSecTrustSettingsPolicy);
  17047. if (policy_value) {
  17048. auto policy = static_cast<SecPolicyRef>(const_cast<void *>(policy_value));
  17049. auto is_ssl = false;
  17050. if (auto properties = SecPolicyCopyProperties(policy)) {
  17051. auto oid = CFDictionaryGetValue(properties, kSecPolicyOid);
  17052. is_ssl = oid && CFEqual(oid, kSecPolicyAppleSSL);
  17053. CFRelease(properties);
  17054. }
  17055. if (!is_ssl) { continue; }
  17056. }
  17057. if (CFDictionaryContainsKey(constraint, kSecTrustSettingsPolicyString) ||
  17058. CFDictionaryContainsKey(constraint, kSecTrustSettingsApplication)) {
  17059. continue;
  17060. }
  17061. auto result = kSecTrustSettingsResultTrustRoot;
  17062. auto number = static_cast<CFNumberRef>(
  17063. CFDictionaryGetValue(constraint, kSecTrustSettingsResult));
  17064. if (number) {
  17065. SInt32 number_value = 0;
  17066. if (!CFNumberGetValue(number, kCFNumberSInt32Type, &number_value)) {
  17067. continue;
  17068. }
  17069. result = static_cast<SecTrustSettingsResult>(number_value);
  17070. }
  17071. if (result == kSecTrustSettingsResultTrustRoot ||
  17072. result == kSecTrustSettingsResultTrustAsRoot ||
  17073. result == kSecTrustSettingsResultDeny) {
  17074. return result;
  17075. }
  17076. }
  17077. return kSecTrustSettingsResultUnspecified;
  17078. }
  17079. // Enumerate the macOS Keychain certificates trusted for SSL and call callback
  17080. // with DER data. A certificate with Trust Settings is not trusted just by
  17081. // having them: the settings say whether it is, and a per-user setting
  17082. // overrides the admin domain's, which overrides the system domain's (whose
  17083. // roots are all trusted). So a system root the user set to "Never Trust" is
  17084. // left out, as is one trusted only for S/MIME or code signing.
  17085. template <typename Callback>
  17086. inline bool enumerate_macos_keychain_certs(Callback cb) {
  17087. const SecTrustSettingsDomain domains[] = {
  17088. kSecTrustSettingsDomainUser,
  17089. kSecTrustSettingsDomainAdmin,
  17090. kSecTrustSettingsDomainSystem,
  17091. };
  17092. std::set<std::string> decided;
  17093. std::vector<std::string> trusted;
  17094. for (auto domain : domains) {
  17095. CFArrayRef certs = nullptr;
  17096. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  17097. if (status != errSecSuccess || !certs) {
  17098. if (certs) CFRelease(certs);
  17099. continue;
  17100. }
  17101. CFIndex count = CFArrayGetCount(certs);
  17102. for (CFIndex i = 0; i < count; i++) {
  17103. SecCertificateRef cert =
  17104. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  17105. CFDataRef data = SecCertificateCopyData(cert);
  17106. if (!data) { continue; }
  17107. std::string der(reinterpret_cast<const char *>(CFDataGetBytePtr(data)),
  17108. static_cast<size_t>(CFDataGetLength(data)));
  17109. CFRelease(data);
  17110. // Decided by a domain that overrides this one
  17111. if (decided.find(der) != decided.end()) { continue; }
  17112. auto result = kSecTrustSettingsResultTrustRoot;
  17113. if (domain != kSecTrustSettingsDomainSystem) {
  17114. result = kSecTrustSettingsResultUnspecified;
  17115. CFArrayRef trust_settings = nullptr;
  17116. if (SecTrustSettingsCopyTrustSettings(cert, domain, &trust_settings) ==
  17117. errSecSuccess &&
  17118. trust_settings) {
  17119. result = macos_ssl_trust_settings_result(trust_settings);
  17120. }
  17121. if (trust_settings) CFRelease(trust_settings);
  17122. }
  17123. // Neither trusted nor distrusted here; a domain below may decide
  17124. if (result == kSecTrustSettingsResultUnspecified) { continue; }
  17125. decided.insert(der);
  17126. if (result == kSecTrustSettingsResultTrustRoot ||
  17127. result == kSecTrustSettingsResultTrustAsRoot) {
  17128. trusted.push_back(std::move(der));
  17129. }
  17130. }
  17131. CFRelease(certs);
  17132. }
  17133. bool loaded = false;
  17134. for (const auto &der : trusted) {
  17135. if (cb(reinterpret_cast<const unsigned char *>(der.data()), der.size())) {
  17136. loaded = true;
  17137. }
  17138. }
  17139. return loaded;
  17140. }
  17141. #endif
  17142. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  17143. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  17144. // Common CA certificate file paths on Linux/Unix
  17145. inline const char **system_ca_paths() {
  17146. static const char *paths[] = {
  17147. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  17148. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  17149. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  17150. "/etc/pki/tls/cacert.pem", // OpenELEC
  17151. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  17152. nullptr};
  17153. return paths;
  17154. }
  17155. // Common CA certificate directory paths on Linux/Unix
  17156. inline const char **system_ca_dirs() {
  17157. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  17158. "/etc/pki/tls/certs", // RHEL/CentOS
  17159. "/usr/share/ca-certificates", // Other
  17160. nullptr};
  17161. return dirs;
  17162. }
  17163. #endif
  17164. } // namespace impl
  17165. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  17166. const char *ca_dir) {
  17167. if (!ctx) { return false; }
  17168. bool success = true;
  17169. if (ca_file && *ca_file) {
  17170. if (!load_ca_file(ctx, ca_file)) { success = false; }
  17171. }
  17172. if (ca_dir && *ca_dir) {
  17173. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  17174. }
  17175. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17176. // Set CA list for client certificate request (CertificateRequest message)
  17177. if (ca_file && *ca_file) {
  17178. auto list = SSL_load_client_CA_file(ca_file);
  17179. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  17180. }
  17181. #endif
  17182. return success;
  17183. }
  17184. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17185. const char *password) {
  17186. return set_client_cert_pem(ctx, cert, key, password);
  17187. }
  17188. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  17189. const char *key_path, const char *password) {
  17190. return set_client_cert_file(ctx, cert_path, key_path, password);
  17191. }
  17192. // PeerCert implementation
  17193. inline PeerCert::PeerCert() = default;
  17194. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  17195. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  17196. other.cert_ = nullptr;
  17197. }
  17198. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  17199. if (this != &other) {
  17200. if (cert_) { free_cert(cert_); }
  17201. cert_ = other.cert_;
  17202. other.cert_ = nullptr;
  17203. }
  17204. return *this;
  17205. }
  17206. inline PeerCert::~PeerCert() {
  17207. if (cert_) { free_cert(cert_); }
  17208. }
  17209. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  17210. inline std::string PeerCert::subject_cn() const {
  17211. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  17212. }
  17213. inline std::string PeerCert::issuer_name() const {
  17214. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  17215. }
  17216. inline bool PeerCert::check_hostname(const char *hostname) const {
  17217. return cert_ ? verify_hostname(cert_, hostname) : false;
  17218. }
  17219. inline std::vector<SanEntry> PeerCert::sans() const {
  17220. std::vector<SanEntry> result;
  17221. if (cert_) { get_cert_sans(cert_, result); }
  17222. return result;
  17223. }
  17224. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  17225. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  17226. }
  17227. inline std::string PeerCert::serial() const {
  17228. return cert_ ? get_cert_serial(cert_) : std::string();
  17229. }
  17230. // VerifyContext method implementations
  17231. inline std::string VerifyContext::subject_cn() const {
  17232. return cert ? get_cert_subject_cn(cert) : std::string();
  17233. }
  17234. inline std::string VerifyContext::issuer_name() const {
  17235. return cert ? get_cert_issuer_name(cert) : std::string();
  17236. }
  17237. inline bool VerifyContext::check_hostname(const char *hostname) const {
  17238. return cert ? verify_hostname(cert, hostname) : false;
  17239. }
  17240. inline std::vector<SanEntry> VerifyContext::sans() const {
  17241. std::vector<SanEntry> result;
  17242. if (cert) { get_cert_sans(cert, result); }
  17243. return result;
  17244. }
  17245. inline bool VerifyContext::validity(time_t &not_before,
  17246. time_t &not_after) const {
  17247. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  17248. }
  17249. inline std::string VerifyContext::serial() const {
  17250. return cert ? get_cert_serial(cert) : std::string();
  17251. }
  17252. // TlsError static method implementation
  17253. inline std::string TlsError::verify_error_to_string(long error_code) {
  17254. return verify_error_string(error_code);
  17255. }
  17256. } // namespace tls
  17257. // Request::peer_cert() implementation
  17258. inline tls::PeerCert Request::peer_cert() const {
  17259. return tls::get_peer_cert_from_session(ssl);
  17260. }
  17261. // Request::sni() implementation
  17262. inline std::string Request::sni() const {
  17263. if (!ssl) { return std::string(); }
  17264. const char *s = tls::get_sni(ssl);
  17265. return s ? std::string(s) : std::string();
  17266. }
  17267. #endif // CPPHTTPLIB_SSL_ENABLED
  17268. /*
  17269. * Group 8: TLS abstraction layer - OpenSSL backend
  17270. */
  17271. /*
  17272. * OpenSSL Backend Implementation
  17273. */
  17274. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17275. namespace tls {
  17276. namespace impl {
  17277. // Helper to map OpenSSL SSL_get_error to ErrorCode
  17278. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  17279. switch (ssl_error) {
  17280. case SSL_ERROR_NONE: return ErrorCode::Success;
  17281. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  17282. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  17283. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  17284. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  17285. case SSL_ERROR_SSL:
  17286. default: return ErrorCode::Fatal;
  17287. }
  17288. }
  17289. // Fills in a failed SSL_connect(). One that the server certificate's
  17290. // verification stopped reports the verify result, as the other backends and
  17291. // a check after the handshake do.
  17292. inline void fill_connect_error(SSL *ssl, int ret, TlsError &err) {
  17293. auto ssl_err = SSL_get_error(ssl, ret);
  17294. auto error = ERR_get_error();
  17295. err.code = map_ssl_error(ssl_err, err.sys_errno);
  17296. err.backend_code = error;
  17297. if (ssl_err != SSL_ERROR_SSL || ERR_GET_LIB(error) != ERR_LIB_SSL ||
  17298. ERR_GET_REASON(error) != SSL_R_CERTIFICATE_VERIFY_FAILED) {
  17299. return;
  17300. }
  17301. // A certificate only a verify callback turned down carries no verdict of
  17302. // its own, and fails as any other handshake does
  17303. auto verify_result = SSL_get_verify_result(ssl);
  17304. if (verify_result == X509_V_OK || verify_result == X509_V_ERR_UNSPECIFIED) {
  17305. return;
  17306. }
  17307. err.code = verify_result == X509_V_ERR_HOSTNAME_MISMATCH
  17308. ? ErrorCode::HostnameMismatch
  17309. : ErrorCode::CertVerifyFailed;
  17310. err.backend_code = static_cast<uint64_t>(verify_result);
  17311. }
  17312. // Helper: Create client CA list from PEM string
  17313. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  17314. // Caller takes ownership of returned list
  17315. inline STACK_OF(X509_NAME) *
  17316. create_client_ca_list_from_pem(const char *ca_pem) {
  17317. if (!ca_pem) { return nullptr; }
  17318. auto ca_list = sk_X509_NAME_new_null();
  17319. if (!ca_list) { return nullptr; }
  17320. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  17321. if (!bio) {
  17322. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  17323. return nullptr;
  17324. }
  17325. X509 *cert = nullptr;
  17326. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17327. nullptr) {
  17328. const X509_NAME *name = X509_get_subject_name(cert);
  17329. if (name) {
  17330. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  17331. }
  17332. X509_free(cert);
  17333. }
  17334. BIO_free(bio);
  17335. return ca_list;
  17336. }
  17337. inline void free_verify_callback(void * /*parent*/, void *ptr,
  17338. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  17339. long /*argl*/, void * /*argp*/) {
  17340. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  17341. }
  17342. // The SSL_CTX owns its verify callback, so each client or server sees only
  17343. // its own, on whichever thread runs the handshake.
  17344. inline int verify_callback_index() {
  17345. static const auto index = SSL_CTX_get_ex_new_index(
  17346. 0, nullptr, nullptr, nullptr, free_verify_callback);
  17347. return index;
  17348. }
  17349. // OpenSSL verify callback wrapper
  17350. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  17351. // Get SSL object from X509_STORE_CTX
  17352. auto ssl = static_cast<SSL *>(
  17353. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  17354. if (!ssl) { return preverify_ok; }
  17355. std::shared_ptr<VerifyCallback> callback;
  17356. {
  17357. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  17358. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  17359. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  17360. if (stored) { callback = *stored; }
  17361. }
  17362. if (!callback) { return preverify_ok; }
  17363. // Get current certificate and depth
  17364. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  17365. int depth = X509_STORE_CTX_get_error_depth(ctx);
  17366. int error = X509_STORE_CTX_get_error(ctx);
  17367. // Build context
  17368. VerifyContext verify_ctx;
  17369. verify_ctx.session = static_cast<session_t>(ssl);
  17370. verify_ctx.cert = static_cast<cert_t>(cert);
  17371. verify_ctx.depth = depth;
  17372. verify_ctx.preverify_ok = (preverify_ok != 0);
  17373. verify_ctx.error_code = error;
  17374. verify_ctx.error_string =
  17375. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  17376. auto accepted = run_verify_callback(*callback, verify_ctx);
  17377. // A client verifying the server during the handshake, which is what
  17378. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  17379. if (!SSL_is_server(ssl) &&
  17380. (SSL_get_verify_mode(ssl) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  17381. accepted = accepted && preverify_ok;
  17382. }
  17383. return accepted ? 1 : 0;
  17384. }
  17385. // Sets the verify mode from whether the peer's certificate is required and
  17386. // whether a verify callback is set.
  17387. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  17388. auto has_callback =
  17389. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  17390. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  17391. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  17392. SSL_CTX_set_verify(ssl_ctx, mode,
  17393. has_callback ? openssl_verify_callback : nullptr);
  17394. }
  17395. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  17396. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  17397. // that must be released with release_store_objects
  17398. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  17399. OPENSSL_VERSION_NUMBER >= 0x30300000L
  17400. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17401. #endif
  17402. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  17403. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17404. return X509_STORE_get1_objects(store);
  17405. #else
  17406. return X509_STORE_get0_objects(store);
  17407. #endif
  17408. }
  17409. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  17410. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17411. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  17412. #else
  17413. (void)objs; // get0 variant returns an internal pointer; nothing to free
  17414. #endif
  17415. }
  17416. } // namespace impl
  17417. inline ctx_t create_client_context() {
  17418. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  17419. if (ctx) {
  17420. // Disable auto-retry to properly handle non-blocking I/O
  17421. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  17422. // Set minimum TLS version
  17423. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17424. }
  17425. return static_cast<ctx_t>(ctx);
  17426. }
  17427. inline void free_context(ctx_t ctx) {
  17428. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  17429. }
  17430. inline bool set_min_version(ctx_t ctx, Version version) {
  17431. if (!ctx) return false;
  17432. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  17433. static_cast<uint16_t>(version)) == 1;
  17434. }
  17435. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17436. if (!ctx || !pem || len == 0) return false;
  17437. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17438. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17439. if (!store) return false;
  17440. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  17441. if (!bio) return false;
  17442. bool ok = true;
  17443. X509 *cert = nullptr;
  17444. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17445. nullptr) {
  17446. if (X509_STORE_add_cert(store, cert) != 1) {
  17447. // Ignore duplicate errors
  17448. auto err = ERR_peek_last_error();
  17449. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  17450. ok = false;
  17451. }
  17452. }
  17453. X509_free(cert);
  17454. if (!ok) break;
  17455. }
  17456. BIO_free(bio);
  17457. // Clear any "no more certificates" errors
  17458. ERR_clear_error();
  17459. return ok;
  17460. }
  17461. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17462. if (!ctx || !file_path) return false;
  17463. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  17464. nullptr) == 1;
  17465. }
  17466. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17467. if (!ctx || !dir_path) return false;
  17468. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  17469. dir_path) == 1;
  17470. }
  17471. inline bool load_system_certs(ctx_t ctx) {
  17472. if (!ctx) return false;
  17473. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17474. #ifdef _WIN32
  17475. // Windows: Load from system certificate store (ROOT and CA)
  17476. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17477. if (!store) return false;
  17478. bool loaded_any = false;
  17479. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17480. for (auto store_name : store_names) {
  17481. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  17482. if (!hStore) continue;
  17483. PCCERT_CONTEXT pContext = nullptr;
  17484. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17485. nullptr) {
  17486. const unsigned char *data = pContext->pbCertEncoded;
  17487. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  17488. if (x509) {
  17489. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17490. X509_free(x509);
  17491. }
  17492. }
  17493. CertCloseStore(hStore, 0);
  17494. }
  17495. return loaded_any;
  17496. #elif defined(__APPLE__)
  17497. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17498. // macOS: Load from Keychain
  17499. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17500. if (!store) return false;
  17501. auto loaded_any = impl::enumerate_macos_keychain_certs(
  17502. [&](const unsigned char *data, size_t len) {
  17503. auto x509 = d2i_X509(nullptr, &data, static_cast<long>(len));
  17504. if (!x509) { return false; }
  17505. auto added = X509_STORE_add_cert(store, x509) == 1;
  17506. X509_free(x509);
  17507. return added;
  17508. });
  17509. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17510. #else
  17511. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17512. #endif
  17513. #else
  17514. // Other Unix: use default verify paths
  17515. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17516. #endif
  17517. }
  17518. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17519. const char *password) {
  17520. if (!ctx || !cert || !key) return false;
  17521. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17522. // Load certificate
  17523. auto cert_bio = BIO_new_mem_buf(cert, -1);
  17524. if (!cert_bio) return false;
  17525. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17526. BIO_free(cert_bio);
  17527. if (!x509) return false;
  17528. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  17529. X509_free(x509);
  17530. if (!cert_ok) return false;
  17531. // Load private key
  17532. auto key_bio = BIO_new_mem_buf(key, -1);
  17533. if (!key_bio) return false;
  17534. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17535. password ? const_cast<char *>(password)
  17536. : nullptr);
  17537. BIO_free(key_bio);
  17538. if (!pkey) return false;
  17539. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  17540. EVP_PKEY_free(pkey);
  17541. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  17542. }
  17543. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17544. const char *key_path, const char *password) {
  17545. if (!ctx || !cert_path || !key_path) return false;
  17546. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17547. if (password && password[0] != '\0') {
  17548. SSL_CTX_set_default_passwd_cb_userdata(
  17549. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  17550. }
  17551. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  17552. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  17553. }
  17554. inline ctx_t create_server_context() {
  17555. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17556. if (ctx) {
  17557. // No renegotiation, as on the other backends: it would run a handshake
  17558. // that SSLServer::update_certs_pem() does not wait for
  17559. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  17560. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  17561. SSL_OP_NO_RENEGOTIATION);
  17562. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17563. // Without one, a client resuming its session is sent a fatal alert once
  17564. // client certificates are verified.
  17565. static const unsigned char sid_ctx[] = "cpp-httplib";
  17566. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  17567. }
  17568. return static_cast<ctx_t>(ctx);
  17569. }
  17570. inline void set_verify_client(ctx_t ctx, bool require) {
  17571. if (!ctx) return;
  17572. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  17573. }
  17574. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17575. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  17576. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17577. SSL *ssl = SSL_new(ssl_ctx);
  17578. if (!ssl) return nullptr;
  17579. // Disable auto-retry for proper non-blocking I/O handling
  17580. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  17581. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  17582. if (!bio) {
  17583. SSL_free(ssl);
  17584. return nullptr;
  17585. }
  17586. SSL_set_bio(ssl, bio, bio);
  17587. return static_cast<session_t>(ssl);
  17588. }
  17589. inline void free_session(session_t session) {
  17590. if (session) { SSL_free(static_cast<SSL *>(session)); }
  17591. }
  17592. inline bool set_sni(session_t session, const char *hostname,
  17593. bool verify_hostname) {
  17594. if (!session || !hostname) return false;
  17595. auto ssl = static_cast<SSL *>(session);
  17596. // The handshake's chain verification then checks the name as well
  17597. if (verify_hostname) {
  17598. auto param = SSL_get0_param(ssl);
  17599. X509_VERIFY_PARAM_set_hostflags(param, X509_CHECK_FLAG_NEVER_CHECK_SUBJECT);
  17600. if (X509_VERIFY_PARAM_set1_host(param, hostname, strlen(hostname)) != 1) {
  17601. return false;
  17602. }
  17603. }
  17604. #if defined(OPENSSL_IS_BORINGSSL)
  17605. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  17606. #else
  17607. // Direct call instead of macro to suppress -Wold-style-cast warning
  17608. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  17609. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  17610. #endif
  17611. }
  17612. inline TlsError connect(session_t session) {
  17613. if (!session) { return TlsError(); }
  17614. auto ssl = static_cast<SSL *>(session);
  17615. auto ret = SSL_connect(ssl);
  17616. TlsError err;
  17617. if (ret == 1) {
  17618. err.code = ErrorCode::Success;
  17619. } else {
  17620. impl::fill_connect_error(ssl, ret, err);
  17621. }
  17622. return err;
  17623. }
  17624. inline TlsError accept(session_t session) {
  17625. if (!session) { return TlsError(); }
  17626. auto ssl = static_cast<SSL *>(session);
  17627. auto ret = SSL_accept(ssl);
  17628. TlsError err;
  17629. if (ret == 1) {
  17630. err.code = ErrorCode::Success;
  17631. } else {
  17632. auto ssl_err = SSL_get_error(ssl, ret);
  17633. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17634. err.backend_code = ERR_get_error();
  17635. }
  17636. return err;
  17637. }
  17638. inline bool connect_nonblocking(session_t session, socket_t sock,
  17639. time_t timeout_sec, time_t timeout_usec,
  17640. TlsError *err,
  17641. const std::function<bool()> &interrupted) {
  17642. if (!session) {
  17643. if (err) { err->code = ErrorCode::Fatal; }
  17644. return false;
  17645. }
  17646. auto ssl = static_cast<SSL *>(session);
  17647. auto bio = SSL_get_rbio(ssl);
  17648. // Set non-blocking mode for handshake
  17649. detail::set_nonblocking(sock, true);
  17650. if (bio) { BIO_set_nbio(bio, 1); }
  17651. auto cleanup = detail::scope_exit([&]() {
  17652. // Restore blocking mode after handshake
  17653. if (bio) { BIO_set_nbio(bio, 0); }
  17654. detail::set_nonblocking(sock, false);
  17655. });
  17656. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17657. auto res = 0;
  17658. while ((res = SSL_connect(ssl)) != 1) {
  17659. auto ssl_err = SSL_get_error(ssl, res);
  17660. switch (ssl_err) {
  17661. case SSL_ERROR_WANT_READ:
  17662. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  17663. continue;
  17664. }
  17665. break;
  17666. case SSL_ERROR_WANT_WRITE:
  17667. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  17668. continue;
  17669. }
  17670. break;
  17671. default: break;
  17672. }
  17673. if (err) { impl::fill_connect_error(ssl, res, *err); }
  17674. return false;
  17675. }
  17676. if (err) { err->code = ErrorCode::Success; }
  17677. return true;
  17678. }
  17679. inline bool accept_nonblocking(session_t session, socket_t sock,
  17680. time_t timeout_sec, time_t timeout_usec,
  17681. TlsError *err) {
  17682. if (!session) {
  17683. if (err) { err->code = ErrorCode::Fatal; }
  17684. return false;
  17685. }
  17686. auto ssl = static_cast<SSL *>(session);
  17687. auto bio = SSL_get_rbio(ssl);
  17688. // Set non-blocking mode for handshake
  17689. detail::set_nonblocking(sock, true);
  17690. if (bio) { BIO_set_nbio(bio, 1); }
  17691. auto cleanup = detail::scope_exit([&]() {
  17692. // Restore blocking mode after handshake
  17693. if (bio) { BIO_set_nbio(bio, 0); }
  17694. detail::set_nonblocking(sock, false);
  17695. });
  17696. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17697. auto res = 0;
  17698. while ((res = SSL_accept(ssl)) != 1) {
  17699. auto ssl_err = SSL_get_error(ssl, res);
  17700. switch (ssl_err) {
  17701. case SSL_ERROR_WANT_READ:
  17702. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17703. break;
  17704. case SSL_ERROR_WANT_WRITE:
  17705. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17706. break;
  17707. default: break;
  17708. }
  17709. if (err) {
  17710. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17711. err->backend_code = ERR_get_error();
  17712. }
  17713. return false;
  17714. }
  17715. if (err) { err->code = ErrorCode::Success; }
  17716. return true;
  17717. }
  17718. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17719. if (!session || !buf) {
  17720. err.code = ErrorCode::Fatal;
  17721. return -1;
  17722. }
  17723. auto ssl = static_cast<SSL *>(session);
  17724. constexpr auto max_len =
  17725. static_cast<size_t>((std::numeric_limits<int>::max)());
  17726. if (len > max_len) { len = max_len; }
  17727. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17728. if (ret > 0) {
  17729. err.code = ErrorCode::Success;
  17730. return ret;
  17731. }
  17732. auto ssl_err = SSL_get_error(ssl, ret);
  17733. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17734. if (err.code == ErrorCode::PeerClosed) {
  17735. return 0;
  17736. } // Gracefully handle the peer closed state.
  17737. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17738. return -1;
  17739. }
  17740. inline ssize_t write(session_t session, const void *buf, size_t len,
  17741. TlsError &err) {
  17742. if (!session || !buf) {
  17743. err.code = ErrorCode::Fatal;
  17744. return -1;
  17745. }
  17746. auto ssl = static_cast<SSL *>(session);
  17747. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17748. if (ret > 0) {
  17749. err.code = ErrorCode::Success;
  17750. return ret;
  17751. }
  17752. auto ssl_err = SSL_get_error(ssl, ret);
  17753. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17754. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17755. return -1;
  17756. }
  17757. inline int pending(const_session_t session) {
  17758. if (!session) return 0;
  17759. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17760. }
  17761. inline void shutdown(session_t session, bool graceful) {
  17762. if (!session) return;
  17763. auto ssl = static_cast<SSL *>(session);
  17764. if (graceful) {
  17765. // Send close_notify without waiting for the peer's. The connection is
  17766. // closed right after this, so a unidirectional shutdown is enough, and an
  17767. // idle peer that never answers would otherwise hold this thread until the
  17768. // read timeout. The other backends do not wait either.
  17769. SSL_shutdown(ssl);
  17770. }
  17771. }
  17772. inline bool is_peer_closed(session_t session, socket_t sock) {
  17773. if (!session) return true;
  17774. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17775. detail::set_nonblocking(sock, true);
  17776. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17777. auto ssl = static_cast<SSL *>(session);
  17778. char buf;
  17779. auto ret = SSL_peek(ssl, &buf, 1);
  17780. if (ret > 0) return false;
  17781. auto err = SSL_get_error(ssl, ret);
  17782. return err == SSL_ERROR_ZERO_RETURN;
  17783. }
  17784. inline cert_t get_peer_cert(const_session_t session) {
  17785. if (!session) return nullptr;
  17786. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17787. static_cast<SSL *>(const_cast<void *>(session))));
  17788. }
  17789. inline size_t get_peer_certs(const_session_t session,
  17790. std::vector<cert_t> &certs) {
  17791. certs.clear();
  17792. if (!session) { return 0; }
  17793. auto ssl = static_cast<const SSL *>(session);
  17794. // On the server side, the chain leaves out the peer's own certificate
  17795. if (SSL_is_server(ssl)) {
  17796. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17797. }
  17798. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  17799. auto count = sk_X509_num(sk);
  17800. for (decltype(count) i = 0; i < count; i++) {
  17801. auto x509 = sk_X509_value(sk, i);
  17802. X509_up_ref(x509);
  17803. certs.push_back(static_cast<cert_t>(x509));
  17804. }
  17805. }
  17806. return certs.size();
  17807. }
  17808. inline void free_cert(cert_t cert) {
  17809. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17810. }
  17811. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17812. if (!cert || !hostname) return false;
  17813. auto x509 = static_cast<X509 *>(cert);
  17814. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17815. if (detail::is_ip_address(hostname)) {
  17816. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17817. }
  17818. return X509_check_host(x509, hostname, strlen(hostname),
  17819. X509_CHECK_FLAG_NEVER_CHECK_SUBJECT, nullptr) == 1;
  17820. }
  17821. inline uint64_t hostname_mismatch_code() {
  17822. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17823. }
  17824. inline long get_verify_result(const_session_t session) {
  17825. if (!session) return X509_V_ERR_UNSPECIFIED;
  17826. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17827. }
  17828. inline std::string get_cert_subject_cn(cert_t cert) {
  17829. if (!cert) return "";
  17830. auto x509 = static_cast<X509 *>(cert);
  17831. auto subject_name = X509_get_subject_name(x509);
  17832. if (!subject_name) return "";
  17833. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17834. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17835. if (idx < 0) return "";
  17836. auto entry = X509_NAME_get_entry(subject_name, idx);
  17837. if (!entry) return "";
  17838. auto data = X509_NAME_ENTRY_get_data(entry);
  17839. if (!data) return "";
  17840. return std::string(
  17841. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17842. static_cast<size_t>(ASN1_STRING_length(data)));
  17843. }
  17844. inline std::string get_cert_issuer_name(cert_t cert) {
  17845. if (!cert) return "";
  17846. auto x509 = static_cast<X509 *>(cert);
  17847. auto issuer_name = X509_get_issuer_name(x509);
  17848. if (!issuer_name) return "";
  17849. char buf[256];
  17850. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17851. return std::string(buf);
  17852. }
  17853. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17854. sans.clear();
  17855. if (!cert) return false;
  17856. auto x509 = static_cast<X509 *>(cert);
  17857. auto names = static_cast<GENERAL_NAMES *>(
  17858. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17859. if (!names) return true; // No SANs is valid
  17860. auto count = sk_GENERAL_NAME_num(names);
  17861. for (decltype(count) i = 0; i < count; i++) {
  17862. auto gen = sk_GENERAL_NAME_value(names, i);
  17863. if (!gen) continue;
  17864. SanEntry entry;
  17865. switch (gen->type) {
  17866. case GEN_DNS:
  17867. entry.type = SanType::DNS;
  17868. if (gen->d.dNSName) {
  17869. entry.value = std::string(
  17870. reinterpret_cast<const char *>(
  17871. ASN1_STRING_get0_data(gen->d.dNSName)),
  17872. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17873. }
  17874. break;
  17875. case GEN_IPADD:
  17876. entry.type = SanType::IP;
  17877. if (gen->d.iPAddress) {
  17878. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17879. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17880. if (len == 4) {
  17881. // IPv4
  17882. char buf[INET_ADDRSTRLEN];
  17883. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17884. entry.value = buf;
  17885. } else if (len == 16) {
  17886. // IPv6
  17887. char buf[INET6_ADDRSTRLEN];
  17888. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17889. entry.value = buf;
  17890. }
  17891. }
  17892. break;
  17893. case GEN_EMAIL:
  17894. entry.type = SanType::EMAIL;
  17895. if (gen->d.rfc822Name) {
  17896. entry.value = std::string(
  17897. reinterpret_cast<const char *>(
  17898. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17899. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17900. }
  17901. break;
  17902. case GEN_URI:
  17903. entry.type = SanType::URI;
  17904. if (gen->d.uniformResourceIdentifier) {
  17905. entry.value = std::string(
  17906. reinterpret_cast<const char *>(
  17907. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17908. static_cast<size_t>(
  17909. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17910. }
  17911. break;
  17912. default: entry.type = SanType::OTHER; break;
  17913. }
  17914. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17915. }
  17916. GENERAL_NAMES_free(names);
  17917. return true;
  17918. }
  17919. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17920. time_t &not_after) {
  17921. if (!cert) return false;
  17922. auto x509 = static_cast<X509 *>(cert);
  17923. auto nb = X509_get0_notBefore(x509);
  17924. auto na = X509_get0_notAfter(x509);
  17925. if (!nb || !na) return false;
  17926. ASN1_TIME *epoch = ASN1_TIME_new();
  17927. if (!epoch) return false;
  17928. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17929. if (!ASN1_TIME_set(epoch, 0)) return false;
  17930. int pday, psec;
  17931. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17932. not_before = 86400 * (time_t)pday + psec;
  17933. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17934. not_after = 86400 * (time_t)pday + psec;
  17935. return true;
  17936. }
  17937. inline std::string get_cert_serial(cert_t cert) {
  17938. if (!cert) return "";
  17939. auto x509 = static_cast<X509 *>(cert);
  17940. auto serial = X509_get_serialNumber(x509);
  17941. if (!serial) return "";
  17942. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17943. if (!bn) return "";
  17944. auto hex = BN_bn2hex(bn);
  17945. BN_free(bn);
  17946. if (!hex) return "";
  17947. std::string result(hex);
  17948. OPENSSL_free(hex);
  17949. return result;
  17950. }
  17951. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17952. if (!cert) return false;
  17953. auto x509 = static_cast<X509 *>(cert);
  17954. auto len = i2d_X509(x509, nullptr);
  17955. if (len < 0) return false;
  17956. der.resize(static_cast<size_t>(len));
  17957. auto p = der.data();
  17958. i2d_X509(x509, &p);
  17959. return true;
  17960. }
  17961. inline const char *get_sni(const_session_t session) {
  17962. if (!session) return nullptr;
  17963. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17964. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17965. }
  17966. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17967. inline uint64_t get_error() { return ERR_get_error(); }
  17968. inline std::string error_string(uint64_t code) {
  17969. char buf[256];
  17970. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  17971. sizeof(buf));
  17972. return std::string(buf);
  17973. }
  17974. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17975. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17976. if (!mem) { return nullptr; }
  17977. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17978. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17979. if (!inf) { return nullptr; }
  17980. auto store = X509_STORE_new();
  17981. if (store) {
  17982. auto count = sk_X509_INFO_num(inf);
  17983. for (decltype(count) i = 0; i < count; i++) {
  17984. auto itmp = sk_X509_INFO_value(inf, i);
  17985. if (!itmp) { continue; }
  17986. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17987. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17988. }
  17989. }
  17990. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17991. return static_cast<ca_store_t>(store);
  17992. }
  17993. inline void free_ca_store(ca_store_t store) {
  17994. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17995. }
  17996. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17997. if (!ctx || !store) { return false; }
  17998. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17999. auto x509_store = static_cast<X509_STORE *>(store);
  18000. // Check if same store is already set
  18001. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  18002. // SSL_CTX_set_cert_store takes ownership and frees the old store
  18003. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  18004. return true;
  18005. }
  18006. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18007. certs.clear();
  18008. if (!ctx) { return 0; }
  18009. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18010. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  18011. if (!store) { return 0; }
  18012. auto objs = impl::get_store_objects(store);
  18013. if (!objs) { return 0; }
  18014. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  18015. auto count = sk_X509_OBJECT_num(objs);
  18016. for (decltype(count) i = 0; i < count; i++) {
  18017. auto obj = sk_X509_OBJECT_value(objs, i);
  18018. if (!obj) { continue; }
  18019. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  18020. auto x509 = X509_OBJECT_get0_X509(obj);
  18021. if (x509) {
  18022. // Increment reference count so caller can free it
  18023. X509_up_ref(x509);
  18024. certs.push_back(static_cast<cert_t>(x509));
  18025. }
  18026. }
  18027. }
  18028. return certs.size();
  18029. }
  18030. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18031. std::vector<std::string> names;
  18032. if (!ctx) { return names; }
  18033. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18034. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  18035. if (!store) { return names; }
  18036. auto objs = impl::get_store_objects(store);
  18037. if (!objs) { return names; }
  18038. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  18039. auto count = sk_X509_OBJECT_num(objs);
  18040. for (decltype(count) i = 0; i < count; i++) {
  18041. auto obj = sk_X509_OBJECT_value(objs, i);
  18042. if (!obj) { continue; }
  18043. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  18044. auto x509 = X509_OBJECT_get0_X509(obj);
  18045. if (x509) {
  18046. auto subject = X509_get_subject_name(x509);
  18047. if (subject) {
  18048. char buf[512];
  18049. X509_NAME_oneline(subject, buf, sizeof(buf));
  18050. names.push_back(buf);
  18051. }
  18052. }
  18053. }
  18054. }
  18055. return names;
  18056. }
  18057. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18058. const char *key_pem, const char *password) {
  18059. if (!ctx || !cert_pem || !key_pem) { return false; }
  18060. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18061. // Load certificate from PEM
  18062. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  18063. if (!cert_bio) { return false; }
  18064. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  18065. BIO_free(cert_bio);
  18066. if (!cert) { return false; }
  18067. // Load private key from PEM
  18068. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  18069. if (!key_bio) {
  18070. X509_free(cert);
  18071. return false;
  18072. }
  18073. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  18074. password ? const_cast<char *>(password)
  18075. : nullptr);
  18076. BIO_free(key_bio);
  18077. if (!key) {
  18078. X509_free(cert);
  18079. return false;
  18080. }
  18081. // Update certificate and key
  18082. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  18083. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  18084. X509_free(cert);
  18085. EVP_PKEY_free(key);
  18086. return ret;
  18087. }
  18088. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18089. if (!ctx || !ca_pem) { return false; }
  18090. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18091. // Create new X509_STORE from PEM
  18092. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  18093. if (!store) { return false; }
  18094. // A resumed session is not verified again, so the ticket keys from before
  18095. // go, or a client verified under the old CAs could go on resuming.
  18096. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  18097. unsigned char ticket_keys[48];
  18098. #else
  18099. unsigned char ticket_keys[80];
  18100. #endif
  18101. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  18102. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  18103. sizeof(ticket_keys)) != 1) {
  18104. free_ca_store(store);
  18105. return false;
  18106. }
  18107. // SSL_CTX_set_cert_store takes ownership
  18108. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  18109. // Set client CA list for client certificate request
  18110. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  18111. if (ca_list) {
  18112. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  18113. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  18114. }
  18115. // The cached sessions go for the same reason.
  18116. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  18117. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  18118. #else
  18119. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  18120. #endif
  18121. return true;
  18122. }
  18123. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18124. if (!ctx) { return false; }
  18125. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18126. auto index = impl::verify_callback_index();
  18127. if (index < 0) { return false; }
  18128. std::shared_ptr<VerifyCallback> *stored = nullptr;
  18129. if (callback) {
  18130. stored = new std::shared_ptr<VerifyCallback>(
  18131. std::make_shared<VerifyCallback>(std::move(callback)));
  18132. }
  18133. std::shared_ptr<VerifyCallback> *previous = nullptr;
  18134. {
  18135. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  18136. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  18137. SSL_CTX_get_ex_data(ssl_ctx, index));
  18138. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  18139. delete stored;
  18140. return false;
  18141. }
  18142. }
  18143. // A handshake running the previous callback keeps it until it returns.
  18144. delete previous;
  18145. // A resumed handshake shows no certificate to run the callback on.
  18146. if (stored) {
  18147. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  18148. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  18149. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  18150. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  18151. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  18152. #endif
  18153. }
  18154. // Keep requiring the peer's certificate if set_verify_client() asked for it
  18155. auto require =
  18156. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  18157. impl::apply_verify_mode(ssl_ctx, require);
  18158. return true;
  18159. }
  18160. inline long get_verify_error(const_session_t session) {
  18161. if (!session) { return -1; }
  18162. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  18163. return SSL_get_verify_result(ssl);
  18164. }
  18165. inline std::string verify_error_string(long error_code) {
  18166. if (error_code == X509_V_OK) { return ""; }
  18167. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  18168. return str ? str : "unknown error";
  18169. }
  18170. } // namespace tls
  18171. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  18172. /*
  18173. * Group 9: TLS abstraction layer - Mbed TLS backend
  18174. */
  18175. /*
  18176. * Mbed TLS Backend Implementation
  18177. */
  18178. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  18179. namespace tls {
  18180. namespace impl {
  18181. // Mbed TLS session wrapper
  18182. struct MbedTlsSession {
  18183. mbedtls_ssl_context ssl;
  18184. socket_t sock = INVALID_SOCKET;
  18185. std::string hostname; // For client: set via set_sni
  18186. std::string sni_hostname; // For server: received from client via SNI callback
  18187. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  18188. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  18189. // (e.g. a response that arrived while this side was still in its post-write
  18190. // check), the byte is pushed back here and served by the next read().
  18191. unsigned char peeked_byte = 0;
  18192. bool has_peeked_byte = false;
  18193. // Set by set_sni() when the caller disabled hostname verification, so the
  18194. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  18195. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  18196. // OpenSSL and wolfSSL keep them independent).
  18197. bool suppress_hostname_mismatch = false;
  18198. // Copied from the owning MbedTlsContext at creation, so a handshake only
  18199. // ever runs the callback of its own context.
  18200. VerifyCallback verify_callback;
  18201. bool is_server = false;
  18202. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  18203. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  18204. MbedTlsSession(const MbedTlsSession &) = delete;
  18205. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  18206. };
  18207. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  18208. // queue)
  18209. inline int &mbedtls_last_error() {
  18210. static thread_local int err = 0;
  18211. return err;
  18212. }
  18213. // Helper to map Mbed TLS error to ErrorCode
  18214. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  18215. uint32_t verify_flags) {
  18216. if (ret == 0) { return ErrorCode::Success; }
  18217. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  18218. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  18219. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  18220. return ErrorCode::PeerClosed;
  18221. }
  18222. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  18223. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  18224. out_errno = errno;
  18225. return ErrorCode::SyscallError;
  18226. }
  18227. if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
  18228. // EOF without close_notify
  18229. out_errno = 0;
  18230. return ErrorCode::SyscallError;
  18231. }
  18232. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  18233. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  18234. // the handshake's chain verification (see set_sni()); a mismatch there
  18235. // is reported the same way as any other verify_flags bit. Report it as
  18236. // HostnameMismatch, matching the other backends and the post-handshake
  18237. // identity check below, but only when naming is the sole problem -
  18238. // if the chain itself is also untrusted/expired/etc., that takes
  18239. // priority over the naming detail.
  18240. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  18241. return ErrorCode::HostnameMismatch;
  18242. }
  18243. return ErrorCode::CertVerifyFailed;
  18244. }
  18245. return ErrorCode::Fatal;
  18246. }
  18247. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  18248. // return value, including the verify-flags-dependent HostnameMismatch
  18249. // mapping; shared by connect() and connect_nonblocking() so the
  18250. // backend_code policy for that mapping only lives in one place.
  18251. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  18252. int ret) {
  18253. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  18254. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  18255. err.backend_code = err.code == ErrorCode::HostnameMismatch
  18256. ? static_cast<uint64_t>(verify_flags)
  18257. : static_cast<uint64_t>(-ret);
  18258. }
  18259. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  18260. // non-fatal notification delivered between records, not an error and not
  18261. // application data, so I/O calls that see it should just be retried. Kept in
  18262. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  18263. // splitting the closing brace across an #if.
  18264. inline bool mbedtls_is_session_ticket(int ret) {
  18265. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  18266. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  18267. #else
  18268. (void)ret;
  18269. return false;
  18270. #endif
  18271. }
  18272. // BIO-like send callback for Mbed TLS
  18273. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  18274. size_t len) {
  18275. auto sock = *static_cast<socket_t *>(ctx);
  18276. #ifdef _WIN32
  18277. auto ret =
  18278. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  18279. if (ret == SOCKET_ERROR) {
  18280. int err = WSAGetLastError();
  18281. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  18282. return MBEDTLS_ERR_NET_SEND_FAILED;
  18283. }
  18284. #else
  18285. auto ret = send(sock, buf, len, 0);
  18286. if (ret < 0) {
  18287. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18288. return MBEDTLS_ERR_SSL_WANT_WRITE;
  18289. }
  18290. return MBEDTLS_ERR_NET_SEND_FAILED;
  18291. }
  18292. #endif
  18293. return static_cast<int>(ret);
  18294. }
  18295. // BIO-like recv callback for Mbed TLS
  18296. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  18297. auto sock = *static_cast<socket_t *>(ctx);
  18298. #ifdef _WIN32
  18299. auto ret =
  18300. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  18301. if (ret == SOCKET_ERROR) {
  18302. int err = WSAGetLastError();
  18303. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  18304. return MBEDTLS_ERR_NET_RECV_FAILED;
  18305. }
  18306. #else
  18307. auto ret = recv(sock, buf, len, 0);
  18308. if (ret < 0) {
  18309. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18310. return MBEDTLS_ERR_SSL_WANT_READ;
  18311. }
  18312. return MBEDTLS_ERR_NET_RECV_FAILED;
  18313. }
  18314. #endif
  18315. // EOF is MBEDTLS_ERR_SSL_CONN_EOF; only a close_notify is a clean end
  18316. return static_cast<int>(ret);
  18317. }
  18318. // MbedTlsContext constructor/destructor implementations
  18319. inline MbedTlsContext::MbedTlsContext() {
  18320. mbedtls_ssl_config_init(&conf);
  18321. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18322. mbedtls_entropy_init(&entropy);
  18323. mbedtls_ctr_drbg_init(&ctr_drbg);
  18324. #endif
  18325. mbedtls_x509_crt_init(&ca_chain);
  18326. mbedtls_x509_crt_init(&own_cert);
  18327. mbedtls_pk_init(&own_key);
  18328. }
  18329. inline MbedTlsContext::~MbedTlsContext() {
  18330. mbedtls_pk_free(&own_key);
  18331. mbedtls_x509_crt_free(&own_cert);
  18332. mbedtls_x509_crt_free(&ca_chain);
  18333. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18334. mbedtls_ctr_drbg_free(&ctr_drbg);
  18335. mbedtls_entropy_free(&entropy);
  18336. #endif
  18337. mbedtls_ssl_config_free(&conf);
  18338. }
  18339. // Thread-local storage for SNI captured during handshake
  18340. // This is needed because the SNI callback doesn't have a way to pass
  18341. // session-specific data before the session is fully set up
  18342. inline std::string &mbedpending_sni() {
  18343. static thread_local std::string sni;
  18344. return sni;
  18345. }
  18346. // SNI callback for Mbed TLS server to capture client's SNI hostname
  18347. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  18348. const unsigned char *name, size_t name_len) {
  18349. (void)p_ctx;
  18350. (void)ssl;
  18351. // Store SNI name in thread-local storage
  18352. // It will be retrieved and stored in the session after handshake
  18353. if (name && name_len > 0) {
  18354. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  18355. } else {
  18356. mbedpending_sni().clear();
  18357. }
  18358. return 0; // Accept any SNI
  18359. }
  18360. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  18361. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  18362. }
  18363. // MbedTLS verify callback wrapper
  18364. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  18365. int cert_depth, uint32_t *flags) {
  18366. // data points to the MbedTlsSession
  18367. auto *session = static_cast<MbedTlsSession *>(data);
  18368. // set_sni() disabled hostname verification for this session: ignore the
  18369. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  18370. // pass/fail decision still comes from the remaining flags (and, below, from
  18371. // the user's own verify callback).
  18372. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  18373. const auto &callback = session->verify_callback;
  18374. if (!callback) { return 0; } // Continue with default verification
  18375. // Build context
  18376. VerifyContext verify_ctx;
  18377. verify_ctx.session = static_cast<session_t>(session);
  18378. verify_ctx.cert = static_cast<cert_t>(crt);
  18379. verify_ctx.depth = cert_depth;
  18380. verify_ctx.preverify_ok = (*flags == 0);
  18381. verify_ctx.error_code = static_cast<long>(*flags);
  18382. // Convert Mbed TLS flags to error string
  18383. static thread_local char error_buf[256];
  18384. if (*flags != 0) {
  18385. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  18386. verify_ctx.error_string = error_buf;
  18387. } else {
  18388. verify_ctx.error_string = nullptr;
  18389. }
  18390. bool accepted = run_verify_callback(callback, verify_ctx);
  18391. if (accepted) {
  18392. // Overrides the built-in verification only on a server, as on OpenSSL and
  18393. // wolfSSL, whose clients check the verify result after the handshake
  18394. if (session->is_server) { *flags = 0; }
  18395. return 0;
  18396. }
  18397. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  18398. }
  18399. // Sets the authentication mode from whether the peer's certificate is required
  18400. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  18401. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  18402. inline void apply_verify_mode(MbedTlsContext &mctx) {
  18403. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  18404. if (mctx.verify_client) {
  18405. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  18406. } else if (mctx.verify_callback) {
  18407. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  18408. }
  18409. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  18410. }
  18411. } // namespace impl
  18412. inline ctx_t create_client_context() {
  18413. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18414. if (!ctx) { return nullptr; }
  18415. ctx->is_server = false;
  18416. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18417. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18418. if (!detail::ensure_mbedtls_psa_crypto()) {
  18419. delete ctx;
  18420. return nullptr;
  18421. }
  18422. int ret;
  18423. #else
  18424. // Seed the random number generator
  18425. const char *pers = "httplib_client";
  18426. int ret = mbedtls_ctr_drbg_seed(
  18427. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18428. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18429. if (ret != 0) {
  18430. impl::mbedtls_last_error() = ret;
  18431. delete ctx;
  18432. return nullptr;
  18433. }
  18434. #endif
  18435. // Set up SSL config for client
  18436. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  18437. MBEDTLS_SSL_TRANSPORT_STREAM,
  18438. MBEDTLS_SSL_PRESET_DEFAULT);
  18439. if (ret != 0) {
  18440. impl::mbedtls_last_error() = ret;
  18441. delete ctx;
  18442. return nullptr;
  18443. }
  18444. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18445. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18446. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18447. #endif
  18448. // Default: verify peer certificate
  18449. ctx->verify_client = true;
  18450. impl::apply_verify_mode(*ctx);
  18451. // Set minimum TLS version to 1.2
  18452. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18453. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18454. #else
  18455. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18456. MBEDTLS_SSL_MINOR_VERSION_3);
  18457. #endif
  18458. return static_cast<ctx_t>(ctx);
  18459. }
  18460. inline ctx_t create_server_context() {
  18461. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18462. if (!ctx) { return nullptr; }
  18463. ctx->is_server = true;
  18464. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18465. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18466. if (!detail::ensure_mbedtls_psa_crypto()) {
  18467. delete ctx;
  18468. return nullptr;
  18469. }
  18470. int ret;
  18471. #else
  18472. // Seed the random number generator
  18473. const char *pers = "httplib_server";
  18474. int ret = mbedtls_ctr_drbg_seed(
  18475. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18476. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18477. if (ret != 0) {
  18478. impl::mbedtls_last_error() = ret;
  18479. delete ctx;
  18480. return nullptr;
  18481. }
  18482. #endif
  18483. // Set up SSL config for server
  18484. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  18485. MBEDTLS_SSL_TRANSPORT_STREAM,
  18486. MBEDTLS_SSL_PRESET_DEFAULT);
  18487. if (ret != 0) {
  18488. impl::mbedtls_last_error() = ret;
  18489. delete ctx;
  18490. return nullptr;
  18491. }
  18492. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18493. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18494. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18495. #endif
  18496. // Default: don't verify client
  18497. impl::apply_verify_mode(*ctx);
  18498. // Set minimum TLS version to 1.2
  18499. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18500. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18501. #else
  18502. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18503. MBEDTLS_SSL_MINOR_VERSION_3);
  18504. #endif
  18505. // Set SNI callback to capture client's SNI hostname
  18506. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  18507. return static_cast<ctx_t>(ctx);
  18508. }
  18509. inline void free_context(ctx_t ctx) {
  18510. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  18511. }
  18512. inline bool set_min_version(ctx_t ctx, Version version) {
  18513. if (!ctx) { return false; }
  18514. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18515. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18516. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  18517. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  18518. if (version >= Version::TLS1_3) {
  18519. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18520. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  18521. #endif
  18522. }
  18523. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  18524. #else
  18525. // Mbed TLS 2.x uses major/minor version numbers
  18526. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  18527. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  18528. if (version >= Version::TLS1_3) {
  18529. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18530. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  18531. #else
  18532. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  18533. #endif
  18534. }
  18535. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  18536. #endif
  18537. return true;
  18538. }
  18539. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18540. if (!ctx || !pem) { return false; }
  18541. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18542. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  18543. // Add null terminator if not present
  18544. std::string pem_str(pem, len);
  18545. int ret = mbedtls_x509_crt_parse(
  18546. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18547. pem_str.size() + 1);
  18548. if (ret != 0) {
  18549. impl::mbedtls_last_error() = ret;
  18550. return false;
  18551. }
  18552. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18553. return true;
  18554. }
  18555. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18556. if (!ctx || !file_path) { return false; }
  18557. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18558. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  18559. if (ret != 0) {
  18560. impl::mbedtls_last_error() = ret;
  18561. return false;
  18562. }
  18563. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18564. return true;
  18565. }
  18566. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18567. if (!ctx || !dir_path) { return false; }
  18568. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18569. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  18570. if (ret < 0) { // Returns number of certs on success, negative on error
  18571. impl::mbedtls_last_error() = ret;
  18572. return false;
  18573. }
  18574. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18575. return true;
  18576. }
  18577. inline bool load_system_certs(ctx_t ctx) {
  18578. if (!ctx) { return false; }
  18579. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18580. bool loaded = false;
  18581. #ifdef _WIN32
  18582. loaded = impl::enumerate_windows_system_certs(
  18583. [&](const unsigned char *data, size_t len) {
  18584. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18585. });
  18586. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18587. loaded = impl::enumerate_macos_keychain_certs(
  18588. [&](const unsigned char *data, size_t len) {
  18589. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18590. });
  18591. #else
  18592. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18593. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  18594. loaded = true;
  18595. break;
  18596. }
  18597. }
  18598. if (!loaded) {
  18599. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18600. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  18601. loaded = true;
  18602. break;
  18603. }
  18604. }
  18605. }
  18606. #endif
  18607. if (loaded) {
  18608. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18609. }
  18610. return loaded;
  18611. }
  18612. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18613. const char *password) {
  18614. if (!ctx || !cert || !key) { return false; }
  18615. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18616. // Parse certificate
  18617. std::string cert_str(cert);
  18618. int ret = mbedtls_x509_crt_parse(
  18619. &mctx->own_cert,
  18620. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  18621. cert_str.size() + 1);
  18622. if (ret != 0) {
  18623. impl::mbedtls_last_error() = ret;
  18624. return false;
  18625. }
  18626. // Parse private key
  18627. std::string key_str(key);
  18628. const unsigned char *pwd =
  18629. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  18630. size_t pwd_len = password ? strlen(password) : 0;
  18631. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18632. ret = mbedtls_pk_parse_key(
  18633. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18634. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  18635. &mctx->ctr_drbg);
  18636. #else
  18637. ret = mbedtls_pk_parse_key(
  18638. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18639. key_str.size() + 1, pwd, pwd_len);
  18640. #endif
  18641. if (ret != 0) {
  18642. impl::mbedtls_last_error() = ret;
  18643. return false;
  18644. }
  18645. // Verify that the certificate and private key match.
  18646. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  18647. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  18648. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18649. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18650. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18651. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18652. #else
  18653. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18654. #endif
  18655. if (ret != 0) {
  18656. impl::mbedtls_last_error() = ret;
  18657. return false;
  18658. }
  18659. #endif
  18660. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18661. if (ret != 0) {
  18662. impl::mbedtls_last_error() = ret;
  18663. return false;
  18664. }
  18665. return true;
  18666. }
  18667. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18668. const char *key_path, const char *password) {
  18669. if (!ctx || !cert_path || !key_path) { return false; }
  18670. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18671. // Parse certificate file
  18672. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  18673. if (ret != 0) {
  18674. impl::mbedtls_last_error() = ret;
  18675. return false;
  18676. }
  18677. // Parse private key file
  18678. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18679. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  18680. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18681. #else
  18682. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  18683. #endif
  18684. if (ret != 0) {
  18685. impl::mbedtls_last_error() = ret;
  18686. return false;
  18687. }
  18688. // Verify that the certificate and private key match.
  18689. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  18690. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18691. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18692. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18693. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18694. #else
  18695. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18696. #endif
  18697. if (ret != 0) {
  18698. impl::mbedtls_last_error() = ret;
  18699. return false;
  18700. }
  18701. #endif
  18702. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18703. if (ret != 0) {
  18704. impl::mbedtls_last_error() = ret;
  18705. return false;
  18706. }
  18707. return true;
  18708. }
  18709. inline void set_verify_client(ctx_t ctx, bool require) {
  18710. if (!ctx) { return; }
  18711. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18712. mctx->verify_client = require;
  18713. impl::apply_verify_mode(*mctx);
  18714. }
  18715. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18716. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18717. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18718. auto session = new (std::nothrow) impl::MbedTlsSession();
  18719. if (!session) { return nullptr; }
  18720. session->sock = sock;
  18721. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18722. if (ret != 0) {
  18723. impl::mbedtls_last_error() = ret;
  18724. delete session;
  18725. return nullptr;
  18726. }
  18727. // Explicitly opt out of in-handshake hostname verification by default;
  18728. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18729. // fails outright when no hostname was set. set_sni() installs the real
  18730. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18731. // caller verifies the certificate identity post-handshake via
  18732. // verify_hostname().
  18733. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18734. // Set BIO callbacks
  18735. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18736. impl::mbedtls_net_recv_cb, nullptr);
  18737. // Installed always, as it also masks the hostname mismatch that set_sni()
  18738. // may ask for. The session runs its own copy of the user's callback, which
  18739. // set_verify_callback() cannot replace under a handshake.
  18740. session->verify_callback = mctx->verify_callback;
  18741. session->is_server = mctx->is_server;
  18742. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  18743. return static_cast<session_t>(session);
  18744. }
  18745. inline void free_session(session_t session) {
  18746. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18747. }
  18748. inline bool set_sni(session_t session, const char *hostname,
  18749. bool verify_hostname) {
  18750. if (!session || !hostname) { return false; }
  18751. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18752. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18753. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18754. // independently, so a disabled hostname check is handled below by masking
  18755. // the resulting mismatch flag instead of skipping this call.
  18756. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18757. if (ret != 0) {
  18758. impl::mbedtls_last_error() = ret;
  18759. return false;
  18760. }
  18761. msession->hostname = hostname;
  18762. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  18763. return true;
  18764. }
  18765. inline TlsError connect(session_t session) {
  18766. TlsError err;
  18767. if (!session) {
  18768. err.code = ErrorCode::Fatal;
  18769. return err;
  18770. }
  18771. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18772. int ret;
  18773. do {
  18774. ret = mbedtls_ssl_handshake(&msession->ssl);
  18775. } while (impl::mbedtls_is_session_ticket(ret));
  18776. if (ret == 0) {
  18777. err.code = ErrorCode::Success;
  18778. } else {
  18779. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18780. impl::mbedtls_last_error() = ret;
  18781. }
  18782. return err;
  18783. }
  18784. inline TlsError accept(session_t session) {
  18785. // A failed handshake leaves its SNI behind, so start without it
  18786. impl::mbedpending_sni().clear();
  18787. // Same as connect for Mbed TLS - handshake works for both client and server
  18788. auto result = connect(session);
  18789. // After successful handshake, capture SNI from thread-local storage
  18790. if (result.code == ErrorCode::Success && session) {
  18791. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18792. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18793. }
  18794. return result;
  18795. }
  18796. inline bool connect_nonblocking(session_t session, socket_t sock,
  18797. time_t timeout_sec, time_t timeout_usec,
  18798. TlsError *err,
  18799. const std::function<bool()> &interrupted) {
  18800. if (!session) {
  18801. if (err) { err->code = ErrorCode::Fatal; }
  18802. return false;
  18803. }
  18804. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18805. // Set socket to non-blocking mode
  18806. detail::set_nonblocking(sock, true);
  18807. auto cleanup =
  18808. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18809. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18810. int ret;
  18811. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18812. // Non-fatal TLS 1.3 ticket; retry immediately.
  18813. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18814. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18815. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  18816. continue;
  18817. }
  18818. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18819. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  18820. continue;
  18821. }
  18822. }
  18823. // TlsError or timeout
  18824. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18825. impl::mbedtls_last_error() = ret;
  18826. return false;
  18827. }
  18828. if (err) { err->code = ErrorCode::Success; }
  18829. return true;
  18830. }
  18831. inline bool accept_nonblocking(session_t session, socket_t sock,
  18832. time_t timeout_sec, time_t timeout_usec,
  18833. TlsError *err) {
  18834. // A failed handshake leaves its SNI behind, so start without it
  18835. impl::mbedpending_sni().clear();
  18836. // Same implementation as connect for Mbed TLS
  18837. bool result =
  18838. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18839. // After successful handshake, capture SNI from thread-local storage
  18840. if (result && session) {
  18841. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18842. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18843. }
  18844. return result;
  18845. }
  18846. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18847. if (!session || !buf) {
  18848. err.code = ErrorCode::Fatal;
  18849. return -1;
  18850. }
  18851. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18852. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18853. if (msession->has_peeked_byte) {
  18854. if (len == 0) { return 0; }
  18855. auto p = static_cast<unsigned char *>(buf);
  18856. p[0] = msession->peeked_byte;
  18857. msession->has_peeked_byte = false;
  18858. size_t n = 1;
  18859. // Top up with any already-decrypted bytes without risking a block.
  18860. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18861. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18862. if (extra > 0) { n += static_cast<size_t>(extra); }
  18863. }
  18864. err.code = ErrorCode::Success;
  18865. return static_cast<ssize_t>(n);
  18866. }
  18867. int ret;
  18868. do {
  18869. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18870. len);
  18871. } while (impl::mbedtls_is_session_ticket(ret));
  18872. if (ret > 0) {
  18873. err.code = ErrorCode::Success;
  18874. return static_cast<ssize_t>(ret);
  18875. }
  18876. // 0 means EOF without close_notify, which is an error as on OpenSSL
  18877. if (ret == 0) { ret = MBEDTLS_ERR_SSL_CONN_EOF; }
  18878. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18879. err.backend_code = static_cast<uint64_t>(-ret);
  18880. impl::mbedtls_last_error() = ret;
  18881. // mbedTLS signals a clean close_notify via a negative error code rather
  18882. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18883. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18884. return -1;
  18885. }
  18886. inline ssize_t write(session_t session, const void *buf, size_t len,
  18887. TlsError &err) {
  18888. if (!session || !buf) {
  18889. err.code = ErrorCode::Fatal;
  18890. return -1;
  18891. }
  18892. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18893. int ret;
  18894. do {
  18895. ret = mbedtls_ssl_write(&msession->ssl,
  18896. static_cast<const unsigned char *>(buf), len);
  18897. } while (impl::mbedtls_is_session_ticket(ret));
  18898. if (ret > 0) {
  18899. err.code = ErrorCode::Success;
  18900. return static_cast<ssize_t>(ret);
  18901. }
  18902. if (ret == 0) {
  18903. err.code = ErrorCode::PeerClosed;
  18904. return 0;
  18905. }
  18906. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18907. err.backend_code = static_cast<uint64_t>(-ret);
  18908. impl::mbedtls_last_error() = ret;
  18909. return -1;
  18910. }
  18911. inline int pending(const_session_t session) {
  18912. if (!session) { return 0; }
  18913. auto msession =
  18914. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18915. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18916. (msession->has_peeked_byte ? 1 : 0);
  18917. }
  18918. inline void shutdown(session_t session, bool graceful) {
  18919. if (!session) { return; }
  18920. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18921. if (graceful) {
  18922. // Try to send close_notify, but don't block forever
  18923. int ret;
  18924. int attempts = 0;
  18925. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18926. attempts < 3) {
  18927. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18928. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18929. break;
  18930. }
  18931. attempts++;
  18932. }
  18933. }
  18934. }
  18935. inline bool is_peer_closed(session_t session, socket_t sock) {
  18936. if (!session || sock == INVALID_SOCKET) { return true; }
  18937. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18938. // Check if there's already decrypted or pushed-back data available.
  18939. // If so, the connection is definitely alive.
  18940. if (msession->has_peeked_byte ||
  18941. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18942. return false;
  18943. }
  18944. // Set socket to non-blocking to avoid blocking on read
  18945. detail::set_nonblocking(sock, true);
  18946. auto cleanup =
  18947. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18948. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18949. // on application data — e.g. a response that already arrived — push the
  18950. // byte back so the next read() delivers it instead of losing it.
  18951. unsigned char buf;
  18952. int ret;
  18953. do {
  18954. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18955. } while (impl::mbedtls_is_session_ticket(ret));
  18956. // If we got data or WANT_READ (would block), connection is alive
  18957. if (ret > 0) {
  18958. msession->peeked_byte = buf;
  18959. msession->has_peeked_byte = true;
  18960. return false;
  18961. }
  18962. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18963. // If we get a peer close notify or a connection reset, the peer is closed
  18964. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18965. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18966. }
  18967. inline cert_t get_peer_cert(const_session_t session) {
  18968. if (!session) { return nullptr; }
  18969. auto msession =
  18970. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18971. // Mbed TLS returns a pointer to the internal peer cert chain.
  18972. // WARNING: This pointer is only valid while the session is active.
  18973. // Do not use the certificate after calling free_session().
  18974. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18975. return const_cast<mbedtls_x509_crt *>(cert);
  18976. }
  18977. inline size_t get_peer_certs(const_session_t session,
  18978. std::vector<cert_t> &certs) {
  18979. certs.clear();
  18980. // Mbed TLS parses the whole received chain into a list headed by the peer
  18981. // certificate, owned by the session like get_peer_cert()'s result
  18982. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18983. crt && crt->raw.len > 0; crt = crt->next) {
  18984. certs.push_back(static_cast<cert_t>(crt));
  18985. }
  18986. return certs.size();
  18987. }
  18988. inline void free_cert(cert_t cert) {
  18989. // Mbed TLS: every cert_t handed out points into a session's or a context's
  18990. // chain, so there is nothing to free. Callers still call this for the other
  18991. // backends.
  18992. (void)cert;
  18993. }
  18994. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18995. if (!cert || !hostname) { return false; }
  18996. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18997. std::string host_str(hostname);
  18998. // Check if hostname is an IP address (IPv4 or IPv6)
  18999. unsigned char ip_bytes[16];
  19000. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19001. auto is_ip = ip_len > 0;
  19002. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  19003. // in buf.tag and the raw value in buf.p / buf.len.
  19004. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  19005. if (!san->buf.p || san->buf.len == 0) { continue; }
  19006. const unsigned char *p = san->buf.p;
  19007. size_t len = san->buf.len;
  19008. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  19009. if (is_ip) {
  19010. // For an IP host, only a matching iPAddress SAN of the same family
  19011. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  19012. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  19013. memcmp(p, ip_bytes, ip_len) == 0) {
  19014. return true;
  19015. }
  19016. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  19017. std::string san_name(reinterpret_cast<const char *>(p), len);
  19018. if (detail::match_hostname(san_name, host_str)) { return true; }
  19019. }
  19020. }
  19021. return false;
  19022. }
  19023. inline uint64_t hostname_mismatch_code() {
  19024. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  19025. }
  19026. inline long get_verify_result(const_session_t session) {
  19027. if (!session) { return -1; }
  19028. auto msession =
  19029. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19030. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  19031. // Return 0 (X509_V_OK equivalent) if verification passed
  19032. return flags == 0 ? 0 : static_cast<long>(flags);
  19033. }
  19034. inline std::string get_cert_subject_cn(cert_t cert) {
  19035. if (!cert) return "";
  19036. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19037. // Find the CN in the subject
  19038. const mbedtls_x509_name *name = &x509->subject;
  19039. while (name != nullptr) {
  19040. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  19041. return std::string(reinterpret_cast<const char *>(name->val.p),
  19042. name->val.len);
  19043. }
  19044. name = name->next;
  19045. }
  19046. return "";
  19047. }
  19048. inline std::string get_cert_issuer_name(cert_t cert) {
  19049. if (!cert) return "";
  19050. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19051. // Build a human-readable issuer name string
  19052. char buf[512];
  19053. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  19054. if (ret < 0) return "";
  19055. return std::string(buf);
  19056. }
  19057. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19058. sans.clear();
  19059. if (!cert) return false;
  19060. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19061. // Parse the Subject Alternative Name extension
  19062. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  19063. while (cur != nullptr) {
  19064. if (cur->buf.len > 0) {
  19065. const unsigned char *p = cur->buf.p;
  19066. size_t value_len = cur->buf.len;
  19067. SanEntry entry;
  19068. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  19069. case MBEDTLS_X509_SAN_DNS_NAME:
  19070. entry.type = SanType::DNS;
  19071. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19072. break;
  19073. case MBEDTLS_X509_SAN_IP_ADDRESS:
  19074. entry.type = SanType::IP;
  19075. if (value_len == 4) {
  19076. // IPv4
  19077. char buf[16];
  19078. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  19079. entry.value = buf;
  19080. } else if (value_len == 16) {
  19081. // IPv6
  19082. char buf[64];
  19083. snprintf(buf, sizeof(buf),
  19084. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19085. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19086. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  19087. p[10], p[11], p[12], p[13], p[14], p[15]);
  19088. entry.value = buf;
  19089. }
  19090. break;
  19091. case MBEDTLS_X509_SAN_RFC822_NAME:
  19092. entry.type = SanType::EMAIL;
  19093. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19094. break;
  19095. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  19096. entry.type = SanType::URI;
  19097. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19098. break;
  19099. default: entry.type = SanType::OTHER; break;
  19100. }
  19101. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19102. }
  19103. cur = cur->next;
  19104. }
  19105. return true;
  19106. }
  19107. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19108. time_t &not_after) {
  19109. if (!cert) return false;
  19110. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19111. // Convert mbedtls_x509_time to time_t
  19112. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  19113. struct tm tm_time = {};
  19114. tm_time.tm_year = t.year - 1900;
  19115. tm_time.tm_mon = t.mon - 1;
  19116. tm_time.tm_mday = t.day;
  19117. tm_time.tm_hour = t.hour;
  19118. tm_time.tm_min = t.min;
  19119. tm_time.tm_sec = t.sec;
  19120. #ifdef _WIN32
  19121. return _mkgmtime(&tm_time);
  19122. #else
  19123. return timegm(&tm_time);
  19124. #endif
  19125. };
  19126. not_before = to_time_t(x509->valid_from);
  19127. not_after = to_time_t(x509->valid_to);
  19128. return true;
  19129. }
  19130. inline std::string get_cert_serial(cert_t cert) {
  19131. if (!cert) return "";
  19132. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19133. // Convert serial number to hex string
  19134. std::string result;
  19135. result.reserve(x509->serial.len * 2);
  19136. for (size_t i = 0; i < x509->serial.len; i++) {
  19137. char hex[3];
  19138. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  19139. result += hex;
  19140. }
  19141. return result;
  19142. }
  19143. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19144. if (!cert) return false;
  19145. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  19146. if (!crt->raw.p || crt->raw.len == 0) return false;
  19147. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  19148. return true;
  19149. }
  19150. inline const char *get_sni(const_session_t session) {
  19151. if (!session) return nullptr;
  19152. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  19153. // For server: return SNI received from client during handshake
  19154. if (!msession->sni_hostname.empty()) {
  19155. return msession->sni_hostname.c_str();
  19156. }
  19157. // For client: return the hostname set via set_sni
  19158. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  19159. return nullptr;
  19160. }
  19161. inline uint64_t peek_error() {
  19162. // Mbed TLS doesn't have an error queue, return the last error
  19163. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  19164. }
  19165. inline uint64_t get_error() {
  19166. // Mbed TLS doesn't have an error queue, return and clear the last error
  19167. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  19168. impl::mbedtls_last_error() = 0;
  19169. return err;
  19170. }
  19171. inline std::string error_string(uint64_t code) {
  19172. char buf[256];
  19173. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  19174. return std::string(buf);
  19175. }
  19176. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19177. #ifdef CPPHTTPLIB_MBEDTLS_V4
  19178. // Parsing certificates needs PSA Crypto, and no context may exist yet
  19179. if (!detail::ensure_mbedtls_psa_crypto()) { return nullptr; }
  19180. #endif
  19181. if (!pem) { return nullptr; }
  19182. // mbedtls_x509_crt_parse expects null-terminated PEM
  19183. std::string pem_str(pem, len);
  19184. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  19185. if (!ca_chain) { return nullptr; }
  19186. mbedtls_x509_crt_init(ca_chain);
  19187. auto ret = mbedtls_x509_crt_parse(
  19188. ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  19189. pem_str.size() + 1);
  19190. if (ret != 0) {
  19191. mbedtls_x509_crt_free(ca_chain);
  19192. delete ca_chain;
  19193. return nullptr;
  19194. }
  19195. return static_cast<ca_store_t>(ca_chain);
  19196. }
  19197. inline void free_ca_store(ca_store_t store) {
  19198. if (store) {
  19199. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19200. mbedtls_x509_crt_free(ca_chain);
  19201. delete ca_chain;
  19202. }
  19203. }
  19204. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19205. if (!ctx || !store) { return false; }
  19206. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19207. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19208. // Free existing CA chain
  19209. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  19210. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  19211. // Copy the CA chain (deep copy)
  19212. // Parse from the raw data of the source cert
  19213. mbedtls_x509_crt *src = ca_chain;
  19214. while (src != nullptr) {
  19215. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  19216. src->raw.len);
  19217. if (ret != 0) {
  19218. free_ca_store(store);
  19219. return false;
  19220. }
  19221. src = src->next;
  19222. }
  19223. // This function takes ownership of the store; the chain was deep-copied
  19224. // above, so release the source
  19225. free_ca_store(store);
  19226. // Update the SSL config to use the new CA chain
  19227. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19228. return true;
  19229. }
  19230. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19231. certs.clear();
  19232. if (!ctx) { return 0; }
  19233. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19234. // Owned by the context; see free_cert()
  19235. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  19236. cert = cert->next) {
  19237. certs.push_back(static_cast<cert_t>(cert));
  19238. }
  19239. return certs.size();
  19240. }
  19241. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19242. std::vector<std::string> names;
  19243. if (!ctx) { return names; }
  19244. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19245. // Iterate through the CA chain
  19246. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  19247. while (cert != nullptr && cert->raw.len > 0) {
  19248. char buf[512];
  19249. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  19250. if (ret > 0) { names.push_back(buf); }
  19251. cert = cert->next;
  19252. }
  19253. return names;
  19254. }
  19255. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19256. const char *key_pem, const char *password) {
  19257. if (!ctx || !cert_pem || !key_pem) { return false; }
  19258. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19259. // Parse into new objects first, so that a bad pair leaves the old one in
  19260. // place, and swap them in after; the old ones are freed on the way out.
  19261. mbedtls_x509_crt cert;
  19262. mbedtls_pk_context key;
  19263. mbedtls_x509_crt_init(&cert);
  19264. mbedtls_pk_init(&key);
  19265. auto se = detail::scope_exit([&] {
  19266. mbedtls_x509_crt_free(&cert);
  19267. mbedtls_pk_free(&key);
  19268. });
  19269. // Parse certificate PEM
  19270. int ret = mbedtls_x509_crt_parse(
  19271. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  19272. strlen(cert_pem) + 1);
  19273. if (ret != 0) {
  19274. impl::mbedtls_last_error() = ret;
  19275. return false;
  19276. }
  19277. // Parse private key PEM
  19278. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  19279. ret = mbedtls_pk_parse_key(
  19280. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19281. strlen(key_pem) + 1,
  19282. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19283. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  19284. &mbed_ctx->ctr_drbg);
  19285. #else
  19286. ret = mbedtls_pk_parse_key(
  19287. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19288. strlen(key_pem) + 1,
  19289. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19290. password ? strlen(password) : 0);
  19291. #endif
  19292. if (ret != 0) {
  19293. impl::mbedtls_last_error() = ret;
  19294. return false;
  19295. }
  19296. std::swap(mbed_ctx->own_cert, cert);
  19297. std::swap(mbed_ctx->own_key, key);
  19298. // Configure SSL to use the new certificate and key
  19299. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  19300. &mbed_ctx->own_key);
  19301. if (ret != 0) {
  19302. impl::mbedtls_last_error() = ret;
  19303. return false;
  19304. }
  19305. return true;
  19306. }
  19307. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19308. if (!ctx || !ca_pem) { return false; }
  19309. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19310. // Parse into a new chain first, so that a bad one leaves the old in place
  19311. mbedtls_x509_crt chain;
  19312. mbedtls_x509_crt_init(&chain);
  19313. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  19314. // Parse CA PEM
  19315. int ret = mbedtls_x509_crt_parse(
  19316. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  19317. strlen(ca_pem) + 1);
  19318. if (ret != 0) {
  19319. impl::mbedtls_last_error() = ret;
  19320. return false;
  19321. }
  19322. std::swap(mbed_ctx->ca_chain, chain);
  19323. // Update SSL config to use new CA chain
  19324. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19325. return true;
  19326. }
  19327. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19328. if (!ctx) { return false; }
  19329. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19330. // create_session() hands each session its own copy to run.
  19331. mbed_ctx->verify_callback = std::move(callback);
  19332. impl::apply_verify_mode(*mbed_ctx);
  19333. return true;
  19334. }
  19335. inline long get_verify_error(const_session_t session) {
  19336. if (!session) { return -1; }
  19337. auto *msession =
  19338. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19339. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  19340. }
  19341. inline std::string verify_error_string(long error_code) {
  19342. if (error_code == 0) { return ""; }
  19343. char buf[256];
  19344. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  19345. static_cast<uint32_t>(error_code));
  19346. // Remove trailing newline if present
  19347. std::string result(buf);
  19348. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  19349. result.pop_back();
  19350. }
  19351. return result;
  19352. }
  19353. } // namespace tls
  19354. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  19355. /*
  19356. * Group 10: TLS abstraction layer - wolfSSL backend
  19357. */
  19358. /*
  19359. * wolfSSL Backend Implementation
  19360. */
  19361. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  19362. namespace tls {
  19363. namespace impl {
  19364. // wolfSSL session wrapper
  19365. struct WolfSSLSession {
  19366. WOLFSSL *ssl = nullptr;
  19367. socket_t sock = INVALID_SOCKET;
  19368. std::string hostname; // For client: set via set_sni
  19369. std::string sni_hostname; // For server: received from client via SNI callback
  19370. WolfSSLSession() = default;
  19371. ~WolfSSLSession() {
  19372. if (ssl) { wolfSSL_free(ssl); }
  19373. }
  19374. WolfSSLSession(const WolfSSLSession &) = delete;
  19375. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  19376. };
  19377. // Thread-local error code accessor for wolfSSL
  19378. inline uint64_t &wolfssl_last_error() {
  19379. static thread_local uint64_t err = 0;
  19380. return err;
  19381. }
  19382. // Helper to map wolfSSL error to ErrorCode.
  19383. // ssl_error is the value from wolfSSL_get_error().
  19384. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  19385. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  19386. int &out_errno) {
  19387. switch (ssl_error) {
  19388. case SSL_ERROR_NONE: return ErrorCode::Success;
  19389. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  19390. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  19391. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  19392. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  19393. // EOF without close_notify
  19394. case SOCKET_PEER_CLOSED_E: out_errno = 0; return ErrorCode::SyscallError;
  19395. default:
  19396. if (ssl) {
  19397. // wolfSSL stores the low-level error code as a negative value.
  19398. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  19399. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  19400. if (low_err == DOMAIN_NAME_MISMATCH) {
  19401. return ErrorCode::HostnameMismatch;
  19402. }
  19403. // Check verify result to distinguish cert verification from generic SSL
  19404. // errors.
  19405. long vr = wolfSSL_get_verify_result(ssl);
  19406. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  19407. }
  19408. return ErrorCode::Fatal;
  19409. }
  19410. }
  19411. // WolfSSLContext constructor/destructor implementations
  19412. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  19413. inline WolfSSLContext::~WolfSSLContext() {
  19414. if (ctx) { wolfSSL_CTX_free(ctx); }
  19415. }
  19416. // Thread-local storage for SNI captured during handshake
  19417. inline std::string &wolfssl_pending_sni() {
  19418. static thread_local std::string sni;
  19419. return sni;
  19420. }
  19421. // SNI callback for wolfSSL server to capture client's SNI hostname
  19422. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  19423. (void)ret;
  19424. (void)exArg;
  19425. void *name_data = nullptr;
  19426. unsigned short name_len =
  19427. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  19428. if (name_data && name_len > 0) {
  19429. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  19430. name_len);
  19431. } else {
  19432. wolfssl_pending_sni().clear();
  19433. }
  19434. return 0; // Continue regardless
  19435. }
  19436. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  19437. // runs the verify callback of its own context.
  19438. inline int context_ex_data_index() {
  19439. static const auto index =
  19440. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19441. return index;
  19442. }
  19443. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  19444. // other tls:: function takes.
  19445. inline int session_ex_data_index() {
  19446. static const auto index =
  19447. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19448. return index;
  19449. }
  19450. // A resumed session skips the client's certificate, so a server that checks
  19451. // one would let in a certificate checked against another server's CA, as
  19452. // wolfSSL shares its session cache between contexts, or against a CA since
  19453. // replaced by update_server_client_ca().
  19454. inline void disable_server_resumption(WolfSSLContext *wctx) {
  19455. if (!wctx->is_server) { return; }
  19456. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  19457. #ifdef HAVE_SESSION_TICKET
  19458. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  19459. #endif
  19460. }
  19461. // wolfSSL verify callback wrapper
  19462. inline int wolfssl_verify_callback(int preverify_ok,
  19463. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  19464. // Get the WOLFSSL object from the X509_STORE_CTX
  19465. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  19466. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  19467. if (!ssl) { return preverify_ok; }
  19468. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  19469. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  19470. if (!wctx) { return preverify_ok; }
  19471. std::shared_ptr<VerifyCallback> callback;
  19472. {
  19473. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  19474. callback = wctx->verify_callback;
  19475. }
  19476. if (!callback) { return preverify_ok; }
  19477. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  19478. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  19479. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  19480. VerifyContext verify_ctx;
  19481. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  19482. verify_ctx.cert = static_cast<cert_t>(cert);
  19483. verify_ctx.depth = depth;
  19484. verify_ctx.preverify_ok = (preverify_ok != 0);
  19485. verify_ctx.error_code = static_cast<long>(err);
  19486. if (err != 0) {
  19487. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  19488. } else {
  19489. verify_ctx.error_string = nullptr;
  19490. }
  19491. auto accepted = run_verify_callback(*callback, verify_ctx);
  19492. // A client verifying the server during the handshake, which is what
  19493. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  19494. if (!wolfSSL_is_server(ssl) &&
  19495. (wolfSSL_get_verify_mode(ssl) & WOLFSSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  19496. accepted = accepted && preverify_ok;
  19497. }
  19498. return accepted ? 1 : 0;
  19499. }
  19500. // Sets the verify mode from whether the peer's certificate is required and
  19501. // whether a verify callback is set.
  19502. inline void apply_verify_mode(WolfSSLContext &wctx) {
  19503. auto has_callback = static_cast<bool>(wctx.verify_callback);
  19504. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  19505. auto mode = wctx.verify_client
  19506. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19507. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  19508. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  19509. has_callback ? wolfssl_verify_callback : nullptr);
  19510. }
  19511. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  19512. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  19513. wolfSSL_CTX_set_default_passwd_cb(
  19514. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  19515. auto *pwd = static_cast<const char *>(userdata);
  19516. if (!pwd) return 0;
  19517. auto len = static_cast<int>(strlen(pwd));
  19518. if (len > size) len = size;
  19519. memcpy(buf, pwd, static_cast<size_t>(len));
  19520. return len;
  19521. });
  19522. }
  19523. } // namespace impl
  19524. inline ctx_t create_client_context() {
  19525. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19526. if (!ctx) { return nullptr; }
  19527. ctx->is_server = false;
  19528. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  19529. if (!method) {
  19530. delete ctx;
  19531. return nullptr;
  19532. }
  19533. ctx->ctx = wolfSSL_CTX_new(method);
  19534. if (!ctx->ctx ||
  19535. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19536. WOLFSSL_SUCCESS) {
  19537. delete ctx;
  19538. return nullptr;
  19539. }
  19540. // Default: verify peer certificate
  19541. ctx->verify_client = true;
  19542. impl::apply_verify_mode(*ctx);
  19543. return static_cast<ctx_t>(ctx);
  19544. }
  19545. inline ctx_t create_server_context() {
  19546. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19547. if (!ctx) { return nullptr; }
  19548. ctx->is_server = true;
  19549. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  19550. if (!method) {
  19551. delete ctx;
  19552. return nullptr;
  19553. }
  19554. ctx->ctx = wolfSSL_CTX_new(method);
  19555. if (!ctx->ctx ||
  19556. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19557. WOLFSSL_SUCCESS) {
  19558. delete ctx;
  19559. return nullptr;
  19560. }
  19561. // Default: don't verify client
  19562. impl::apply_verify_mode(*ctx);
  19563. // Enable SNI on server
  19564. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  19565. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  19566. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  19567. return static_cast<ctx_t>(ctx);
  19568. }
  19569. inline void free_context(ctx_t ctx) {
  19570. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  19571. }
  19572. inline bool set_min_version(ctx_t ctx, Version version) {
  19573. if (!ctx) { return false; }
  19574. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19575. int min_ver = WOLFSSL_TLSV1_2;
  19576. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  19577. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  19578. }
  19579. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  19580. if (!ctx || !pem) { return false; }
  19581. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19582. int ret = wolfSSL_CTX_load_verify_buffer(
  19583. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  19584. static_cast<long>(len), SSL_FILETYPE_PEM);
  19585. if (ret != SSL_SUCCESS) {
  19586. impl::wolfssl_last_error() =
  19587. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19588. return false;
  19589. }
  19590. wctx->ca_pem_data_.append(pem, len);
  19591. return true;
  19592. }
  19593. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  19594. if (!ctx || !file_path) { return false; }
  19595. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19596. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  19597. if (ret != SSL_SUCCESS) {
  19598. impl::wolfssl_last_error() =
  19599. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19600. return false;
  19601. }
  19602. return true;
  19603. }
  19604. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  19605. if (!ctx || !dir_path) { return false; }
  19606. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19607. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  19608. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  19609. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  19610. // immediately. Return true even on failure since the CA file may have
  19611. // already been loaded, matching OpenSSL's lenient behavior.
  19612. (void)ret;
  19613. return true;
  19614. }
  19615. inline bool load_system_certs(ctx_t ctx) {
  19616. if (!ctx) { return false; }
  19617. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19618. bool loaded = false;
  19619. #ifdef _WIN32
  19620. loaded = impl::enumerate_windows_system_certs(
  19621. [&](const unsigned char *data, size_t len) {
  19622. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19623. static_cast<long>(len),
  19624. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19625. });
  19626. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19627. loaded = impl::enumerate_macos_keychain_certs(
  19628. [&](const unsigned char *data, size_t len) {
  19629. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19630. static_cast<long>(len),
  19631. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19632. });
  19633. #else
  19634. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19635. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  19636. SSL_SUCCESS) {
  19637. loaded = true;
  19638. break;
  19639. }
  19640. }
  19641. if (!loaded) {
  19642. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19643. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  19644. SSL_SUCCESS) {
  19645. loaded = true;
  19646. break;
  19647. }
  19648. }
  19649. }
  19650. #endif
  19651. return loaded;
  19652. }
  19653. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19654. const char *password) {
  19655. if (!ctx || !cert || !key) { return false; }
  19656. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19657. // Load certificate
  19658. int ret = wolfSSL_CTX_use_certificate_buffer(
  19659. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  19660. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  19661. if (ret != SSL_SUCCESS) {
  19662. impl::wolfssl_last_error() =
  19663. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19664. return false;
  19665. }
  19666. // Set password callback if password is provided
  19667. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19668. // Load private key
  19669. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19670. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  19671. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  19672. if (ret != SSL_SUCCESS) {
  19673. impl::wolfssl_last_error() =
  19674. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19675. return false;
  19676. }
  19677. // Verify that the certificate and private key match
  19678. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19679. }
  19680. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19681. const char *key_path, const char *password) {
  19682. if (!ctx || !cert_path || !key_path) { return false; }
  19683. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19684. // Load certificate file
  19685. int ret =
  19686. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  19687. if (ret != SSL_SUCCESS) {
  19688. impl::wolfssl_last_error() =
  19689. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19690. return false;
  19691. }
  19692. // Set password callback if password is provided
  19693. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19694. // Load private key file
  19695. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  19696. if (ret != SSL_SUCCESS) {
  19697. impl::wolfssl_last_error() =
  19698. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19699. return false;
  19700. }
  19701. // Verify that the certificate and private key match
  19702. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19703. }
  19704. inline void set_verify_client(ctx_t ctx, bool require) {
  19705. if (!ctx) { return; }
  19706. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19707. wctx->verify_client = require;
  19708. impl::apply_verify_mode(*wctx);
  19709. }
  19710. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19711. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19712. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19713. auto session = new (std::nothrow) impl::WolfSSLSession();
  19714. if (!session) { return nullptr; }
  19715. session->sock = sock;
  19716. session->ssl = wolfSSL_new(wctx->ctx);
  19717. if (!session->ssl) {
  19718. impl::wolfssl_last_error() =
  19719. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19720. delete session;
  19721. return nullptr;
  19722. }
  19723. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19724. session) != WOLFSSL_SUCCESS) {
  19725. delete session;
  19726. return nullptr;
  19727. }
  19728. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19729. return static_cast<session_t>(session);
  19730. }
  19731. inline void free_session(session_t session) {
  19732. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19733. }
  19734. inline bool set_sni(session_t session, const char *hostname,
  19735. bool verify_hostname) {
  19736. if (!session || !hostname) { return false; }
  19737. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19738. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19739. static_cast<word16>(strlen(hostname)));
  19740. if (ret != WOLFSSL_SUCCESS) {
  19741. impl::wolfssl_last_error() =
  19742. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19743. return false;
  19744. }
  19745. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19746. // separately from the SNI extension sent above; skip it when hostname
  19747. // verification is disabled so only the chain is checked, matching OpenSSL.
  19748. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19749. wsession->hostname = hostname;
  19750. return true;
  19751. }
  19752. inline TlsError connect(session_t session) {
  19753. TlsError err;
  19754. if (!session) {
  19755. err.code = ErrorCode::Fatal;
  19756. return err;
  19757. }
  19758. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19759. int ret = wolfSSL_connect(wsession->ssl);
  19760. if (ret == SSL_SUCCESS) {
  19761. err.code = ErrorCode::Success;
  19762. } else {
  19763. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19764. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19765. err.backend_code = static_cast<uint64_t>(ssl_error);
  19766. impl::wolfssl_last_error() = err.backend_code;
  19767. }
  19768. return err;
  19769. }
  19770. inline TlsError accept(session_t session) {
  19771. TlsError err;
  19772. if (!session) {
  19773. err.code = ErrorCode::Fatal;
  19774. return err;
  19775. }
  19776. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19777. int ret = wolfSSL_accept(wsession->ssl);
  19778. if (ret == SSL_SUCCESS) {
  19779. err.code = ErrorCode::Success;
  19780. // Capture SNI from thread-local storage after successful handshake
  19781. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19782. impl::wolfssl_pending_sni().clear();
  19783. } else {
  19784. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19785. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19786. err.backend_code = static_cast<uint64_t>(ssl_error);
  19787. impl::wolfssl_last_error() = err.backend_code;
  19788. }
  19789. return err;
  19790. }
  19791. inline bool connect_nonblocking(session_t session, socket_t sock,
  19792. time_t timeout_sec, time_t timeout_usec,
  19793. TlsError *err,
  19794. const std::function<bool()> &interrupted) {
  19795. if (!session) {
  19796. if (err) { err->code = ErrorCode::Fatal; }
  19797. return false;
  19798. }
  19799. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19800. // Set socket to non-blocking mode
  19801. detail::set_nonblocking(sock, true);
  19802. auto cleanup =
  19803. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19804. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19805. int ret;
  19806. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19807. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19808. if (ssl_error == SSL_ERROR_WANT_READ) {
  19809. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  19810. continue;
  19811. }
  19812. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19813. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  19814. continue;
  19815. }
  19816. }
  19817. // Error or timeout
  19818. if (err) {
  19819. err->code =
  19820. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19821. err->backend_code = static_cast<uint64_t>(ssl_error);
  19822. }
  19823. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19824. return false;
  19825. }
  19826. if (err) { err->code = ErrorCode::Success; }
  19827. return true;
  19828. }
  19829. inline bool accept_nonblocking(session_t session, socket_t sock,
  19830. time_t timeout_sec, time_t timeout_usec,
  19831. TlsError *err) {
  19832. if (!session) {
  19833. if (err) { err->code = ErrorCode::Fatal; }
  19834. return false;
  19835. }
  19836. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19837. // Set socket to non-blocking mode
  19838. detail::set_nonblocking(sock, true);
  19839. auto cleanup =
  19840. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19841. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19842. int ret;
  19843. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19844. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19845. if (ssl_error == SSL_ERROR_WANT_READ) {
  19846. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19847. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19848. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19849. }
  19850. // Error or timeout
  19851. if (err) {
  19852. err->code =
  19853. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19854. err->backend_code = static_cast<uint64_t>(ssl_error);
  19855. }
  19856. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19857. return false;
  19858. }
  19859. if (err) { err->code = ErrorCode::Success; }
  19860. // Capture SNI from thread-local storage after successful handshake
  19861. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19862. impl::wolfssl_pending_sni().clear();
  19863. return true;
  19864. }
  19865. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19866. if (!session || !buf) {
  19867. err.code = ErrorCode::Fatal;
  19868. return -1;
  19869. }
  19870. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19871. constexpr auto max_len =
  19872. static_cast<size_t>((std::numeric_limits<int>::max)());
  19873. if (len > max_len) { len = max_len; }
  19874. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19875. if (ret > 0) {
  19876. err.code = ErrorCode::Success;
  19877. return static_cast<ssize_t>(ret);
  19878. }
  19879. // 0 is also returned for EOF without close_notify; get_error tells them apart
  19880. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19881. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19882. if (err.code == ErrorCode::PeerClosed) { return 0; }
  19883. err.backend_code = static_cast<uint64_t>(ssl_error);
  19884. impl::wolfssl_last_error() = err.backend_code;
  19885. return -1;
  19886. }
  19887. inline ssize_t write(session_t session, const void *buf, size_t len,
  19888. TlsError &err) {
  19889. if (!session || !buf) {
  19890. err.code = ErrorCode::Fatal;
  19891. return -1;
  19892. }
  19893. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19894. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19895. if (ret > 0) {
  19896. err.code = ErrorCode::Success;
  19897. return static_cast<ssize_t>(ret);
  19898. }
  19899. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19900. // Treat this as an error (return -1) so callers don't spin in a
  19901. // write loop adding zero to the offset.
  19902. if (ret == 0) {
  19903. err.code = ErrorCode::PeerClosed;
  19904. return -1;
  19905. }
  19906. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19907. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19908. err.backend_code = static_cast<uint64_t>(ssl_error);
  19909. impl::wolfssl_last_error() = err.backend_code;
  19910. return -1;
  19911. }
  19912. inline int pending(const_session_t session) {
  19913. if (!session) { return 0; }
  19914. auto wsession =
  19915. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19916. return wolfSSL_pending(wsession->ssl);
  19917. }
  19918. inline void shutdown(session_t session, bool graceful) {
  19919. if (!session) { return; }
  19920. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19921. if (graceful) {
  19922. int ret;
  19923. int attempts = 0;
  19924. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19925. attempts < 3) {
  19926. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19927. if (ssl_error != SSL_ERROR_WANT_READ &&
  19928. ssl_error != SSL_ERROR_WANT_WRITE) {
  19929. break;
  19930. }
  19931. attempts++;
  19932. }
  19933. } else {
  19934. wolfSSL_shutdown(wsession->ssl);
  19935. }
  19936. }
  19937. inline bool is_peer_closed(session_t session, socket_t sock) {
  19938. if (!session || sock == INVALID_SOCKET) { return true; }
  19939. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19940. // Check if there's already decrypted data available
  19941. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19942. // Set socket to non-blocking to avoid blocking on read
  19943. detail::set_nonblocking(sock, true);
  19944. auto cleanup =
  19945. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19946. // Peek 1 byte to check connection status without consuming data
  19947. unsigned char buf;
  19948. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19949. // If we got data or WANT_READ (would block), connection is alive
  19950. if (ret > 0) { return false; }
  19951. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19952. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19953. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19954. ret == 0;
  19955. }
  19956. inline cert_t get_peer_cert(const_session_t session) {
  19957. if (!session) { return nullptr; }
  19958. auto wsession =
  19959. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19960. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19961. return static_cast<cert_t>(cert);
  19962. }
  19963. inline size_t get_peer_certs(const_session_t session,
  19964. std::vector<cert_t> &certs) {
  19965. certs.clear();
  19966. if (!session) { return 0; }
  19967. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19968. #ifdef SESSION_CERTS
  19969. auto wsession =
  19970. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19971. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19972. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19973. for (int i = 0; i < count; i++) {
  19974. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19975. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19976. }
  19977. #endif
  19978. return certs.size();
  19979. }
  19980. inline void free_cert(cert_t cert) {
  19981. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19982. }
  19983. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19984. if (!cert || !hostname) { return false; }
  19985. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19986. std::string host_str(hostname);
  19987. // Check if hostname is an IP address (IPv4 or IPv6)
  19988. unsigned char ip_bytes[16];
  19989. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19990. auto is_ip = ip_len > 0;
  19991. // Check Subject Alternative Names
  19992. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19993. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19994. if (san_names) {
  19995. int san_count = wolfSSL_sk_num(san_names);
  19996. for (int i = 0; i < san_count; i++) {
  19997. auto *names =
  19998. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19999. if (!names) continue;
  20000. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  20001. // DNS name
  20002. unsigned char *dns_name = nullptr;
  20003. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  20004. if (dns_name && dns_len > 0) {
  20005. std::string san_name(reinterpret_cast<char *>(dns_name),
  20006. static_cast<size_t>(dns_len));
  20007. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  20008. if (detail::match_hostname(san_name, host_str)) {
  20009. wolfSSL_sk_free(san_names);
  20010. return true;
  20011. }
  20012. }
  20013. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  20014. // IP address: only an iPAddress SAN of the same family (4 bytes for
  20015. // IPv4, 16 bytes for IPv6) may authenticate the host.
  20016. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  20017. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  20018. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  20019. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  20020. wolfSSL_sk_free(san_names);
  20021. return true;
  20022. }
  20023. }
  20024. }
  20025. wolfSSL_sk_free(san_names);
  20026. }
  20027. return false;
  20028. }
  20029. inline uint64_t hostname_mismatch_code() {
  20030. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  20031. }
  20032. inline long get_verify_result(const_session_t session) {
  20033. if (!session) { return -1; }
  20034. auto wsession =
  20035. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20036. long result = wolfSSL_get_verify_result(wsession->ssl);
  20037. return result;
  20038. }
  20039. inline std::string get_cert_subject_cn(cert_t cert) {
  20040. if (!cert) return "";
  20041. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20042. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  20043. if (!subject) return "";
  20044. char cn[256] = {};
  20045. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  20046. sizeof(cn));
  20047. if (cn_len <= 0) return "";
  20048. return std::string(cn, static_cast<size_t>(cn_len));
  20049. }
  20050. inline std::string get_cert_issuer_name(cert_t cert) {
  20051. if (!cert) return "";
  20052. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20053. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  20054. if (!issuer) return "";
  20055. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  20056. if (!name_str) return "";
  20057. std::string result(name_str);
  20058. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  20059. return result;
  20060. }
  20061. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  20062. sans.clear();
  20063. if (!cert) return false;
  20064. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20065. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  20066. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  20067. if (!san_names) return true; // No SANs is not an error
  20068. int count = wolfSSL_sk_num(san_names);
  20069. for (int i = 0; i < count; i++) {
  20070. auto *name =
  20071. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  20072. if (!name) continue;
  20073. SanEntry entry;
  20074. switch (name->type) {
  20075. case WOLFSSL_GEN_DNS: {
  20076. entry.type = SanType::DNS;
  20077. unsigned char *dns_name = nullptr;
  20078. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  20079. if (dns_name && dns_len > 0) {
  20080. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  20081. static_cast<size_t>(dns_len));
  20082. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  20083. }
  20084. break;
  20085. }
  20086. case WOLFSSL_GEN_IPADD: {
  20087. entry.type = SanType::IP;
  20088. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  20089. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  20090. if (ip_data && ip_len == 4) {
  20091. char buf[16];
  20092. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  20093. ip_data[2], ip_data[3]);
  20094. entry.value = buf;
  20095. } else if (ip_data && ip_len == 16) {
  20096. char buf[64];
  20097. snprintf(buf, sizeof(buf),
  20098. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  20099. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  20100. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  20101. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  20102. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  20103. ip_data[14], ip_data[15]);
  20104. entry.value = buf;
  20105. }
  20106. break;
  20107. }
  20108. case WOLFSSL_GEN_EMAIL:
  20109. entry.type = SanType::EMAIL;
  20110. {
  20111. unsigned char *email = nullptr;
  20112. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  20113. if (email && email_len > 0) {
  20114. entry.value = std::string(reinterpret_cast<char *>(email),
  20115. static_cast<size_t>(email_len));
  20116. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  20117. }
  20118. }
  20119. break;
  20120. case WOLFSSL_GEN_URI:
  20121. entry.type = SanType::URI;
  20122. {
  20123. unsigned char *uri = nullptr;
  20124. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  20125. &uri, name->d.uniformResourceIdentifier);
  20126. if (uri && uri_len > 0) {
  20127. entry.value = std::string(reinterpret_cast<char *>(uri),
  20128. static_cast<size_t>(uri_len));
  20129. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  20130. }
  20131. }
  20132. break;
  20133. default: entry.type = SanType::OTHER; break;
  20134. }
  20135. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  20136. }
  20137. wolfSSL_sk_free(san_names);
  20138. return true;
  20139. }
  20140. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  20141. time_t &not_after) {
  20142. if (!cert) return false;
  20143. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20144. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  20145. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  20146. if (!nb || !na) return false;
  20147. // wolfSSL_ASN1_TIME_to_tm is available
  20148. struct tm tm_nb = {}, tm_na = {};
  20149. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  20150. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  20151. #ifdef _WIN32
  20152. not_before = _mkgmtime(&tm_nb);
  20153. not_after = _mkgmtime(&tm_na);
  20154. #else
  20155. not_before = timegm(&tm_nb);
  20156. not_after = timegm(&tm_na);
  20157. #endif
  20158. return true;
  20159. }
  20160. inline std::string get_cert_serial(cert_t cert) {
  20161. if (!cert) return "";
  20162. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20163. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  20164. if (!serial_asn1) return "";
  20165. // Get the serial number data
  20166. int len = serial_asn1->length;
  20167. unsigned char *data = serial_asn1->data;
  20168. if (!data || len <= 0) return "";
  20169. std::string result;
  20170. result.reserve(static_cast<size_t>(len) * 2);
  20171. for (int i = 0; i < len; i++) {
  20172. char hex[3];
  20173. snprintf(hex, sizeof(hex), "%02X", data[i]);
  20174. result += hex;
  20175. }
  20176. return result;
  20177. }
  20178. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  20179. if (!cert) return false;
  20180. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20181. int der_len = 0;
  20182. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  20183. if (!der_data || der_len <= 0) return false;
  20184. der.assign(der_data, der_data + der_len);
  20185. return true;
  20186. }
  20187. inline const char *get_sni(const_session_t session) {
  20188. if (!session) return nullptr;
  20189. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  20190. // For server: return SNI received from client during handshake
  20191. if (!wsession->sni_hostname.empty()) {
  20192. return wsession->sni_hostname.c_str();
  20193. }
  20194. // For client: return the hostname set via set_sni
  20195. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  20196. return nullptr;
  20197. }
  20198. inline uint64_t peek_error() {
  20199. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20200. }
  20201. inline uint64_t get_error() {
  20202. uint64_t err = impl::wolfssl_last_error();
  20203. impl::wolfssl_last_error() = 0;
  20204. return err;
  20205. }
  20206. inline std::string error_string(uint64_t code) {
  20207. char buf[256];
  20208. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  20209. return std::string(buf);
  20210. }
  20211. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  20212. if (!pem || len == 0) { return nullptr; }
  20213. // Validate by attempting to load into a temporary ctx
  20214. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  20215. if (!tmp_ctx) { return nullptr; }
  20216. int ret = wolfSSL_CTX_load_verify_buffer(
  20217. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  20218. static_cast<long>(len), SSL_FILETYPE_PEM);
  20219. wolfSSL_CTX_free(tmp_ctx);
  20220. if (ret != SSL_SUCCESS) { return nullptr; }
  20221. return static_cast<ca_store_t>(
  20222. new impl::WolfSSLCAStore{std::string(pem, len)});
  20223. }
  20224. inline void free_ca_store(ca_store_t store) {
  20225. delete static_cast<impl::WolfSSLCAStore *>(store);
  20226. }
  20227. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  20228. if (!ctx || !store) { return false; }
  20229. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20230. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  20231. int ret = wolfSSL_CTX_load_verify_buffer(
  20232. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  20233. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  20234. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  20235. // This function takes ownership of the store; the PEM data was copied into
  20236. // the context, so release the source
  20237. free_ca_store(store);
  20238. return ret == SSL_SUCCESS;
  20239. }
  20240. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  20241. certs.clear();
  20242. if (!ctx) { return 0; }
  20243. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20244. if (wctx->ca_pem_data_.empty()) { return 0; }
  20245. const std::string &pem = wctx->ca_pem_data_;
  20246. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20247. const std::string end_marker = "-----END CERTIFICATE-----";
  20248. size_t pos = 0;
  20249. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20250. size_t end_pos = pem.find(end_marker, pos);
  20251. if (end_pos == std::string::npos) { break; }
  20252. end_pos += end_marker.size();
  20253. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20254. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20255. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20256. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20257. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  20258. pos = end_pos;
  20259. }
  20260. return certs.size();
  20261. }
  20262. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  20263. std::vector<std::string> names;
  20264. if (!ctx) { return names; }
  20265. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20266. if (wctx->ca_pem_data_.empty()) { return names; }
  20267. const std::string &pem = wctx->ca_pem_data_;
  20268. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20269. const std::string end_marker = "-----END CERTIFICATE-----";
  20270. size_t pos = 0;
  20271. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20272. size_t end_pos = pem.find(end_marker, pos);
  20273. if (end_pos == std::string::npos) { break; }
  20274. end_pos += end_marker.size();
  20275. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20276. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20277. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20278. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20279. if (x509) {
  20280. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  20281. if (subject) {
  20282. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  20283. if (name_str) {
  20284. names.push_back(name_str);
  20285. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  20286. }
  20287. }
  20288. wolfSSL_X509_free(x509);
  20289. }
  20290. pos = end_pos;
  20291. }
  20292. return names;
  20293. }
  20294. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  20295. const char *key_pem, const char *password) {
  20296. if (!ctx || !cert_pem || !key_pem) { return false; }
  20297. // Try the pair on a scratch context first, so that a bad one leaves the
  20298. // server's certificate and key as they were
  20299. auto tmp = create_server_context();
  20300. if (!tmp) { return false; }
  20301. auto se = detail::scope_exit([&] { free_context(tmp); });
  20302. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  20303. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  20304. }
  20305. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  20306. if (!ctx || !ca_pem) { return false; }
  20307. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20308. // Replace the CAs rather than add to them, as the other backends do, once
  20309. // the new ones are known to load
  20310. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  20311. if (!store) { return false; }
  20312. free_ca_store(store);
  20313. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  20314. wctx->ca_pem_data_.clear();
  20315. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  20316. }
  20317. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  20318. if (!ctx) { return false; }
  20319. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20320. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  20321. : nullptr;
  20322. {
  20323. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  20324. // A handshake running the previous callback keeps it until it returns.
  20325. wctx->verify_callback.swap(stored);
  20326. }
  20327. impl::apply_verify_mode(*wctx);
  20328. return true;
  20329. }
  20330. inline long get_verify_error(const_session_t session) {
  20331. if (!session) { return -1; }
  20332. auto *wsession =
  20333. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20334. return wolfSSL_get_verify_result(wsession->ssl);
  20335. }
  20336. inline std::string verify_error_string(long error_code) {
  20337. if (error_code == 0) { return ""; }
  20338. const char *str =
  20339. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  20340. return str ? std::string(str) : std::string();
  20341. }
  20342. } // namespace tls
  20343. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  20344. // WebSocket implementation
  20345. namespace ws {
  20346. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  20347. bool fin) {
  20348. std::lock_guard<std::mutex> lock(write_mutex_);
  20349. if (closed_) { return false; }
  20350. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  20351. }
  20352. inline ReadResult WebSocket::read(std::string &msg) {
  20353. // Answers a control frame; any other opcode here is a protocol error.
  20354. // Returns false when the connection is done.
  20355. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  20356. switch (op) {
  20357. case Opcode::Ping: {
  20358. std::lock_guard<std::mutex> lock(write_mutex_);
  20359. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  20360. payload.size(), true, !is_server_);
  20361. return true;
  20362. }
  20363. case Opcode::Pong: {
  20364. std::lock_guard<std::mutex> lock(ping_mutex_);
  20365. unacked_pings_ = 0;
  20366. return true;
  20367. }
  20368. case Opcode::Close: {
  20369. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  20370. // malformed, which is answered with a protocol error instead.
  20371. if (closed_.exchange(true)) { return false; }
  20372. auto reply = payload;
  20373. if (!impl::is_valid_close_payload(payload)) {
  20374. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  20375. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  20376. }
  20377. std::lock_guard<std::mutex> lock(write_mutex_);
  20378. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  20379. reply.size(), true, !is_server_);
  20380. return false;
  20381. }
  20382. default: closed_ = true; return false;
  20383. }
  20384. };
  20385. std::unique_lock<std::mutex> read_lock(read_mutex_);
  20386. // A server going down closes the connection rather than wait on it: its
  20387. // listen() waits for this handler to return.
  20388. auto going_away = [&]() -> ReadResult {
  20389. read_lock.unlock();
  20390. close(CloseStatus::GoingAway, "server stopping");
  20391. return Fail;
  20392. };
  20393. while (!closed_) {
  20394. Opcode opcode;
  20395. std::string payload;
  20396. bool fin;
  20397. impl::FrameRead r =
  20398. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  20399. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  20400. if (r != impl::FrameRead::Ok && server_stopping()) { return going_away(); }
  20401. // A timeout landed on a frame boundary of an open connection: it is
  20402. // untouched and still usable, so hand control back without closing it.
  20403. // That is only useful to a caller who asked for the timeout; the
  20404. // compile-time default is a backstop against a peer gone quiet, and
  20405. // elapsing it closes the connection so a plain `while (ws.read(msg))` loop
  20406. // ends. A wait that a pong timeout cut short finds the connection closed.
  20407. if (r == impl::FrameRead::Timeout && read_timeout_set_ && !closed_) {
  20408. return Timeout;
  20409. }
  20410. if (r != impl::FrameRead::Ok) {
  20411. closed_ = true;
  20412. return Fail;
  20413. }
  20414. switch (opcode) {
  20415. case Opcode::Text:
  20416. case Opcode::Binary: {
  20417. auto result = opcode == Opcode::Text ? Text : Binary;
  20418. msg = std::move(payload);
  20419. // Handle fragmentation
  20420. if (!fin) {
  20421. while (true) {
  20422. Opcode cont_opcode;
  20423. std::string cont_payload;
  20424. bool cont_fin;
  20425. // Only what is left of the limit, but room for a control frame,
  20426. // which may come between the fragments.
  20427. auto max_len =
  20428. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  20429. ? size_t(0)
  20430. : (std::max)(size_t(125),
  20431. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  20432. msg.size());
  20433. // A timeout is not reportable here: half of a fragmented message is
  20434. // already in `msg` and read() has no way to resume it, so it is a
  20435. // failure like any other. Timeouts are only ever seen on a message
  20436. // boundary.
  20437. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  20438. cont_fin, is_server_,
  20439. max_len) != impl::FrameRead::Ok) {
  20440. if (server_stopping()) { return going_away(); }
  20441. closed_ = true;
  20442. return Fail;
  20443. }
  20444. // RFC 6455 5.4: the fragments are continuation frames, with only
  20445. // control frames between them.
  20446. if (cont_opcode != Opcode::Continuation) {
  20447. if (handle_control(cont_opcode, cont_payload)) { continue; }
  20448. return Fail;
  20449. }
  20450. msg += cont_payload;
  20451. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  20452. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  20453. closed_ = true;
  20454. return Fail;
  20455. }
  20456. if (cont_fin) { break; }
  20457. }
  20458. }
  20459. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  20460. if (result == Text && !impl::is_valid_utf8(msg)) {
  20461. // close() takes the read lock to wait for the peer's Close reply, so
  20462. // it must not run while this thread still holds it.
  20463. read_lock.unlock();
  20464. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  20465. return Fail;
  20466. }
  20467. return result;
  20468. }
  20469. default:
  20470. if (handle_control(opcode, payload)) { continue; }
  20471. return Fail;
  20472. }
  20473. }
  20474. return Fail;
  20475. }
  20476. inline bool WebSocket::send(const std::string &data) {
  20477. return send_frame(Opcode::Text, data.data(), data.size());
  20478. }
  20479. inline bool WebSocket::send(const char *data, size_t len) {
  20480. return send_frame(Opcode::Binary, data, len);
  20481. }
  20482. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  20483. if (closed_.exchange(true)) { return; }
  20484. ping_cv_.notify_all();
  20485. std::string payload;
  20486. auto code = static_cast<uint16_t>(status);
  20487. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  20488. payload.push_back(static_cast<char>(code & 0xFF));
  20489. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  20490. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  20491. // cut back to a whole UTF-8 character
  20492. auto short_reason = reason.substr(0, 123);
  20493. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  20494. short_reason.pop_back();
  20495. }
  20496. payload += short_reason;
  20497. // A code that may not be sent, such as NoStatus, goes without a payload
  20498. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  20499. {
  20500. std::lock_guard<std::mutex> lock(write_mutex_);
  20501. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  20502. payload.size(), true, !is_server_);
  20503. }
  20504. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  20505. // Close response before closing the TCP connection.
  20506. //
  20507. // Wait only when no other thread is parsing frames. When one is, it is the
  20508. // thread positioned to see the peer's reply, and reading here would take
  20509. // bytes out of the message it is assembling. Bailing out also leaves the
  20510. // stream, including its read timeout, entirely to that thread.
  20511. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  20512. if (!read_lock.owns_lock()) { return; }
  20513. // A max timeout turns a negative (unbounded) read timeout into 0
  20514. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20515. strm_.set_max_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND * 1000);
  20516. // The max timeout cuts a trickled frame short, the deadline a frame flood
  20517. auto deadline =
  20518. detail::deadline_after(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20519. Opcode op;
  20520. std::string resp;
  20521. bool fin;
  20522. while (std::chrono::steady_clock::now() < deadline &&
  20523. impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  20524. impl::FrameRead::Ok) {
  20525. if (op == Opcode::Close) { break; }
  20526. }
  20527. }
  20528. inline WebSocket::~WebSocket() {
  20529. {
  20530. std::lock_guard<std::mutex> lock(ping_mutex_);
  20531. closed_ = true;
  20532. }
  20533. ping_cv_.notify_all();
  20534. if (ping_thread_.joinable()) { ping_thread_.join(); }
  20535. // A server's stream outlives this object
  20536. strm_.set_read_interrupt(nullptr);
  20537. }
  20538. // A pong timeout ends a read() blocked on the silent peer, and so does the
  20539. // server stopping: its listen() waits for every handler to return.
  20540. inline void WebSocket::interrupt_reads() {
  20541. auto watches_pongs = ping_interval_sec_ > 0 && max_missed_pongs_ > 0;
  20542. if (!watches_pongs && !server_stopping_) { return; }
  20543. strm_.set_read_interrupt(
  20544. [this] { return pong_timed_out_.load() || server_stopping(); });
  20545. }
  20546. inline void WebSocket::start_heartbeat() {
  20547. if (ping_interval_sec_ <= 0) { return; }
  20548. ping_thread_ = std::thread([this]() {
  20549. std::unique_lock<std::mutex> lock(ping_mutex_);
  20550. // The predicate keeps a spurious wakeup from sending a ping early
  20551. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  20552. [this]() { return closed_.load(); })) {
  20553. // If the peer has failed to respond to the previous pings, give up.
  20554. // RFC 6455 does not define a pong-timeout mechanism; this is an
  20555. // opt-in liveness check controlled by max_missed_pongs_.
  20556. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  20557. lock.unlock();
  20558. close(CloseStatus::GoingAway, "pong timeout");
  20559. pong_timed_out_ = true;
  20560. return;
  20561. }
  20562. lock.unlock();
  20563. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  20564. lock.lock();
  20565. closed_ = true;
  20566. break;
  20567. }
  20568. lock.lock();
  20569. unacked_pings_++;
  20570. }
  20571. });
  20572. }
  20573. inline const Request &WebSocket::request() const { return req_; }
  20574. inline bool WebSocket::is_open() const { return !closed_; }
  20575. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  20576. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  20577. // poll(), where 0 would instead mean "return immediately", so hand it the
  20578. // negative poll uses for an unbounded wait.
  20579. if (sec == 0 && usec == 0) { sec = -1; }
  20580. strm_.set_read_timeout(sec, usec);
  20581. read_timeout_set_ = true;
  20582. }
  20583. // WebSocketClient implementation
  20584. inline WebSocketClient::WebSocketClient(
  20585. const std::string &scheme_host_port_path, const Headers &headers)
  20586. : headers_(headers) {
  20587. detail::UrlComponents uc;
  20588. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  20589. !uc.host.empty() && !uc.path.empty()) {
  20590. auto &scheme = uc.scheme;
  20591. #ifdef CPPHTTPLIB_SSL_ENABLED
  20592. if (scheme != "ws" && scheme != "wss") {
  20593. #else
  20594. if (scheme != "ws") {
  20595. #endif
  20596. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  20597. std::string msg = "'" + scheme + "' scheme is not supported.";
  20598. throw std::invalid_argument(msg);
  20599. #endif
  20600. return;
  20601. }
  20602. auto is_ssl = scheme == "wss";
  20603. host_ = std::move(uc.host);
  20604. port_ = is_ssl ? 443 : 80;
  20605. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  20606. path_ = std::move(uc.path);
  20607. if (!uc.query.empty()) { path_ += uc.query; }
  20608. #ifdef CPPHTTPLIB_SSL_ENABLED
  20609. is_ssl_ = is_ssl;
  20610. if (is_ssl_) {
  20611. // The context lives as long as the client so that CA configuration
  20612. // survives reconnects; sessions are created per connection.
  20613. tls_ctx_ = tls::create_client_context();
  20614. if (!tls_ctx_) { return; }
  20615. }
  20616. #else
  20617. if (is_ssl) { return; }
  20618. #endif
  20619. is_valid_ = true;
  20620. }
  20621. }
  20622. #ifdef CPPHTTPLIB_SSL_ENABLED
  20623. inline WebSocketClient::WebSocketClient(
  20624. const std::string &scheme_host_port_path, const PemMemory &pem,
  20625. const Headers &headers)
  20626. : WebSocketClient(scheme_host_port_path, headers) {
  20627. // For ws:// URLs the client certificate is silently ignored, consistent
  20628. // with the TLS-only setters such as set_ca_cert_path().
  20629. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  20630. std::string cert_buf, key_buf;
  20631. if (!tls::set_client_cert_pem(
  20632. tls_ctx_,
  20633. detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  20634. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  20635. pem.private_key_password)) {
  20636. tls::free_context(tls_ctx_);
  20637. tls_ctx_ = nullptr;
  20638. is_valid_ = false;
  20639. }
  20640. }
  20641. }
  20642. #endif
  20643. inline WebSocketClient::~WebSocketClient() {
  20644. shutdown_and_close();
  20645. #ifdef CPPHTTPLIB_SSL_ENABLED
  20646. if (tls_ctx_) {
  20647. tls::free_context(tls_ctx_);
  20648. tls_ctx_ = nullptr;
  20649. }
  20650. #endif
  20651. }
  20652. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  20653. inline void WebSocketClient::shutdown_and_close() {
  20654. // Send the close frame while the TLS session is still alive: ws_ holds an
  20655. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  20656. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  20657. if (ws_ && ws_->is_open()) { ws_->close(); }
  20658. ws_.reset();
  20659. #ifdef CPPHTTPLIB_SSL_ENABLED
  20660. if (is_ssl_) {
  20661. if (tls_session_) {
  20662. tls::shutdown(tls_session_, true);
  20663. tls::free_session(tls_session_);
  20664. tls_session_ = nullptr;
  20665. }
  20666. }
  20667. #endif
  20668. if (sock_ != INVALID_SOCKET) {
  20669. detail::shutdown_socket(sock_);
  20670. detail::close_socket(sock_);
  20671. sock_ = INVALID_SOCKET;
  20672. }
  20673. }
  20674. // The handshakes belong to establishing the connection, so an unset read
  20675. // timeout leaves them bounded by the connection timeout instead of forever.
  20676. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  20677. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  20678. return {connection_timeout_sec_, connection_timeout_usec_};
  20679. }
  20680. return {read_timeout_sec_, read_timeout_usec_};
  20681. }
  20682. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  20683. Error &error, int &ssl_error,
  20684. uint64_t &ssl_backend_error) {
  20685. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  20686. // The streams wait with poll(), where 0 instead means "return immediately",
  20687. // so they are given the negative poll uses for an unbounded wait.
  20688. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  20689. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  20690. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  20691. #ifdef CPPHTTPLIB_SSL_ENABLED
  20692. if (is_ssl_) {
  20693. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  20694. // is not safe to call concurrently on one client to begin with, since
  20695. // nothing else here is guarded either.
  20696. if (server_certificate_verification_ && !certs_loaded_) {
  20697. uint64_t backend_error = 0;
  20698. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  20699. ca_cert_dir_path_, custom_ca_loaded_,
  20700. system_ca_mode_, backend_error);
  20701. certs_loaded_ = true;
  20702. }
  20703. detail::ClientTlsSessionOptions options;
  20704. options.server_hostname_verification = server_hostname_verification_;
  20705. options.session_verifier = session_verifier_;
  20706. auto timeout = handshake_timeout();
  20707. detail::ClientTlsSessionError tls_error;
  20708. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  20709. server_certificate_verification_,
  20710. timeout.first, timeout.second,
  20711. &tls_error, options)) {
  20712. error = tls_error.error;
  20713. ssl_error = tls_error.ssl_error;
  20714. ssl_backend_error = tls_error.backend_error;
  20715. return false;
  20716. }
  20717. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  20718. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  20719. write_timeout_usec_));
  20720. return true;
  20721. }
  20722. #else
  20723. (void)error;
  20724. (void)ssl_error;
  20725. (void)ssl_backend_error;
  20726. #endif
  20727. strm = std::unique_ptr<Stream>(
  20728. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20729. write_timeout_sec_, write_timeout_usec_));
  20730. return true;
  20731. }
  20732. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20733. #ifdef CPPHTTPLIB_SSL_ENABLED
  20734. auto is_ssl = is_ssl_;
  20735. #else
  20736. auto is_ssl = false;
  20737. #endif
  20738. if (!req.has_header("Host")) {
  20739. req.headers.emplace("Host", detail::make_default_host_header_value(
  20740. host_, port_, is_ssl, address_family_));
  20741. }
  20742. detail::add_default_user_agent_header(req);
  20743. detail::add_authorization_header(req, basic_auth_username_,
  20744. basic_auth_password_,
  20745. bearer_token_auth_token_, false);
  20746. }
  20747. inline Result WebSocketClient::connect() {
  20748. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20749. shutdown_and_close();
  20750. auto error = Error::Success;
  20751. if (!create_and_connect_socket(error)) {
  20752. return Result{error, -1, Headers{}};
  20753. }
  20754. if (is_proxy_enabled()) {
  20755. Response proxy_res;
  20756. if (!connect_with_proxy(proxy_res, error)) {
  20757. shutdown_and_close();
  20758. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  20759. }
  20760. }
  20761. std::unique_ptr<Stream> strm;
  20762. auto stream_error = Error::SSLConnection;
  20763. int ssl_error = 0;
  20764. uint64_t ssl_backend_error = 0;
  20765. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20766. shutdown_and_close();
  20767. #ifdef CPPHTTPLIB_SSL_ENABLED
  20768. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20769. #else
  20770. return Result{stream_error, -1, Headers{}};
  20771. #endif
  20772. }
  20773. Request req;
  20774. req.method = "GET";
  20775. req.path = path_;
  20776. req.headers = headers_;
  20777. prepare_default_headers(req);
  20778. detail::WebSocketUpgradeResponse upgrade;
  20779. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20780. shutdown_and_close();
  20781. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20782. }
  20783. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20784. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20785. websocket_ping_interval_sec_,
  20786. websocket_max_missed_pongs_));
  20787. // The stream was created with the timeout already; tell the WebSocket
  20788. // whether it came from the caller, so read() knows to report it as Timeout.
  20789. ws_->read_timeout_set_ = read_timeout_set_;
  20790. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20791. }
  20792. inline ReadResult WebSocketClient::read(std::string &msg) {
  20793. if (!ws_) { return Fail; }
  20794. return ws_->read(msg);
  20795. }
  20796. inline bool WebSocketClient::send(const std::string &data) {
  20797. if (!ws_) { return false; }
  20798. return ws_->send(data);
  20799. }
  20800. inline bool WebSocketClient::send(const char *data, size_t len) {
  20801. if (!ws_) { return false; }
  20802. return ws_->send(data, len);
  20803. }
  20804. inline void WebSocketClient::close(CloseStatus status,
  20805. const std::string &reason) {
  20806. if (ws_) { ws_->close(status, reason); }
  20807. }
  20808. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20809. inline const std::string &WebSocketClient::subprotocol() const {
  20810. return subprotocol_;
  20811. }
  20812. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20813. read_timeout_sec_ = sec;
  20814. read_timeout_usec_ = usec;
  20815. read_timeout_set_ = true;
  20816. // The members above only seed the next connect(); read() consults the
  20817. // stream, so an already-open connection has to be told directly.
  20818. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20819. }
  20820. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20821. write_timeout_sec_ = sec;
  20822. write_timeout_usec_ = usec;
  20823. }
  20824. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20825. websocket_ping_interval_sec_ = sec;
  20826. }
  20827. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20828. websocket_max_missed_pongs_ = count;
  20829. }
  20830. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20831. inline void WebSocketClient::set_address_family(int family) {
  20832. address_family_ = family;
  20833. }
  20834. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20835. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20836. socket_options_ = std::move(socket_options);
  20837. }
  20838. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20839. connection_timeout_sec_ = sec;
  20840. connection_timeout_usec_ = usec;
  20841. }
  20842. inline void WebSocketClient::set_interface(const std::string &intf) {
  20843. interface_ = intf;
  20844. }
  20845. inline void WebSocketClient::set_hostname_addr_map(
  20846. std::map<std::string, std::string> addr_map) {
  20847. set_direct_hostname_addr_map(std::move(addr_map));
  20848. }
  20849. inline void WebSocketClient::set_direct_hostname_addr_map(
  20850. std::map<std::string, std::string> addr_map) {
  20851. addr_map_ = std::move(addr_map);
  20852. }
  20853. inline void WebSocketClient::set_tunnel_hostname_addr_map(
  20854. std::map<std::string, std::string> addr_map) {
  20855. tunnel_addr_map_ = std::move(addr_map);
  20856. }
  20857. inline bool WebSocketClient::is_proxy_enabled() const {
  20858. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  20859. if (no_proxy_entries_.empty()) { return true; }
  20860. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  20861. no_proxy_entries_);
  20862. }
  20863. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  20864. std::string connect_host;
  20865. std::string ip;
  20866. auto port = port_;
  20867. if (is_proxy_enabled()) {
  20868. connect_host = proxy_host_;
  20869. port = proxy_port_;
  20870. } else {
  20871. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20872. }
  20873. sock_ = detail::create_client_socket(
  20874. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  20875. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20876. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20877. write_timeout_usec_, interface_, error);
  20878. if (sock_ != INVALID_SOCKET) { return true; }
  20879. if (error == Error::Success) { error = Error::Connection; }
  20880. return false;
  20881. }
  20882. inline bool WebSocketClient::send_proxy_connect(Request &req,
  20883. Response &proxy_res,
  20884. Error &error) {
  20885. auto timeout = handshake_timeout();
  20886. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  20887. write_timeout_sec_, write_timeout_usec_);
  20888. if (!detail::write_request_head(strm, req, error)) { return false; }
  20889. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  20890. error = Error::Read;
  20891. return false;
  20892. }
  20893. return true;
  20894. }
  20895. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  20896. // forward an Upgrade request.
  20897. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  20898. Error &error) {
  20899. Request req;
  20900. req.method = "CONNECT";
  20901. req.path =
  20902. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  20903. req.headers.emplace("Host", req.path);
  20904. detail::add_default_user_agent_header(req);
  20905. detail::add_authorization_header(req, proxy_basic_auth_username_,
  20906. proxy_basic_auth_password_,
  20907. proxy_bearer_token_auth_token_, true);
  20908. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20909. #ifdef CPPHTTPLIB_SSL_ENABLED
  20910. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  20911. std::map<std::string, std::string> auth;
  20912. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  20913. !proxy_digest_auth_username_.empty() &&
  20914. !proxy_digest_auth_password_.empty() &&
  20915. detail::parse_www_authenticate(proxy_res, auth, true)) {
  20916. proxy_res = Response();
  20917. shutdown_and_close();
  20918. if (!create_and_connect_socket(error)) { return false; }
  20919. req.headers.erase("Proxy-Authorization");
  20920. req.headers.insert(detail::make_digest_authentication_header(
  20921. req, req.path, auth, 1, detail::random_string(10),
  20922. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  20923. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20924. }
  20925. #endif
  20926. if (proxy_res.status != StatusCode::OK_200) {
  20927. error = Error::ProxyConnection;
  20928. return false;
  20929. }
  20930. return true;
  20931. }
  20932. inline void WebSocketClient::set_basic_auth(const std::string &username,
  20933. const std::string &password) {
  20934. basic_auth_username_ = username;
  20935. basic_auth_password_ = password;
  20936. }
  20937. inline void WebSocketClient::set_bearer_token_auth(const std::string &token) {
  20938. bearer_token_auth_token_ = token;
  20939. }
  20940. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  20941. proxy_host_ = host;
  20942. proxy_port_ = port;
  20943. }
  20944. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  20945. const std::string &password) {
  20946. proxy_basic_auth_username_ = username;
  20947. proxy_basic_auth_password_ = password;
  20948. }
  20949. inline void
  20950. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  20951. proxy_bearer_token_auth_token_ = token;
  20952. }
  20953. inline void
  20954. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  20955. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  20956. }
  20957. #ifdef CPPHTTPLIB_SSL_ENABLED
  20958. inline void
  20959. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20960. const std::string &ca_cert_dir_path) {
  20961. ca_cert_file_path_ = ca_cert_file_path;
  20962. ca_cert_dir_path_ = ca_cert_dir_path;
  20963. }
  20964. inline void
  20965. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  20966. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  20967. }
  20968. inline void WebSocketClient::set_session_verifier(
  20969. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  20970. session_verifier_ = std::move(verifier);
  20971. }
  20972. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20973. if (store && tls_ctx_) {
  20974. // set_ca_store takes ownership of store
  20975. tls::set_ca_store(tls_ctx_, store);
  20976. } else if (store) {
  20977. tls::free_ca_store(store);
  20978. }
  20979. custom_ca_loaded_ = true;
  20980. }
  20981. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20982. std::size_t size) {
  20983. if (tls_ctx_ && ca_cert && size > 0) {
  20984. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20985. }
  20986. custom_ca_loaded_ = true;
  20987. }
  20988. inline void
  20989. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20990. server_certificate_verification_ = enabled;
  20991. }
  20992. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20993. server_hostname_verification_ = enabled;
  20994. }
  20995. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20996. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20997. }
  20998. inline void
  20999. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  21000. const std::string &password) {
  21001. proxy_digest_auth_username_ = username;
  21002. proxy_digest_auth_password_ = password;
  21003. }
  21004. #endif // CPPHTTPLIB_SSL_ENABLED
  21005. } // namespace ws
  21006. // ----------------------------------------------------------------------------
  21007. } // namespace httplib
  21008. #endif // CPPHTTPLIB_HTTPLIB_H