protocol_test.go 292 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048
  1. // Copyright (C) 2019-2023 Nicola Murino
  2. //
  3. // This program is free software: you can redistribute it and/or modify
  4. // it under the terms of the GNU Affero General Public License as published
  5. // by the Free Software Foundation, version 3.
  6. //
  7. // This program is distributed in the hope that it will be useful,
  8. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. // GNU Affero General Public License for more details.
  11. //
  12. // You should have received a copy of the GNU Affero General Public License
  13. // along with this program. If not, see <https://www.gnu.org/licenses/>.
  14. package common_test
  15. import (
  16. "bufio"
  17. "bytes"
  18. "crypto/rand"
  19. "encoding/json"
  20. "errors"
  21. "fmt"
  22. "io"
  23. "io/fs"
  24. "math"
  25. "net"
  26. "net/http"
  27. "os"
  28. "path"
  29. "path/filepath"
  30. "runtime"
  31. "strings"
  32. "sync"
  33. "testing"
  34. "time"
  35. _ "github.com/go-sql-driver/mysql"
  36. _ "github.com/jackc/pgx/v5/stdlib"
  37. _ "github.com/mattn/go-sqlite3"
  38. "github.com/mhale/smtpd"
  39. "github.com/minio/sio"
  40. "github.com/pkg/sftp"
  41. "github.com/pquerna/otp"
  42. "github.com/pquerna/otp/totp"
  43. "github.com/rs/xid"
  44. "github.com/rs/zerolog"
  45. "github.com/sftpgo/sdk"
  46. "github.com/stretchr/testify/assert"
  47. "github.com/stretchr/testify/require"
  48. "github.com/studio-b12/gowebdav"
  49. "golang.org/x/crypto/ssh"
  50. "github.com/drakkan/sftpgo/v2/internal/common"
  51. "github.com/drakkan/sftpgo/v2/internal/config"
  52. "github.com/drakkan/sftpgo/v2/internal/dataprovider"
  53. "github.com/drakkan/sftpgo/v2/internal/httpclient"
  54. "github.com/drakkan/sftpgo/v2/internal/httpdtest"
  55. "github.com/drakkan/sftpgo/v2/internal/kms"
  56. "github.com/drakkan/sftpgo/v2/internal/logger"
  57. "github.com/drakkan/sftpgo/v2/internal/mfa"
  58. "github.com/drakkan/sftpgo/v2/internal/sftpd"
  59. "github.com/drakkan/sftpgo/v2/internal/smtp"
  60. "github.com/drakkan/sftpgo/v2/internal/util"
  61. "github.com/drakkan/sftpgo/v2/internal/vfs"
  62. "github.com/drakkan/sftpgo/v2/internal/webdavd"
  63. )
  64. const (
  65. httpAddr = "127.0.0.1:9999"
  66. httpProxyAddr = "127.0.0.1:7777"
  67. sftpServerAddr = "127.0.0.1:4022"
  68. smtpServerAddr = "127.0.0.1:2525"
  69. webDavServerPort = 9191
  70. httpFsPort = 34567
  71. defaultUsername = "test_common_sftp"
  72. defaultPassword = "test_password"
  73. defaultSFTPUsername = "test_common_sftpfs_user"
  74. defaultHTTPFsUsername = "httpfs_ftp_user"
  75. httpFsWellKnowDir = "/wellknow"
  76. osWindows = "windows"
  77. testFileName = "test_file_common_sftp.dat"
  78. testDir = "test_dir_common"
  79. )
  80. var (
  81. configDir = filepath.Join(".", "..", "..")
  82. allPerms = []string{dataprovider.PermAny}
  83. homeBasePath string
  84. logFilePath string
  85. backupsPath string
  86. testFileContent = []byte("test data")
  87. lastReceivedEmail receivedEmail
  88. )
  89. func TestMain(m *testing.M) {
  90. homeBasePath = os.TempDir()
  91. logFilePath = filepath.Join(configDir, "common_test.log")
  92. backupsPath = filepath.Join(os.TempDir(), "backups")
  93. logger.InitLogger(logFilePath, 5, 1, 28, false, false, zerolog.DebugLevel)
  94. os.Setenv("SFTPGO_DATA_PROVIDER__CREATE_DEFAULT_ADMIN", "1")
  95. os.Setenv("SFTPGO_COMMON__ALLOW_SELF_CONNECTIONS", "1")
  96. os.Setenv("SFTPGO_DEFAULT_ADMIN_USERNAME", "admin")
  97. os.Setenv("SFTPGO_DEFAULT_ADMIN_PASSWORD", "password")
  98. err := config.LoadConfig(configDir, "")
  99. if err != nil {
  100. logger.ErrorToConsole("error loading configuration: %v", err)
  101. os.Exit(1)
  102. }
  103. providerConf := config.GetProviderConf()
  104. providerConf.BackupsPath = backupsPath
  105. logger.InfoToConsole("Starting COMMON tests, provider: %v", providerConf.Driver)
  106. err = dataprovider.Initialize(providerConf, configDir, true)
  107. if err != nil {
  108. logger.ErrorToConsole("error initializing data provider: %v", err)
  109. os.Exit(1)
  110. }
  111. err = common.Initialize(config.GetCommonConfig(), 0)
  112. if err != nil {
  113. logger.WarnToConsole("error initializing common: %v", err)
  114. os.Exit(1)
  115. }
  116. httpConfig := config.GetHTTPConfig()
  117. httpConfig.Timeout = 5
  118. httpConfig.RetryMax = 0
  119. httpConfig.Initialize(configDir) //nolint:errcheck
  120. kmsConfig := config.GetKMSConfig()
  121. err = kmsConfig.Initialize()
  122. if err != nil {
  123. logger.ErrorToConsole("error initializing kms: %v", err)
  124. os.Exit(1)
  125. }
  126. mfaConfig := config.GetMFAConfig()
  127. err = mfaConfig.Initialize()
  128. if err != nil {
  129. logger.ErrorToConsole("error initializing MFA: %v", err)
  130. os.Exit(1)
  131. }
  132. sftpdConf := config.GetSFTPDConfig()
  133. sftpdConf.Bindings[0].Port = 4022
  134. sftpdConf.EnabledSSHCommands = []string{"*"}
  135. sftpdConf.Bindings = append(sftpdConf.Bindings, sftpd.Binding{
  136. Port: 4024,
  137. })
  138. sftpdConf.KeyboardInteractiveAuthentication = true
  139. httpdConf := config.GetHTTPDConfig()
  140. httpdConf.Bindings[0].Port = 4080
  141. httpdtest.SetBaseURL("http://127.0.0.1:4080")
  142. webDavConf := config.GetWebDAVDConfig()
  143. webDavConf.Bindings = []webdavd.Binding{
  144. {
  145. Port: webDavServerPort,
  146. },
  147. }
  148. go func() {
  149. if err := sftpdConf.Initialize(configDir); err != nil {
  150. logger.ErrorToConsole("could not start SFTP server: %v", err)
  151. os.Exit(1)
  152. }
  153. }()
  154. go func() {
  155. if err := httpdConf.Initialize(configDir, 0); err != nil {
  156. logger.ErrorToConsole("could not start HTTP server: %v", err)
  157. os.Exit(1)
  158. }
  159. }()
  160. go func() {
  161. if err := webDavConf.Initialize(configDir); err != nil {
  162. logger.ErrorToConsole("could not start WebDAV server: %v", err)
  163. os.Exit(1)
  164. }
  165. }()
  166. waitTCPListening(sftpdConf.Bindings[0].GetAddress())
  167. waitTCPListening(httpdConf.Bindings[0].GetAddress())
  168. waitTCPListening(webDavConf.Bindings[0].GetAddress())
  169. startHTTPFs()
  170. go func() {
  171. // start a test HTTP server to receive action notifications
  172. http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
  173. fmt.Fprintf(w, "OK\n")
  174. })
  175. http.HandleFunc("/404", func(w http.ResponseWriter, r *http.Request) {
  176. w.WriteHeader(http.StatusNotFound)
  177. fmt.Fprintf(w, "Not found\n")
  178. })
  179. http.HandleFunc("/multipart", func(w http.ResponseWriter, r *http.Request) {
  180. err := r.ParseMultipartForm(1048576)
  181. if err != nil {
  182. w.WriteHeader(http.StatusInternalServerError)
  183. fmt.Fprintf(w, "KO\n")
  184. return
  185. }
  186. defer r.MultipartForm.RemoveAll() //nolint:errcheck
  187. fmt.Fprintf(w, "OK\n")
  188. })
  189. if err := http.ListenAndServe(httpAddr, nil); err != nil {
  190. logger.ErrorToConsole("could not start HTTP notification server: %v", err)
  191. os.Exit(1)
  192. }
  193. }()
  194. go func() {
  195. common.Config.ProxyProtocol = 2
  196. listener, err := net.Listen("tcp", httpProxyAddr)
  197. if err != nil {
  198. logger.ErrorToConsole("error creating listener for proxy protocol server: %v", err)
  199. os.Exit(1)
  200. }
  201. proxyListener, err := common.Config.GetProxyListener(listener)
  202. if err != nil {
  203. logger.ErrorToConsole("error creating proxy protocol listener: %v", err)
  204. os.Exit(1)
  205. }
  206. common.Config.ProxyProtocol = 0
  207. s := &http.Server{}
  208. if err := s.Serve(proxyListener); err != nil {
  209. logger.ErrorToConsole("could not start HTTP proxy protocol server: %v", err)
  210. os.Exit(1)
  211. }
  212. }()
  213. go func() {
  214. if err := smtpd.ListenAndServe(smtpServerAddr, func(remoteAddr net.Addr, from string, to []string, data []byte) error {
  215. lastReceivedEmail.set(from, to, data)
  216. return nil
  217. }, "SFTPGo test", "localhost"); err != nil {
  218. logger.ErrorToConsole("could not start SMTP server: %v", err)
  219. os.Exit(1)
  220. }
  221. }()
  222. waitTCPListening(httpAddr)
  223. waitTCPListening(httpProxyAddr)
  224. waitTCPListening(smtpServerAddr)
  225. exitCode := m.Run()
  226. os.Remove(logFilePath)
  227. os.RemoveAll(backupsPath)
  228. os.Exit(exitCode)
  229. }
  230. func TestBaseConnection(t *testing.T) {
  231. u := getTestUser()
  232. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  233. assert.NoError(t, err)
  234. err = os.RemoveAll(user.GetHomeDir())
  235. assert.NoError(t, err)
  236. conn, client, err := getSftpClient(user)
  237. if assert.NoError(t, err) {
  238. defer conn.Close()
  239. defer client.Close()
  240. assert.NoError(t, checkBasicSFTP(client))
  241. _, err = client.ReadDir(testDir)
  242. assert.ErrorIs(t, err, os.ErrNotExist)
  243. err = client.RemoveDirectory(testDir)
  244. assert.ErrorIs(t, err, os.ErrNotExist)
  245. err = client.Mkdir(testDir)
  246. assert.NoError(t, err)
  247. err = client.Mkdir(testDir)
  248. assert.Error(t, err)
  249. info, err := client.Stat(testDir)
  250. if assert.NoError(t, err) {
  251. assert.True(t, info.IsDir())
  252. }
  253. err = client.Rename(testDir, testDir)
  254. if assert.Error(t, err) {
  255. assert.Contains(t, err.Error(), "the rename source and target cannot be the same")
  256. }
  257. err = client.Rename(testDir, path.Join(testDir, "sub"))
  258. if assert.Error(t, err) {
  259. assert.Contains(t, err.Error(), "SSH_FX_OP_UNSUPPORTED")
  260. }
  261. err = client.RemoveDirectory(testDir)
  262. assert.NoError(t, err)
  263. err = client.Remove(testFileName)
  264. assert.ErrorIs(t, err, os.ErrNotExist)
  265. f, err := client.Create(testFileName)
  266. assert.NoError(t, err)
  267. _, err = f.Write(testFileContent)
  268. assert.NoError(t, err)
  269. err = f.Close()
  270. assert.NoError(t, err)
  271. linkName := testFileName + ".link" //nolint:goconst
  272. err = client.Rename(testFileName, testFileName)
  273. if assert.Error(t, err) {
  274. assert.Contains(t, err.Error(), "the rename source and target cannot be the same")
  275. }
  276. err = client.Symlink(testFileName, linkName)
  277. assert.NoError(t, err)
  278. err = client.Symlink(testFileName, testFileName)
  279. assert.Error(t, err)
  280. info, err = client.Stat(testFileName)
  281. if assert.NoError(t, err) {
  282. assert.Equal(t, int64(len(testFileContent)), info.Size())
  283. assert.False(t, info.IsDir())
  284. }
  285. info, err = client.Lstat(linkName)
  286. if assert.NoError(t, err) {
  287. assert.NotEqual(t, int64(7), info.Size())
  288. assert.True(t, info.Mode()&os.ModeSymlink != 0)
  289. assert.False(t, info.IsDir())
  290. }
  291. err = client.RemoveDirectory(linkName)
  292. if assert.Error(t, err) {
  293. assert.Contains(t, err.Error(), "SSH_FX_FAILURE")
  294. }
  295. err = client.Remove(testFileName)
  296. assert.NoError(t, err)
  297. err = client.Remove(linkName)
  298. assert.NoError(t, err)
  299. err = client.Rename(testFileName, "test")
  300. assert.ErrorIs(t, err, os.ErrNotExist)
  301. f, err = client.Create(testFileName)
  302. assert.NoError(t, err)
  303. err = f.Close()
  304. assert.NoError(t, err)
  305. err = client.Rename(testFileName, testFileName+"1")
  306. assert.NoError(t, err)
  307. err = client.Remove(testFileName + "1")
  308. assert.NoError(t, err)
  309. err = client.RemoveDirectory("missing")
  310. assert.Error(t, err)
  311. } else {
  312. printLatestLogs(10)
  313. }
  314. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  315. assert.NoError(t, err)
  316. err = os.RemoveAll(user.GetHomeDir())
  317. assert.NoError(t, err)
  318. }
  319. func TestRemoveAll(t *testing.T) {
  320. u := getTestUser()
  321. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  322. assert.NoError(t, err)
  323. webDavClient := getWebDavClient(user)
  324. err = webDavClient.RemoveAll("/")
  325. if assert.Error(t, err) {
  326. assert.True(t, gowebdav.IsErrCode(err, http.StatusForbidden))
  327. }
  328. testDir := "baseDir"
  329. err = webDavClient.RemoveAll(testDir)
  330. assert.NoError(t, err)
  331. conn, client, err := getSftpClient(user)
  332. if assert.NoError(t, err) {
  333. defer conn.Close()
  334. defer client.Close()
  335. err = client.Mkdir(testDir)
  336. assert.NoError(t, err)
  337. err = writeSFTPFile(path.Join(testDir, testFileName), 1234, client)
  338. assert.NoError(t, err)
  339. err = webDavClient.RemoveAll(path.Join(testDir, testFileName))
  340. assert.NoError(t, err)
  341. _, err = client.Stat(path.Join(testDir, testFileName))
  342. assert.Error(t, err)
  343. err = writeSFTPFile(path.Join(testDir, testFileName), 1234, client)
  344. assert.NoError(t, err)
  345. err = webDavClient.RemoveAll(testDir)
  346. assert.NoError(t, err)
  347. _, err = client.Stat(testDir)
  348. assert.Error(t, err)
  349. }
  350. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  351. assert.NoError(t, err)
  352. err = os.RemoveAll(user.GetHomeDir())
  353. assert.NoError(t, err)
  354. }
  355. func TestRelativeSymlinks(t *testing.T) {
  356. u := getTestUser()
  357. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  358. assert.NoError(t, err)
  359. err = os.RemoveAll(user.GetHomeDir())
  360. assert.NoError(t, err)
  361. conn, client, err := getSftpClient(user)
  362. if assert.NoError(t, err) {
  363. defer conn.Close()
  364. defer client.Close()
  365. linkName := testFileName + "_link" //nolint:goconst
  366. err = client.Symlink("non-existent-file", linkName)
  367. assert.NoError(t, err)
  368. err = client.Remove(linkName)
  369. assert.NoError(t, err)
  370. testDir := "sub"
  371. err = client.Mkdir(testDir)
  372. assert.NoError(t, err)
  373. f, err := client.Create(path.Join(testDir, testFileName))
  374. assert.NoError(t, err)
  375. _, err = f.Write(testFileContent)
  376. assert.NoError(t, err)
  377. err = f.Close()
  378. assert.NoError(t, err)
  379. err = client.Symlink(path.Join(testDir, testFileName), linkName)
  380. assert.NoError(t, err)
  381. _, err = client.Stat(linkName)
  382. assert.NoError(t, err)
  383. p, err := client.ReadLink(linkName)
  384. assert.NoError(t, err)
  385. assert.Equal(t, path.Join("/", testDir, testFileName), p)
  386. err = client.Remove(linkName)
  387. assert.NoError(t, err)
  388. err = client.Symlink(testFileName, path.Join(testDir, linkName))
  389. assert.NoError(t, err)
  390. _, err = client.Stat(path.Join(testDir, linkName))
  391. assert.NoError(t, err)
  392. p, err = client.ReadLink(path.Join(testDir, linkName))
  393. assert.NoError(t, err)
  394. assert.Equal(t, path.Join("/", testDir, testFileName), p)
  395. f, err = client.Create(testFileName)
  396. assert.NoError(t, err)
  397. _, err = f.Write(testFileContent)
  398. assert.NoError(t, err)
  399. err = f.Close()
  400. assert.NoError(t, err)
  401. err = client.Symlink(testFileName, linkName)
  402. assert.NoError(t, err)
  403. _, err = client.Stat(linkName)
  404. assert.NoError(t, err)
  405. p, err = client.ReadLink(linkName)
  406. assert.NoError(t, err)
  407. assert.Equal(t, path.Join("/", testFileName), p)
  408. }
  409. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  410. assert.NoError(t, err)
  411. err = os.RemoveAll(user.GetHomeDir())
  412. assert.NoError(t, err)
  413. }
  414. func TestCheckFsAfterUpdate(t *testing.T) {
  415. u := getTestUser()
  416. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  417. assert.NoError(t, err)
  418. conn, client, err := getSftpClient(user)
  419. if assert.NoError(t, err) {
  420. defer conn.Close()
  421. defer client.Close()
  422. err = checkBasicSFTP(client)
  423. assert.NoError(t, err)
  424. }
  425. // remove the home dir, it will not be re-created
  426. err = os.RemoveAll(user.GetHomeDir())
  427. assert.NoError(t, err)
  428. conn, client, err = getSftpClient(user)
  429. if assert.NoError(t, err) {
  430. defer conn.Close()
  431. defer client.Close()
  432. err = checkBasicSFTP(client)
  433. assert.Error(t, err)
  434. } else {
  435. printLatestLogs(10)
  436. }
  437. // update the user and login again, this time the home dir will be created
  438. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  439. assert.NoError(t, err)
  440. conn, client, err = getSftpClient(user)
  441. if assert.NoError(t, err) {
  442. defer conn.Close()
  443. defer client.Close()
  444. err = checkBasicSFTP(client)
  445. assert.NoError(t, err)
  446. }
  447. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  448. assert.NoError(t, err)
  449. err = os.RemoveAll(user.GetHomeDir())
  450. assert.NoError(t, err)
  451. }
  452. func TestSetStat(t *testing.T) {
  453. u := getTestUser()
  454. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  455. assert.NoError(t, err)
  456. err = os.RemoveAll(user.GetHomeDir())
  457. assert.NoError(t, err)
  458. conn, client, err := getSftpClient(user)
  459. if assert.NoError(t, err) {
  460. defer conn.Close()
  461. defer client.Close()
  462. f, err := client.Create(testFileName)
  463. assert.NoError(t, err)
  464. _, err = f.Write(testFileContent)
  465. assert.NoError(t, err)
  466. err = f.Close()
  467. assert.NoError(t, err)
  468. acmodTime := time.Now().Add(36 * time.Hour)
  469. err = client.Chtimes(testFileName, acmodTime, acmodTime)
  470. assert.NoError(t, err)
  471. newFi, err := client.Lstat(testFileName)
  472. assert.NoError(t, err)
  473. diff := math.Abs(newFi.ModTime().Sub(acmodTime).Seconds())
  474. assert.LessOrEqual(t, diff, float64(1))
  475. if runtime.GOOS != osWindows {
  476. err = client.Chown(testFileName, os.Getuid(), os.Getgid())
  477. assert.NoError(t, err)
  478. }
  479. newPerm := os.FileMode(0666)
  480. err = client.Chmod(testFileName, newPerm)
  481. assert.NoError(t, err)
  482. newFi, err = client.Lstat(testFileName)
  483. if assert.NoError(t, err) {
  484. assert.Equal(t, newPerm, newFi.Mode().Perm())
  485. }
  486. err = client.Truncate(testFileName, 2)
  487. assert.NoError(t, err)
  488. info, err := client.Stat(testFileName)
  489. if assert.NoError(t, err) {
  490. assert.Equal(t, int64(2), info.Size())
  491. }
  492. err = client.Remove(testFileName)
  493. assert.NoError(t, err)
  494. err = client.Truncate(testFileName, 0)
  495. assert.ErrorIs(t, err, os.ErrNotExist)
  496. err = client.Chtimes(testFileName, acmodTime, acmodTime)
  497. assert.ErrorIs(t, err, os.ErrNotExist)
  498. if runtime.GOOS != osWindows {
  499. err = client.Chown(testFileName, os.Getuid(), os.Getgid())
  500. assert.ErrorIs(t, err, os.ErrNotExist)
  501. }
  502. err = client.Chmod(testFileName, newPerm)
  503. assert.ErrorIs(t, err, os.ErrNotExist)
  504. }
  505. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  506. assert.NoError(t, err)
  507. err = os.RemoveAll(user.GetHomeDir())
  508. assert.NoError(t, err)
  509. }
  510. func TestCryptFsUserUploadErrorOverwrite(t *testing.T) {
  511. u := getCryptFsUser()
  512. u.QuotaSize = 6000
  513. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  514. assert.NoError(t, err)
  515. var buf []byte
  516. for i := 0; i < 4000; i++ {
  517. buf = append(buf, []byte("a")...)
  518. }
  519. bufSize := int64(len(buf))
  520. reader := bytes.NewReader(buf)
  521. conn, client, err := getSftpClient(user)
  522. if assert.NoError(t, err) {
  523. defer conn.Close()
  524. defer client.Close()
  525. f, err := client.Create(testFileName + "_big")
  526. assert.NoError(t, err)
  527. n, err := io.Copy(f, reader)
  528. assert.NoError(t, err)
  529. assert.Equal(t, bufSize, n)
  530. err = f.Close()
  531. assert.NoError(t, err)
  532. encryptedSize, err := getEncryptedFileSize(bufSize)
  533. assert.NoError(t, err)
  534. expectedSize := encryptedSize
  535. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  536. assert.NoError(t, err)
  537. assert.Equal(t, 1, user.UsedQuotaFiles)
  538. assert.Equal(t, expectedSize, user.UsedQuotaSize)
  539. // now write a small file
  540. f, err = client.Create(testFileName)
  541. assert.NoError(t, err)
  542. _, err = f.Write(testFileContent)
  543. assert.NoError(t, err)
  544. err = f.Close()
  545. assert.NoError(t, err)
  546. encryptedSize, err = getEncryptedFileSize(int64(len(testFileContent)))
  547. assert.NoError(t, err)
  548. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  549. assert.NoError(t, err)
  550. assert.Equal(t, 2, user.UsedQuotaFiles)
  551. assert.Equal(t, expectedSize+encryptedSize, user.UsedQuotaSize)
  552. // try to overwrite this file with a big one, this cause an overquota error
  553. // the partial file is deleted and the quota updated
  554. _, err = reader.Seek(0, io.SeekStart)
  555. assert.NoError(t, err)
  556. f, err = client.Create(testFileName)
  557. assert.NoError(t, err)
  558. _, err = io.Copy(f, reader)
  559. assert.Error(t, err)
  560. err = f.Close()
  561. assert.Error(t, err)
  562. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  563. assert.NoError(t, err)
  564. assert.Equal(t, 1, user.UsedQuotaFiles)
  565. assert.Equal(t, expectedSize, user.UsedQuotaSize)
  566. }
  567. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  568. assert.NoError(t, err)
  569. err = os.RemoveAll(user.GetHomeDir())
  570. assert.NoError(t, err)
  571. }
  572. func TestChtimesOpenHandle(t *testing.T) {
  573. localUser, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  574. assert.NoError(t, err)
  575. sftpUser, _, err := httpdtest.AddUser(getTestSFTPUser(), http.StatusCreated)
  576. assert.NoError(t, err)
  577. u := getCryptFsUser()
  578. cryptFsUser, _, err := httpdtest.AddUser(u, http.StatusCreated)
  579. assert.NoError(t, err)
  580. for _, user := range []dataprovider.User{localUser, sftpUser, cryptFsUser} {
  581. conn, client, err := getSftpClient(user)
  582. if assert.NoError(t, err) {
  583. defer conn.Close()
  584. defer client.Close()
  585. f, err := client.Create(testFileName)
  586. assert.NoError(t, err, "user %v", user.Username)
  587. f1, err := client.Create(testFileName + "1")
  588. assert.NoError(t, err, "user %v", user.Username)
  589. acmodTime := time.Now().Add(36 * time.Hour)
  590. err = client.Chtimes(testFileName, acmodTime, acmodTime)
  591. assert.NoError(t, err, "user %v", user.Username)
  592. _, err = f.Write(testFileContent)
  593. assert.NoError(t, err, "user %v", user.Username)
  594. err = f.Close()
  595. assert.NoError(t, err, "user %v", user.Username)
  596. err = f1.Close()
  597. assert.NoError(t, err, "user %v", user.Username)
  598. info, err := client.Lstat(testFileName)
  599. assert.NoError(t, err, "user %v", user.Username)
  600. diff := math.Abs(info.ModTime().Sub(acmodTime).Seconds())
  601. assert.LessOrEqual(t, diff, float64(1), "user %v", user.Username)
  602. info1, err := client.Lstat(testFileName + "1")
  603. assert.NoError(t, err, "user %v", user.Username)
  604. diff = math.Abs(info1.ModTime().Sub(acmodTime).Seconds())
  605. assert.Greater(t, diff, float64(86400), "user %v", user.Username)
  606. }
  607. }
  608. _, err = httpdtest.RemoveUser(sftpUser, http.StatusOK)
  609. assert.NoError(t, err)
  610. _, err = httpdtest.RemoveUser(localUser, http.StatusOK)
  611. assert.NoError(t, err)
  612. err = os.RemoveAll(localUser.GetHomeDir())
  613. assert.NoError(t, err)
  614. _, err = httpdtest.RemoveUser(cryptFsUser, http.StatusOK)
  615. assert.NoError(t, err)
  616. err = os.RemoveAll(cryptFsUser.GetHomeDir())
  617. assert.NoError(t, err)
  618. }
  619. func TestWaitForConnections(t *testing.T) {
  620. u := getTestUser()
  621. u.UploadBandwidth = 128
  622. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  623. assert.NoError(t, err)
  624. testFileSize := int64(524288)
  625. conn, client, err := getSftpClient(user)
  626. if assert.NoError(t, err) {
  627. defer conn.Close()
  628. defer client.Close()
  629. err = common.CheckClosing()
  630. assert.NoError(t, err)
  631. var wg sync.WaitGroup
  632. wg.Add(1)
  633. go func() {
  634. defer wg.Done()
  635. time.Sleep(1 * time.Second)
  636. common.WaitForTransfers(10)
  637. common.WaitForTransfers(0)
  638. common.WaitForTransfers(10)
  639. }()
  640. err = writeSFTPFileNoCheck(testFileName, testFileSize, client)
  641. assert.NoError(t, err)
  642. wg.Wait()
  643. err = common.CheckClosing()
  644. assert.EqualError(t, err, common.ErrShuttingDown.Error())
  645. _, err = client.Stat(testFileName)
  646. if assert.Error(t, err) {
  647. assert.Contains(t, err.Error(), common.ErrShuttingDown.Error())
  648. }
  649. }
  650. _, _, err = getSftpClient(user)
  651. assert.Error(t, err)
  652. err = common.Initialize(common.Config, 0)
  653. assert.NoError(t, err)
  654. conn, client, err = getSftpClient(user)
  655. if assert.NoError(t, err) {
  656. defer conn.Close()
  657. defer client.Close()
  658. info, err := client.Stat(testFileName)
  659. if assert.NoError(t, err) {
  660. assert.Equal(t, testFileSize, info.Size())
  661. }
  662. err = client.Remove(testFileName)
  663. assert.NoError(t, err)
  664. var wg sync.WaitGroup
  665. wg.Add(1)
  666. go func() {
  667. defer wg.Done()
  668. time.Sleep(1 * time.Second)
  669. common.WaitForTransfers(1)
  670. }()
  671. err = writeSFTPFileNoCheck(testFileName, testFileSize, client)
  672. // we don't have an error here because the service won't really stop
  673. assert.NoError(t, err)
  674. wg.Wait()
  675. }
  676. err = common.Initialize(common.Config, 0)
  677. assert.NoError(t, err)
  678. common.WaitForTransfers(1)
  679. err = common.Initialize(common.Config, 0)
  680. assert.NoError(t, err)
  681. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  682. assert.NoError(t, err)
  683. err = os.RemoveAll(user.GetHomeDir())
  684. assert.NoError(t, err)
  685. }
  686. func TestCheckParentDirs(t *testing.T) {
  687. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  688. assert.NoError(t, err)
  689. testDir := "/path/to/sub/dir"
  690. conn, client, err := getSftpClient(user)
  691. if assert.NoError(t, err) {
  692. defer conn.Close()
  693. defer client.Close()
  694. _, err = client.Stat(testDir)
  695. assert.ErrorIs(t, err, os.ErrNotExist)
  696. c := common.NewBaseConnection(xid.New().String(), common.ProtocolSFTP, "", "", user)
  697. err = c.CheckParentDirs(testDir)
  698. assert.NoError(t, err)
  699. _, err = client.Stat(testDir)
  700. assert.NoError(t, err)
  701. err = c.CheckParentDirs(testDir)
  702. assert.NoError(t, err)
  703. }
  704. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  705. assert.NoError(t, err)
  706. err = os.RemoveAll(user.GetHomeDir())
  707. assert.NoError(t, err)
  708. u := getTestUser()
  709. u.Permissions["/"] = []string{dataprovider.PermUpload, dataprovider.PermListItems, dataprovider.PermDownload}
  710. user, _, err = httpdtest.AddUser(u, http.StatusCreated)
  711. assert.NoError(t, err)
  712. conn, client, err = getSftpClient(user)
  713. if assert.NoError(t, err) {
  714. defer conn.Close()
  715. defer client.Close()
  716. c := common.NewBaseConnection(xid.New().String(), common.ProtocolSFTP, "", "", user)
  717. err = c.CheckParentDirs(testDir)
  718. assert.ErrorIs(t, err, sftp.ErrSSHFxPermissionDenied)
  719. }
  720. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  721. assert.NoError(t, err)
  722. err = os.RemoveAll(user.GetHomeDir())
  723. assert.NoError(t, err)
  724. }
  725. func TestPermissionErrors(t *testing.T) {
  726. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  727. assert.NoError(t, err)
  728. u := getTestSFTPUser()
  729. subDir := "/sub"
  730. u.Permissions[subDir] = nil
  731. sftpUser, _, err := httpdtest.AddUser(u, http.StatusCreated)
  732. assert.NoError(t, err)
  733. conn, client, err := getSftpClient(user)
  734. if assert.NoError(t, err) {
  735. defer conn.Close()
  736. defer client.Close()
  737. err = client.MkdirAll(path.Join(subDir, subDir))
  738. assert.NoError(t, err)
  739. f, err := client.Create(path.Join(subDir, subDir, testFileName))
  740. if assert.NoError(t, err) {
  741. _, err = f.Write(testFileContent)
  742. assert.NoError(t, err)
  743. err = f.Close()
  744. assert.NoError(t, err)
  745. }
  746. }
  747. conn, client, err = getSftpClient(sftpUser)
  748. if assert.NoError(t, err) {
  749. defer conn.Close()
  750. defer client.Close()
  751. assert.NoError(t, checkBasicSFTP(client))
  752. _, err = client.ReadDir(subDir)
  753. assert.ErrorIs(t, err, os.ErrPermission)
  754. err = client.Mkdir(path.Join(subDir, subDir))
  755. assert.ErrorIs(t, err, os.ErrPermission)
  756. err = client.RemoveDirectory(path.Join(subDir, subDir))
  757. assert.ErrorIs(t, err, os.ErrPermission)
  758. err = client.Symlink("test", path.Join(subDir, subDir))
  759. assert.ErrorIs(t, err, os.ErrPermission)
  760. err = client.Chmod(path.Join(subDir, subDir), os.ModePerm)
  761. assert.ErrorIs(t, err, os.ErrPermission)
  762. err = client.Chown(path.Join(subDir, subDir), os.Getuid(), os.Getgid())
  763. assert.ErrorIs(t, err, os.ErrPermission)
  764. err = client.Chtimes(path.Join(subDir, subDir), time.Now(), time.Now())
  765. assert.ErrorIs(t, err, os.ErrPermission)
  766. err = client.Truncate(path.Join(subDir, subDir), 0)
  767. assert.ErrorIs(t, err, os.ErrPermission)
  768. err = client.Remove(path.Join(subDir, subDir, testFileName))
  769. assert.ErrorIs(t, err, os.ErrPermission)
  770. }
  771. _, err = httpdtest.RemoveUser(sftpUser, http.StatusOK)
  772. assert.NoError(t, err)
  773. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  774. assert.NoError(t, err)
  775. err = os.RemoveAll(user.GetHomeDir())
  776. assert.NoError(t, err)
  777. }
  778. func TestHiddenPatternFilter(t *testing.T) {
  779. deniedDir := "/denied_hidden"
  780. u := getTestUser()
  781. u.Filters.FilePatterns = []sdk.PatternsFilter{
  782. {
  783. Path: deniedDir,
  784. DeniedPatterns: []string{"*.txt", "beta*"},
  785. DenyPolicy: sdk.DenyPolicyHide,
  786. },
  787. }
  788. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  789. assert.NoError(t, err)
  790. dirName := "beta"
  791. subDirName := "testDir"
  792. testFile := filepath.Join(u.GetHomeDir(), deniedDir, "file.txt")
  793. testFile1 := filepath.Join(u.GetHomeDir(), deniedDir, "beta.txt")
  794. testHiddenFile := filepath.Join(u.GetHomeDir(), deniedDir, dirName, subDirName, "hidden.jpg")
  795. err = os.MkdirAll(filepath.Join(u.GetHomeDir(), deniedDir), os.ModePerm)
  796. assert.NoError(t, err)
  797. err = os.WriteFile(testFile, testFileContent, os.ModePerm)
  798. assert.NoError(t, err)
  799. err = os.WriteFile(testFile1, testFileContent, os.ModePerm)
  800. assert.NoError(t, err)
  801. err = os.MkdirAll(filepath.Join(u.GetHomeDir(), deniedDir, dirName, subDirName), os.ModePerm)
  802. assert.NoError(t, err)
  803. err = os.WriteFile(testHiddenFile, testFileContent, os.ModePerm)
  804. assert.NoError(t, err)
  805. conn, client, err := getSftpClient(user)
  806. if assert.NoError(t, err) {
  807. defer conn.Close()
  808. defer client.Close()
  809. files, err := client.ReadDir(deniedDir)
  810. assert.NoError(t, err)
  811. assert.Len(t, files, 0)
  812. err = client.Remove(path.Join(deniedDir, filepath.Base(testFile)))
  813. assert.ErrorIs(t, err, os.ErrNotExist)
  814. err = client.Chtimes(path.Join(deniedDir, filepath.Base(testFile)), time.Now(), time.Now())
  815. assert.ErrorIs(t, err, os.ErrNotExist)
  816. _, err = client.Stat(path.Join(deniedDir, filepath.Base(testFile1)))
  817. assert.ErrorIs(t, err, os.ErrNotExist)
  818. err = client.RemoveDirectory(path.Join(deniedDir, dirName))
  819. assert.ErrorIs(t, err, os.ErrNotExist)
  820. err = client.Rename(path.Join(deniedDir, dirName), path.Join(deniedDir, "newname"))
  821. assert.ErrorIs(t, err, os.ErrPermission)
  822. err = client.Mkdir(path.Join(deniedDir, "beta1"))
  823. assert.ErrorIs(t, err, os.ErrPermission)
  824. err = writeSFTPFile(path.Join(deniedDir, "afile.txt"), 1024, client)
  825. assert.ErrorIs(t, err, os.ErrPermission)
  826. err = writeSFTPFile(path.Join(deniedDir, dirName, subDirName, "afile.jpg"), 1024, client)
  827. assert.ErrorIs(t, err, os.ErrPermission)
  828. _, err = client.Open(path.Join(deniedDir, dirName, subDirName, filepath.Base(testHiddenFile)))
  829. assert.ErrorIs(t, err, os.ErrNotExist)
  830. err = client.Symlink(path.Join(deniedDir, dirName), dirName)
  831. assert.ErrorIs(t, err, os.ErrNotExist)
  832. err = writeSFTPFile(path.Join(deniedDir, testFileName), 1024, client)
  833. assert.NoError(t, err)
  834. err = client.Symlink(path.Join(deniedDir, testFileName), path.Join(deniedDir, "symlink.txt"))
  835. assert.ErrorIs(t, err, os.ErrPermission)
  836. files, err = client.ReadDir(deniedDir)
  837. assert.NoError(t, err)
  838. assert.Len(t, files, 1)
  839. }
  840. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  841. assert.NoError(t, err)
  842. u.Filters.FilePatterns = []sdk.PatternsFilter{
  843. {
  844. Path: deniedDir,
  845. DeniedPatterns: []string{"*.txt", "beta*"},
  846. DenyPolicy: sdk.DenyPolicyDefault,
  847. },
  848. }
  849. user, _, err = httpdtest.AddUser(u, http.StatusCreated)
  850. assert.NoError(t, err)
  851. conn, client, err = getSftpClient(user)
  852. if assert.NoError(t, err) {
  853. defer conn.Close()
  854. defer client.Close()
  855. files, err := client.ReadDir(deniedDir)
  856. assert.NoError(t, err)
  857. assert.Len(t, files, 4)
  858. _, err = client.Stat(path.Join(deniedDir, filepath.Base(testFile)))
  859. assert.NoError(t, err)
  860. err = client.Chtimes(path.Join(deniedDir, filepath.Base(testFile)), time.Now(), time.Now())
  861. assert.ErrorIs(t, err, os.ErrPermission)
  862. err = client.Mkdir(path.Join(deniedDir, "beta2"))
  863. assert.ErrorIs(t, err, os.ErrPermission)
  864. err = writeSFTPFile(path.Join(deniedDir, "afile2.txt"), 1024, client)
  865. assert.ErrorIs(t, err, os.ErrPermission)
  866. err = client.Symlink(path.Join(deniedDir, testFileName), path.Join(deniedDir, "link.txt"))
  867. assert.ErrorIs(t, err, os.ErrPermission)
  868. err = writeSFTPFile(path.Join(deniedDir, dirName, subDirName, "afile.jpg"), 1024, client)
  869. assert.NoError(t, err)
  870. f, err := client.Open(path.Join(deniedDir, dirName, subDirName, filepath.Base(testHiddenFile)))
  871. assert.NoError(t, err)
  872. err = f.Close()
  873. assert.NoError(t, err)
  874. }
  875. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  876. assert.NoError(t, err)
  877. err = os.RemoveAll(user.GetHomeDir())
  878. assert.NoError(t, err)
  879. }
  880. func TestHiddenRoot(t *testing.T) {
  881. // only the "/ftp" directory is allowed and visibile in the "/" path
  882. // within /ftp any file/directory is allowed and visibile
  883. u := getTestUser()
  884. u.Filters.FilePatterns = []sdk.PatternsFilter{
  885. {
  886. Path: "/",
  887. AllowedPatterns: []string{"ftp"},
  888. DenyPolicy: sdk.DenyPolicyHide,
  889. },
  890. {
  891. Path: "/ftp",
  892. AllowedPatterns: []string{"*"},
  893. },
  894. }
  895. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  896. assert.NoError(t, err)
  897. for i := 0; i < 10; i++ {
  898. err = os.MkdirAll(filepath.Join(user.HomeDir, fmt.Sprintf("ftp%d", i)), os.ModePerm)
  899. assert.NoError(t, err)
  900. }
  901. err = os.WriteFile(filepath.Join(user.HomeDir, testFileName), []byte(""), 0666)
  902. assert.NoError(t, err)
  903. err = os.WriteFile(filepath.Join(user.HomeDir, "ftp.txt"), []byte(""), 0666)
  904. assert.NoError(t, err)
  905. conn, client, err := getSftpClient(user)
  906. if assert.NoError(t, err) {
  907. defer conn.Close()
  908. defer client.Close()
  909. err = client.Mkdir("ftp")
  910. assert.NoError(t, err)
  911. entries, err := client.ReadDir("/")
  912. assert.NoError(t, err)
  913. if assert.Len(t, entries, 1) {
  914. assert.Equal(t, "ftp", entries[0].Name())
  915. }
  916. _, err = client.Stat(".")
  917. assert.NoError(t, err)
  918. for _, name := range []string{testFileName, "ftp.txt"} {
  919. _, err = client.Stat(name)
  920. assert.ErrorIs(t, err, os.ErrNotExist)
  921. }
  922. for i := 0; i < 10; i++ {
  923. _, err = client.Stat(fmt.Sprintf("ftp%d", i))
  924. assert.ErrorIs(t, err, os.ErrNotExist)
  925. }
  926. err = writeSFTPFile(testFileName, 4096, client)
  927. assert.ErrorIs(t, err, os.ErrPermission)
  928. err = writeSFTPFile("ftp123", 4096, client)
  929. assert.ErrorIs(t, err, os.ErrPermission)
  930. err = client.Rename(testFileName, testFileName+"_rename") //nolint:goconst
  931. assert.ErrorIs(t, err, os.ErrPermission)
  932. err = writeSFTPFile(path.Join("/ftp", testFileName), 4096, client)
  933. assert.NoError(t, err)
  934. err = client.Mkdir("/ftp/dir")
  935. assert.NoError(t, err)
  936. err = client.Rename(path.Join("/ftp", testFileName), path.Join("/ftp/dir", testFileName))
  937. assert.NoError(t, err)
  938. }
  939. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  940. assert.NoError(t, err)
  941. err = os.RemoveAll(user.GetHomeDir())
  942. assert.NoError(t, err)
  943. }
  944. func TestFileNotAllowedErrors(t *testing.T) {
  945. deniedDir := "/denied"
  946. u := getTestUser()
  947. u.Filters.FilePatterns = []sdk.PatternsFilter{
  948. {
  949. Path: deniedDir,
  950. DeniedPatterns: []string{"*.txt"},
  951. },
  952. }
  953. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  954. assert.NoError(t, err)
  955. conn, client, err := getSftpClient(user)
  956. if assert.NoError(t, err) {
  957. defer conn.Close()
  958. defer client.Close()
  959. testFile := filepath.Join(u.GetHomeDir(), deniedDir, "file.txt")
  960. err = os.MkdirAll(filepath.Join(u.GetHomeDir(), deniedDir), os.ModePerm)
  961. assert.NoError(t, err)
  962. err = os.WriteFile(testFile, testFileContent, os.ModePerm)
  963. assert.NoError(t, err)
  964. err = client.Remove(path.Join(deniedDir, "file.txt"))
  965. assert.ErrorIs(t, err, os.ErrPermission)
  966. err = client.Rename(path.Join(deniedDir, "file.txt"), path.Join(deniedDir, "file1.txt"))
  967. assert.ErrorIs(t, err, os.ErrPermission)
  968. }
  969. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  970. assert.NoError(t, err)
  971. err = os.RemoveAll(user.GetHomeDir())
  972. assert.NoError(t, err)
  973. }
  974. func TestRootDirVirtualFolder(t *testing.T) {
  975. mappedPath1 := filepath.Join(os.TempDir(), "mapped1")
  976. f1 := vfs.BaseVirtualFolder{
  977. Name: filepath.Base(mappedPath1),
  978. MappedPath: mappedPath1,
  979. FsConfig: vfs.Filesystem{
  980. Provider: sdk.CryptedFilesystemProvider,
  981. CryptConfig: vfs.CryptFsConfig{
  982. Passphrase: kms.NewPlainSecret("cryptsecret"),
  983. },
  984. },
  985. }
  986. mappedPath2 := filepath.Join(os.TempDir(), "mapped2")
  987. f2 := vfs.BaseVirtualFolder{
  988. Name: filepath.Base(mappedPath2),
  989. MappedPath: mappedPath2,
  990. }
  991. folder1, _, err := httpdtest.AddFolder(f1, http.StatusCreated)
  992. assert.NoError(t, err)
  993. folder2, _, err := httpdtest.AddFolder(f2, http.StatusCreated)
  994. assert.NoError(t, err)
  995. u := getTestUser()
  996. u.QuotaFiles = 1000
  997. u.UploadDataTransfer = 1000
  998. u.DownloadDataTransfer = 5000
  999. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  1000. BaseVirtualFolder: vfs.BaseVirtualFolder{
  1001. Name: folder1.Name,
  1002. },
  1003. VirtualPath: "/",
  1004. QuotaFiles: 1000,
  1005. })
  1006. vdirPath2 := "/vmapped"
  1007. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  1008. BaseVirtualFolder: vfs.BaseVirtualFolder{
  1009. Name: folder2.Name,
  1010. },
  1011. VirtualPath: vdirPath2,
  1012. QuotaFiles: -1,
  1013. QuotaSize: -1,
  1014. })
  1015. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  1016. assert.NoError(t, err)
  1017. f, err := user.GetVirtualFolderForPath("/")
  1018. assert.NoError(t, err)
  1019. assert.Equal(t, "/", f.VirtualPath)
  1020. conn, client, err := getSftpClient(user)
  1021. if assert.NoError(t, err) {
  1022. defer conn.Close()
  1023. defer client.Close()
  1024. err = checkBasicSFTP(client)
  1025. assert.NoError(t, err)
  1026. f, err := client.Create(testFileName)
  1027. if assert.NoError(t, err) {
  1028. _, err = f.Write(testFileContent)
  1029. assert.NoError(t, err)
  1030. err = f.Close()
  1031. assert.NoError(t, err)
  1032. }
  1033. assert.NoFileExists(t, filepath.Join(user.HomeDir, testFileName))
  1034. assert.FileExists(t, filepath.Join(mappedPath1, testFileName))
  1035. entries, err := client.ReadDir(".")
  1036. if assert.NoError(t, err) {
  1037. assert.Len(t, entries, 2)
  1038. }
  1039. user, _, err := httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1040. assert.NoError(t, err)
  1041. assert.Equal(t, 0, user.UsedQuotaFiles)
  1042. folder, _, err := httpdtest.GetFolderByName(folder1.Name, http.StatusOK)
  1043. assert.NoError(t, err)
  1044. assert.Equal(t, 1, folder.UsedQuotaFiles)
  1045. f, err = client.Create(path.Join(vdirPath2, testFileName))
  1046. if assert.NoError(t, err) {
  1047. _, err = f.Write(testFileContent)
  1048. assert.NoError(t, err)
  1049. err = f.Close()
  1050. assert.NoError(t, err)
  1051. }
  1052. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1053. assert.NoError(t, err)
  1054. assert.Equal(t, 1, user.UsedQuotaFiles)
  1055. folder, _, err = httpdtest.GetFolderByName(folder1.Name, http.StatusOK)
  1056. assert.NoError(t, err)
  1057. assert.Equal(t, 1, folder.UsedQuotaFiles)
  1058. err = client.Rename(testFileName, path.Join(vdirPath2, testFileName+"_rename"))
  1059. assert.Error(t, err)
  1060. err = client.Rename(path.Join(vdirPath2, testFileName), testFileName+"_rename")
  1061. assert.Error(t, err)
  1062. err = client.Rename(testFileName, testFileName+"_rename")
  1063. assert.NoError(t, err)
  1064. err = client.Rename(path.Join(vdirPath2, testFileName), path.Join(vdirPath2, testFileName+"_rename"))
  1065. assert.NoError(t, err)
  1066. }
  1067. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  1068. assert.NoError(t, err)
  1069. err = os.RemoveAll(user.GetHomeDir())
  1070. assert.NoError(t, err)
  1071. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folder1.Name}, http.StatusOK)
  1072. assert.NoError(t, err)
  1073. err = os.RemoveAll(mappedPath1)
  1074. assert.NoError(t, err)
  1075. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folder2.Name}, http.StatusOK)
  1076. assert.NoError(t, err)
  1077. err = os.RemoveAll(mappedPath2)
  1078. assert.NoError(t, err)
  1079. }
  1080. func TestTruncateQuotaLimits(t *testing.T) {
  1081. mappedPath1 := filepath.Join(os.TempDir(), "mapped1")
  1082. f1 := vfs.BaseVirtualFolder{
  1083. Name: filepath.Base(mappedPath1),
  1084. MappedPath: mappedPath1,
  1085. }
  1086. folder1, _, err := httpdtest.AddFolder(f1, http.StatusCreated)
  1087. assert.NoError(t, err)
  1088. mappedPath2 := filepath.Join(os.TempDir(), "mapped2")
  1089. f2 := vfs.BaseVirtualFolder{
  1090. Name: filepath.Base(mappedPath2),
  1091. MappedPath: mappedPath2,
  1092. }
  1093. folder2, _, err := httpdtest.AddFolder(f2, http.StatusCreated)
  1094. assert.NoError(t, err)
  1095. u := getTestUser()
  1096. u.QuotaSize = 20
  1097. u.UploadDataTransfer = 1000
  1098. u.DownloadDataTransfer = 5000
  1099. vdirPath1 := "/vmapped1"
  1100. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  1101. BaseVirtualFolder: vfs.BaseVirtualFolder{
  1102. Name: folder1.Name,
  1103. },
  1104. VirtualPath: vdirPath1,
  1105. QuotaFiles: 10,
  1106. })
  1107. vdirPath2 := "/vmapped2"
  1108. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  1109. BaseVirtualFolder: vfs.BaseVirtualFolder{
  1110. Name: folder2.Name,
  1111. },
  1112. VirtualPath: vdirPath2,
  1113. QuotaFiles: -1,
  1114. QuotaSize: -1,
  1115. })
  1116. localUser, _, err := httpdtest.AddUser(u, http.StatusCreated)
  1117. assert.NoError(t, err)
  1118. u = getTestSFTPUser()
  1119. u.QuotaSize = 20
  1120. sftpUser, _, err := httpdtest.AddUser(u, http.StatusCreated)
  1121. assert.NoError(t, err)
  1122. for _, user := range []dataprovider.User{localUser, sftpUser} {
  1123. conn, client, err := getSftpClient(user)
  1124. if assert.NoError(t, err) {
  1125. defer conn.Close()
  1126. defer client.Close()
  1127. f, err := client.OpenFile(testFileName, os.O_WRONLY|os.O_CREATE)
  1128. if assert.NoError(t, err) {
  1129. n, err := f.Write(testFileContent)
  1130. assert.NoError(t, err)
  1131. assert.Equal(t, len(testFileContent), n)
  1132. err = f.Truncate(2)
  1133. assert.NoError(t, err)
  1134. expectedQuotaFiles := 0
  1135. expectedQuotaSize := int64(2)
  1136. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1137. assert.NoError(t, err)
  1138. assert.Equal(t, expectedQuotaFiles, user.UsedQuotaFiles)
  1139. assert.Equal(t, expectedQuotaSize, user.UsedQuotaSize)
  1140. _, err = f.Seek(expectedQuotaSize, io.SeekStart)
  1141. assert.NoError(t, err)
  1142. n, err = f.Write(testFileContent)
  1143. assert.NoError(t, err)
  1144. assert.Equal(t, len(testFileContent), n)
  1145. err = f.Truncate(5)
  1146. assert.NoError(t, err)
  1147. expectedQuotaSize = int64(5)
  1148. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1149. assert.NoError(t, err)
  1150. assert.Equal(t, expectedQuotaFiles, user.UsedQuotaFiles)
  1151. assert.Equal(t, expectedQuotaSize, user.UsedQuotaSize)
  1152. _, err = f.Seek(expectedQuotaSize, io.SeekStart)
  1153. assert.NoError(t, err)
  1154. n, err = f.Write(testFileContent)
  1155. assert.NoError(t, err)
  1156. assert.Equal(t, len(testFileContent), n)
  1157. err = f.Close()
  1158. assert.NoError(t, err)
  1159. expectedQuotaFiles = 1
  1160. expectedQuotaSize = int64(5) + int64(len(testFileContent))
  1161. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1162. assert.NoError(t, err)
  1163. assert.Equal(t, expectedQuotaFiles, user.UsedQuotaFiles)
  1164. assert.Equal(t, expectedQuotaSize, user.UsedQuotaSize)
  1165. }
  1166. // now truncate by path
  1167. err = client.Truncate(testFileName, 5)
  1168. assert.NoError(t, err)
  1169. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1170. assert.NoError(t, err)
  1171. assert.Equal(t, 1, user.UsedQuotaFiles)
  1172. assert.Equal(t, int64(5), user.UsedQuotaSize)
  1173. // now open an existing file without truncate it, quota should not change
  1174. f, err = client.OpenFile(testFileName, os.O_WRONLY)
  1175. if assert.NoError(t, err) {
  1176. err = f.Close()
  1177. assert.NoError(t, err)
  1178. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1179. assert.NoError(t, err)
  1180. assert.Equal(t, 1, user.UsedQuotaFiles)
  1181. assert.Equal(t, int64(5), user.UsedQuotaSize)
  1182. }
  1183. // open the file truncating it
  1184. f, err = client.OpenFile(testFileName, os.O_WRONLY|os.O_TRUNC)
  1185. if assert.NoError(t, err) {
  1186. err = f.Close()
  1187. assert.NoError(t, err)
  1188. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1189. assert.NoError(t, err)
  1190. assert.Equal(t, 1, user.UsedQuotaFiles)
  1191. assert.Equal(t, int64(0), user.UsedQuotaSize)
  1192. }
  1193. // now test max write size
  1194. f, err = client.OpenFile(testFileName, os.O_WRONLY)
  1195. if assert.NoError(t, err) {
  1196. n, err := f.Write(testFileContent)
  1197. assert.NoError(t, err)
  1198. assert.Equal(t, len(testFileContent), n)
  1199. err = f.Truncate(11)
  1200. assert.NoError(t, err)
  1201. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1202. assert.NoError(t, err)
  1203. assert.Equal(t, 1, user.UsedQuotaFiles)
  1204. assert.Equal(t, int64(11), user.UsedQuotaSize)
  1205. _, err = f.Seek(int64(11), io.SeekStart)
  1206. assert.NoError(t, err)
  1207. n, err = f.Write(testFileContent)
  1208. assert.NoError(t, err)
  1209. assert.Equal(t, len(testFileContent), n)
  1210. err = f.Truncate(5)
  1211. assert.NoError(t, err)
  1212. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1213. assert.NoError(t, err)
  1214. assert.Equal(t, 1, user.UsedQuotaFiles)
  1215. assert.Equal(t, int64(5), user.UsedQuotaSize)
  1216. _, err = f.Seek(int64(5), io.SeekStart)
  1217. assert.NoError(t, err)
  1218. n, err = f.Write(testFileContent)
  1219. assert.NoError(t, err)
  1220. assert.Equal(t, len(testFileContent), n)
  1221. err = f.Truncate(12)
  1222. assert.NoError(t, err)
  1223. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1224. assert.NoError(t, err)
  1225. assert.Equal(t, 1, user.UsedQuotaFiles)
  1226. assert.Equal(t, int64(12), user.UsedQuotaSize)
  1227. _, err = f.Seek(int64(12), io.SeekStart)
  1228. assert.NoError(t, err)
  1229. _, err = f.Write(testFileContent)
  1230. if assert.Error(t, err) {
  1231. assert.Contains(t, err.Error(), common.ErrQuotaExceeded.Error())
  1232. }
  1233. err = f.Close()
  1234. assert.Error(t, err)
  1235. // the file is deleted
  1236. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1237. assert.NoError(t, err)
  1238. assert.Equal(t, 0, user.UsedQuotaFiles)
  1239. assert.Equal(t, int64(0), user.UsedQuotaSize)
  1240. }
  1241. if user.Username == defaultUsername {
  1242. // basic test inside a virtual folder
  1243. vfileName1 := path.Join(vdirPath1, testFileName)
  1244. f, err = client.OpenFile(vfileName1, os.O_WRONLY|os.O_CREATE)
  1245. if assert.NoError(t, err) {
  1246. n, err := f.Write(testFileContent)
  1247. assert.NoError(t, err)
  1248. assert.Equal(t, len(testFileContent), n)
  1249. err = f.Truncate(2)
  1250. assert.NoError(t, err)
  1251. expectedQuotaFiles := 0
  1252. expectedQuotaSize := int64(2)
  1253. fold, _, err := httpdtest.GetFolderByName(folder1.Name, http.StatusOK)
  1254. assert.NoError(t, err)
  1255. assert.Equal(t, expectedQuotaSize, fold.UsedQuotaSize)
  1256. assert.Equal(t, expectedQuotaFiles, fold.UsedQuotaFiles)
  1257. err = f.Close()
  1258. assert.NoError(t, err)
  1259. expectedQuotaFiles = 1
  1260. fold, _, err = httpdtest.GetFolderByName(folder1.Name, http.StatusOK)
  1261. assert.NoError(t, err)
  1262. assert.Equal(t, expectedQuotaSize, fold.UsedQuotaSize)
  1263. assert.Equal(t, expectedQuotaFiles, fold.UsedQuotaFiles)
  1264. }
  1265. err = client.Truncate(vfileName1, 1)
  1266. assert.NoError(t, err)
  1267. fold, _, err := httpdtest.GetFolderByName(folder1.Name, http.StatusOK)
  1268. assert.NoError(t, err)
  1269. assert.Equal(t, int64(1), fold.UsedQuotaSize)
  1270. assert.Equal(t, 1, fold.UsedQuotaFiles)
  1271. // now test on vdirPath2, the folder quota is included in the user's quota
  1272. vfileName2 := path.Join(vdirPath2, testFileName)
  1273. f, err = client.OpenFile(vfileName2, os.O_WRONLY|os.O_CREATE)
  1274. if assert.NoError(t, err) {
  1275. n, err := f.Write(testFileContent)
  1276. assert.NoError(t, err)
  1277. assert.Equal(t, len(testFileContent), n)
  1278. err = f.Truncate(3)
  1279. assert.NoError(t, err)
  1280. expectedQuotaFiles := 0
  1281. expectedQuotaSize := int64(3)
  1282. fold, _, err := httpdtest.GetFolderByName(folder2.Name, http.StatusOK)
  1283. assert.NoError(t, err)
  1284. assert.Equal(t, expectedQuotaSize, fold.UsedQuotaSize)
  1285. assert.Equal(t, expectedQuotaFiles, fold.UsedQuotaFiles)
  1286. err = f.Close()
  1287. assert.NoError(t, err)
  1288. expectedQuotaFiles = 1
  1289. fold, _, err = httpdtest.GetFolderByName(folder2.Name, http.StatusOK)
  1290. assert.NoError(t, err)
  1291. assert.Equal(t, expectedQuotaSize, fold.UsedQuotaSize)
  1292. assert.Equal(t, expectedQuotaFiles, fold.UsedQuotaFiles)
  1293. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1294. assert.NoError(t, err)
  1295. assert.Equal(t, expectedQuotaFiles, user.UsedQuotaFiles)
  1296. assert.Equal(t, expectedQuotaSize, user.UsedQuotaSize)
  1297. }
  1298. // cleanup
  1299. err = os.RemoveAll(user.GetHomeDir())
  1300. assert.NoError(t, err)
  1301. if user.Username == defaultUsername {
  1302. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  1303. assert.NoError(t, err)
  1304. user.Password = defaultPassword
  1305. user.QuotaSize = 0
  1306. user.ID = 0
  1307. user.CreatedAt = 0
  1308. _, resp, err := httpdtest.AddUser(user, http.StatusCreated)
  1309. assert.NoError(t, err, string(resp))
  1310. }
  1311. }
  1312. }
  1313. }
  1314. _, err = httpdtest.RemoveUser(sftpUser, http.StatusOK)
  1315. assert.NoError(t, err)
  1316. _, err = httpdtest.RemoveUser(localUser, http.StatusOK)
  1317. assert.NoError(t, err)
  1318. err = os.RemoveAll(localUser.GetHomeDir())
  1319. assert.NoError(t, err)
  1320. _, err = httpdtest.RemoveFolder(folder1, http.StatusOK)
  1321. assert.NoError(t, err)
  1322. err = os.RemoveAll(mappedPath1)
  1323. assert.NoError(t, err)
  1324. _, err = httpdtest.RemoveFolder(folder2, http.StatusOK)
  1325. assert.NoError(t, err)
  1326. err = os.RemoveAll(mappedPath2)
  1327. assert.NoError(t, err)
  1328. }
  1329. func TestVirtualFoldersQuotaRenameOverwrite(t *testing.T) {
  1330. testFileSize := int64(131072)
  1331. testFileSize1 := int64(65537)
  1332. testFileName1 := "test_file1.dat" //nolint:goconst
  1333. u := getTestUser()
  1334. u.QuotaFiles = 0
  1335. u.QuotaSize = 0
  1336. mappedPath1 := filepath.Join(os.TempDir(), "vdir1")
  1337. folderName1 := filepath.Base(mappedPath1)
  1338. vdirPath1 := "/vdir1" //nolint:goconst
  1339. mappedPath2 := filepath.Join(os.TempDir(), "vdir2")
  1340. folderName2 := filepath.Base(mappedPath2)
  1341. vdirPath2 := "/vdir2" //nolint:goconst
  1342. mappedPath3 := filepath.Join(os.TempDir(), "vdir3")
  1343. folderName3 := filepath.Base(mappedPath3)
  1344. vdirPath3 := "/vdir3"
  1345. f1 := vfs.BaseVirtualFolder{
  1346. Name: folderName1,
  1347. MappedPath: mappedPath1,
  1348. }
  1349. _, _, err := httpdtest.AddFolder(f1, http.StatusCreated)
  1350. assert.NoError(t, err)
  1351. f2 := vfs.BaseVirtualFolder{
  1352. Name: folderName2,
  1353. MappedPath: mappedPath2,
  1354. }
  1355. _, _, err = httpdtest.AddFolder(f2, http.StatusCreated)
  1356. assert.NoError(t, err)
  1357. f3 := vfs.BaseVirtualFolder{
  1358. Name: folderName3,
  1359. MappedPath: mappedPath3,
  1360. }
  1361. _, _, err = httpdtest.AddFolder(f3, http.StatusCreated)
  1362. assert.NoError(t, err)
  1363. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  1364. BaseVirtualFolder: vfs.BaseVirtualFolder{
  1365. Name: folderName1,
  1366. },
  1367. VirtualPath: vdirPath1,
  1368. QuotaFiles: 2,
  1369. QuotaSize: 0,
  1370. })
  1371. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  1372. BaseVirtualFolder: vfs.BaseVirtualFolder{
  1373. Name: folderName2,
  1374. },
  1375. VirtualPath: vdirPath2,
  1376. QuotaFiles: 0,
  1377. QuotaSize: testFileSize + testFileSize1 + 1,
  1378. })
  1379. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  1380. BaseVirtualFolder: vfs.BaseVirtualFolder{
  1381. Name: folderName3,
  1382. },
  1383. VirtualPath: vdirPath3,
  1384. QuotaFiles: 2,
  1385. QuotaSize: testFileSize * 2,
  1386. })
  1387. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  1388. assert.NoError(t, err)
  1389. conn, client, err := getSftpClient(user)
  1390. if assert.NoError(t, err) {
  1391. defer conn.Close()
  1392. defer client.Close()
  1393. err = writeSFTPFile(path.Join(vdirPath1, testFileName), testFileSize, client)
  1394. assert.NoError(t, err)
  1395. f, err := client.Open(path.Join(vdirPath1, testFileName))
  1396. assert.NoError(t, err)
  1397. contents, err := io.ReadAll(f)
  1398. assert.NoError(t, err)
  1399. err = f.Close()
  1400. assert.NoError(t, err)
  1401. assert.Len(t, contents, int(testFileSize))
  1402. err = writeSFTPFile(path.Join(vdirPath2, testFileName), testFileSize, client)
  1403. assert.NoError(t, err)
  1404. err = writeSFTPFile(path.Join(vdirPath1, testFileName1), testFileSize1, client)
  1405. assert.NoError(t, err)
  1406. err = writeSFTPFile(path.Join(vdirPath2, testFileName1), testFileSize1, client)
  1407. assert.NoError(t, err)
  1408. err = writeSFTPFile(testFileName, testFileSize, client)
  1409. assert.NoError(t, err)
  1410. err = writeSFTPFile(testFileName1, testFileSize1, client)
  1411. assert.NoError(t, err)
  1412. err = writeSFTPFile(path.Join(vdirPath3, testFileName), testFileSize, client)
  1413. assert.NoError(t, err)
  1414. err = writeSFTPFile(path.Join(vdirPath3, testFileName+"1"), testFileSize, client)
  1415. assert.NoError(t, err)
  1416. err = client.Rename(testFileName, path.Join(vdirPath1, testFileName+".rename")) //nolint:goconst
  1417. assert.Error(t, err)
  1418. // we overwrite an existing file and we have unlimited size
  1419. err = client.Rename(testFileName, path.Join(vdirPath1, testFileName))
  1420. assert.NoError(t, err)
  1421. // we have no space and we try to overwrite a bigger file with a smaller one, this should succeed
  1422. err = client.Rename(testFileName1, path.Join(vdirPath2, testFileName))
  1423. assert.NoError(t, err)
  1424. err = writeSFTPFile(path.Join(vdirPath2, testFileName), testFileSize, client)
  1425. assert.NoError(t, err)
  1426. err = writeSFTPFile(testFileName, testFileSize, client)
  1427. assert.NoError(t, err)
  1428. // we have no space and we try to overwrite a smaller file with a bigger one, this should fail
  1429. err = client.Rename(testFileName, path.Join(vdirPath2, testFileName1))
  1430. assert.Error(t, err)
  1431. fi, err := client.Stat(path.Join(vdirPath1, testFileName1))
  1432. if assert.NoError(t, err) {
  1433. assert.Equal(t, testFileSize1, fi.Size())
  1434. }
  1435. // we are overquota inside vdir3 size 2/2 and size 262144/262144
  1436. err = client.Rename(path.Join(vdirPath1, testFileName1), path.Join(vdirPath3, testFileName1+".rename"))
  1437. assert.Error(t, err)
  1438. // we overwrite an existing file and we have enough size
  1439. err = client.Rename(path.Join(vdirPath1, testFileName1), path.Join(vdirPath3, testFileName))
  1440. assert.NoError(t, err)
  1441. testFileName2 := "test_file2.dat"
  1442. err = writeSFTPFile(testFileName2, testFileSize+testFileSize1, client)
  1443. assert.NoError(t, err)
  1444. // we overwrite an existing file and we haven't enough size
  1445. err = client.Rename(testFileName2, path.Join(vdirPath3, testFileName))
  1446. assert.Error(t, err)
  1447. // now remove a file from vdir3, create a dir with 2 files and try to rename it in vdir3
  1448. // this will fail since the rename will result in 3 files inside vdir3 and quota limits only
  1449. // allow 2 total files there
  1450. err = client.Remove(path.Join(vdirPath3, testFileName+"1"))
  1451. assert.NoError(t, err)
  1452. aDir := "a dir"
  1453. err = client.Mkdir(aDir)
  1454. assert.NoError(t, err)
  1455. err = writeSFTPFile(path.Join(aDir, testFileName1), testFileSize1, client)
  1456. assert.NoError(t, err)
  1457. err = writeSFTPFile(path.Join(aDir, testFileName1+"1"), testFileSize1, client)
  1458. assert.NoError(t, err)
  1459. err = client.Rename(aDir, path.Join(vdirPath3, aDir))
  1460. assert.Error(t, err)
  1461. }
  1462. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  1463. assert.NoError(t, err)
  1464. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName1}, http.StatusOK)
  1465. assert.NoError(t, err)
  1466. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName2}, http.StatusOK)
  1467. assert.NoError(t, err)
  1468. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName3}, http.StatusOK)
  1469. assert.NoError(t, err)
  1470. err = os.RemoveAll(user.GetHomeDir())
  1471. assert.NoError(t, err)
  1472. err = os.RemoveAll(mappedPath1)
  1473. assert.NoError(t, err)
  1474. err = os.RemoveAll(mappedPath2)
  1475. assert.NoError(t, err)
  1476. err = os.RemoveAll(mappedPath3)
  1477. assert.NoError(t, err)
  1478. }
  1479. func TestQuotaRenameOverwrite(t *testing.T) {
  1480. u := getTestUser()
  1481. u.QuotaFiles = 100
  1482. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  1483. assert.NoError(t, err)
  1484. conn, client, err := getSftpClient(user)
  1485. if assert.NoError(t, err) {
  1486. defer conn.Close()
  1487. defer client.Close()
  1488. testFileSize := int64(131072)
  1489. testFileSize1 := int64(65537)
  1490. testFileName1 := "test_file1.dat"
  1491. err = writeSFTPFile(testFileName, testFileSize, client)
  1492. assert.NoError(t, err)
  1493. f, err := client.Open(testFileName)
  1494. assert.NoError(t, err)
  1495. contents := make([]byte, testFileSize)
  1496. n, err := io.ReadFull(f, contents)
  1497. assert.NoError(t, err)
  1498. assert.Equal(t, int(testFileSize), n)
  1499. err = f.Close()
  1500. assert.NoError(t, err)
  1501. err = writeSFTPFile(testFileName1, testFileSize1, client)
  1502. assert.NoError(t, err)
  1503. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1504. assert.NoError(t, err)
  1505. assert.Equal(t, int64(0), user.UsedDownloadDataTransfer)
  1506. assert.Equal(t, int64(0), user.UsedUploadDataTransfer)
  1507. assert.Equal(t, 2, user.UsedQuotaFiles)
  1508. assert.Equal(t, testFileSize+testFileSize1, user.UsedQuotaSize)
  1509. err = client.Rename(testFileName, testFileName1)
  1510. assert.NoError(t, err)
  1511. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1512. assert.NoError(t, err)
  1513. assert.Equal(t, int64(0), user.UsedDownloadDataTransfer)
  1514. assert.Equal(t, int64(0), user.UsedUploadDataTransfer)
  1515. assert.Equal(t, 1, user.UsedQuotaFiles)
  1516. assert.Equal(t, testFileSize, user.UsedQuotaSize)
  1517. err = client.Remove(testFileName1)
  1518. assert.NoError(t, err)
  1519. err = writeSFTPFile(testFileName, testFileSize, client)
  1520. assert.NoError(t, err)
  1521. err = writeSFTPFile(testFileName1, testFileSize1, client)
  1522. assert.NoError(t, err)
  1523. err = client.Rename(testFileName1, testFileName)
  1524. assert.NoError(t, err)
  1525. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1526. assert.NoError(t, err)
  1527. assert.Equal(t, 1, user.UsedQuotaFiles)
  1528. assert.Equal(t, testFileSize1, user.UsedQuotaSize)
  1529. }
  1530. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  1531. assert.NoError(t, err)
  1532. err = os.RemoveAll(user.GetHomeDir())
  1533. assert.NoError(t, err)
  1534. }
  1535. func TestVirtualFoldersQuotaValues(t *testing.T) {
  1536. u := getTestUser()
  1537. u.QuotaFiles = 100
  1538. mappedPath1 := filepath.Join(os.TempDir(), "vdir1")
  1539. vdirPath1 := "/vdir1"
  1540. folderName1 := filepath.Base(mappedPath1)
  1541. mappedPath2 := filepath.Join(os.TempDir(), "vdir2")
  1542. vdirPath2 := "/vdir2"
  1543. folderName2 := filepath.Base(mappedPath2)
  1544. f1 := vfs.BaseVirtualFolder{
  1545. Name: folderName1,
  1546. MappedPath: mappedPath1,
  1547. }
  1548. _, _, err := httpdtest.AddFolder(f1, http.StatusCreated)
  1549. assert.NoError(t, err)
  1550. f2 := vfs.BaseVirtualFolder{
  1551. Name: folderName2,
  1552. MappedPath: mappedPath2,
  1553. }
  1554. _, _, err = httpdtest.AddFolder(f2, http.StatusCreated)
  1555. assert.NoError(t, err)
  1556. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  1557. BaseVirtualFolder: vfs.BaseVirtualFolder{
  1558. Name: folderName1,
  1559. },
  1560. VirtualPath: vdirPath1,
  1561. // quota is included in the user's one
  1562. QuotaFiles: -1,
  1563. QuotaSize: -1,
  1564. })
  1565. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  1566. BaseVirtualFolder: vfs.BaseVirtualFolder{
  1567. Name: folderName2,
  1568. },
  1569. VirtualPath: vdirPath2,
  1570. // quota is unlimited and excluded from user's one
  1571. QuotaFiles: 0,
  1572. QuotaSize: 0,
  1573. })
  1574. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  1575. assert.NoError(t, err)
  1576. conn, client, err := getSftpClient(user)
  1577. if assert.NoError(t, err) {
  1578. defer conn.Close()
  1579. defer client.Close()
  1580. testFileSize := int64(131072)
  1581. err = writeSFTPFile(testFileName, testFileSize, client)
  1582. assert.NoError(t, err)
  1583. // we copy the same file two times to test quota update on file overwrite
  1584. err = writeSFTPFile(path.Join(vdirPath1, testFileName), testFileSize, client)
  1585. assert.NoError(t, err)
  1586. err = writeSFTPFile(path.Join(vdirPath1, testFileName), testFileSize, client)
  1587. assert.NoError(t, err)
  1588. err = writeSFTPFile(path.Join(vdirPath2, testFileName), testFileSize, client)
  1589. assert.NoError(t, err)
  1590. err = writeSFTPFile(path.Join(vdirPath2, testFileName), testFileSize, client)
  1591. assert.NoError(t, err)
  1592. expectedQuotaFiles := 2
  1593. expectedQuotaSize := testFileSize * 2
  1594. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1595. assert.NoError(t, err)
  1596. assert.Equal(t, expectedQuotaFiles, user.UsedQuotaFiles)
  1597. assert.Equal(t, expectedQuotaSize, user.UsedQuotaSize)
  1598. f, _, err := httpdtest.GetFolderByName(folderName1, http.StatusOK)
  1599. assert.NoError(t, err)
  1600. assert.Equal(t, testFileSize, f.UsedQuotaSize)
  1601. assert.Equal(t, 1, f.UsedQuotaFiles)
  1602. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  1603. assert.NoError(t, err)
  1604. assert.Equal(t, testFileSize, f.UsedQuotaSize)
  1605. assert.Equal(t, 1, f.UsedQuotaFiles)
  1606. err = client.Remove(path.Join(vdirPath1, testFileName))
  1607. assert.NoError(t, err)
  1608. err = client.Remove(path.Join(vdirPath2, testFileName))
  1609. assert.NoError(t, err)
  1610. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  1611. assert.NoError(t, err)
  1612. assert.Equal(t, int64(0), f.UsedQuotaSize)
  1613. assert.Equal(t, 0, f.UsedQuotaFiles)
  1614. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  1615. assert.NoError(t, err)
  1616. assert.Equal(t, int64(0), f.UsedQuotaSize)
  1617. assert.Equal(t, 0, f.UsedQuotaFiles)
  1618. }
  1619. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  1620. assert.NoError(t, err)
  1621. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName1}, http.StatusOK)
  1622. assert.NoError(t, err)
  1623. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName2}, http.StatusOK)
  1624. assert.NoError(t, err)
  1625. err = os.RemoveAll(user.GetHomeDir())
  1626. assert.NoError(t, err)
  1627. err = os.RemoveAll(mappedPath1)
  1628. assert.NoError(t, err)
  1629. err = os.RemoveAll(mappedPath2)
  1630. assert.NoError(t, err)
  1631. }
  1632. func TestQuotaRenameInsideSameVirtualFolder(t *testing.T) {
  1633. u := getTestUser()
  1634. u.QuotaFiles = 100
  1635. mappedPath1 := filepath.Join(os.TempDir(), "vdir1")
  1636. vdirPath1 := "/vdir1"
  1637. folderName1 := filepath.Base(mappedPath1)
  1638. mappedPath2 := filepath.Join(os.TempDir(), "vdir2")
  1639. vdirPath2 := "/vdir2"
  1640. folderName2 := filepath.Base(mappedPath2)
  1641. f1 := vfs.BaseVirtualFolder{
  1642. Name: folderName1,
  1643. MappedPath: mappedPath1,
  1644. }
  1645. _, _, err := httpdtest.AddFolder(f1, http.StatusCreated)
  1646. assert.NoError(t, err)
  1647. f2 := vfs.BaseVirtualFolder{
  1648. Name: folderName2,
  1649. MappedPath: mappedPath2,
  1650. }
  1651. _, _, err = httpdtest.AddFolder(f2, http.StatusCreated)
  1652. assert.NoError(t, err)
  1653. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  1654. BaseVirtualFolder: vfs.BaseVirtualFolder{
  1655. Name: folderName1,
  1656. },
  1657. VirtualPath: vdirPath1,
  1658. // quota is included in the user's one
  1659. QuotaFiles: -1,
  1660. QuotaSize: -1,
  1661. })
  1662. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  1663. BaseVirtualFolder: vfs.BaseVirtualFolder{
  1664. Name: folderName2,
  1665. },
  1666. VirtualPath: vdirPath2,
  1667. // quota is unlimited and excluded from user's one
  1668. QuotaFiles: 0,
  1669. QuotaSize: 0,
  1670. })
  1671. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  1672. assert.NoError(t, err)
  1673. conn, client, err := getSftpClient(user)
  1674. if assert.NoError(t, err) {
  1675. defer conn.Close()
  1676. defer client.Close()
  1677. testFileName1 := "test_file1.dat"
  1678. testFileSize := int64(131072)
  1679. testFileSize1 := int64(65535)
  1680. dir1 := "dir1" //nolint:goconst
  1681. dir2 := "dir2" //nolint:goconst
  1682. assert.NoError(t, err)
  1683. err = client.Mkdir(path.Join(vdirPath1, dir1))
  1684. assert.NoError(t, err)
  1685. err = client.Mkdir(path.Join(vdirPath1, dir2))
  1686. assert.NoError(t, err)
  1687. err = client.Mkdir(path.Join(vdirPath2, dir1))
  1688. assert.NoError(t, err)
  1689. err = client.Mkdir(path.Join(vdirPath2, dir2))
  1690. assert.NoError(t, err)
  1691. err = writeSFTPFile(path.Join(vdirPath1, dir1, testFileName), testFileSize, client)
  1692. assert.NoError(t, err)
  1693. err = writeSFTPFile(path.Join(vdirPath1, dir2, testFileName1), testFileSize1, client)
  1694. assert.NoError(t, err)
  1695. err = writeSFTPFile(path.Join(vdirPath2, dir1, testFileName), testFileSize, client)
  1696. assert.NoError(t, err)
  1697. err = writeSFTPFile(path.Join(vdirPath2, dir2, testFileName1), testFileSize1, client)
  1698. assert.NoError(t, err)
  1699. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1700. assert.NoError(t, err)
  1701. assert.Equal(t, 2, user.UsedQuotaFiles)
  1702. assert.Equal(t, testFileSize+testFileSize1, user.UsedQuotaSize)
  1703. f, _, err := httpdtest.GetFolderByName(folderName1, http.StatusOK)
  1704. assert.NoError(t, err)
  1705. assert.Equal(t, testFileSize+testFileSize1, f.UsedQuotaSize)
  1706. assert.Equal(t, 2, f.UsedQuotaFiles)
  1707. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  1708. assert.NoError(t, err)
  1709. assert.Equal(t, testFileSize+testFileSize1, f.UsedQuotaSize)
  1710. assert.Equal(t, 2, f.UsedQuotaFiles)
  1711. // initial files:
  1712. // - vdir1/dir1/testFileName
  1713. // - vdir1/dir2/testFileName1
  1714. // - vdir2/dir1/testFileName
  1715. // - vdir2/dir2/testFileName1
  1716. //
  1717. // rename a file inside vdir1 it is included inside user quota, so we have:
  1718. // - vdir1/dir1/testFileName.rename
  1719. // - vdir1/dir2/testFileName1
  1720. // - vdir2/dir1/testFileName
  1721. // - vdir2/dir2/testFileName1
  1722. err = client.Rename(path.Join(vdirPath1, dir1, testFileName), path.Join(vdirPath1, dir1, testFileName+".rename"))
  1723. assert.NoError(t, err)
  1724. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1725. assert.NoError(t, err)
  1726. assert.Equal(t, 2, user.UsedQuotaFiles)
  1727. assert.Equal(t, testFileSize+testFileSize1, user.UsedQuotaSize)
  1728. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  1729. assert.NoError(t, err)
  1730. assert.Equal(t, testFileSize+testFileSize1, f.UsedQuotaSize)
  1731. assert.Equal(t, 2, f.UsedQuotaFiles)
  1732. // rename a file inside vdir2, it isn't included inside user quota, so we have:
  1733. // - vdir1/dir1/testFileName.rename
  1734. // - vdir1/dir2/testFileName1
  1735. // - vdir2/dir1/testFileName.rename
  1736. // - vdir2/dir2/testFileName1
  1737. err = client.Rename(path.Join(vdirPath2, dir1, testFileName), path.Join(vdirPath2, dir1, testFileName+".rename"))
  1738. assert.NoError(t, err)
  1739. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1740. assert.NoError(t, err)
  1741. assert.Equal(t, 2, user.UsedQuotaFiles)
  1742. assert.Equal(t, testFileSize+testFileSize1, user.UsedQuotaSize)
  1743. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  1744. assert.NoError(t, err)
  1745. assert.Equal(t, testFileSize+testFileSize1, f.UsedQuotaSize)
  1746. assert.Equal(t, 2, f.UsedQuotaFiles)
  1747. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  1748. assert.NoError(t, err)
  1749. assert.Equal(t, testFileSize+testFileSize1, f.UsedQuotaSize)
  1750. assert.Equal(t, 2, f.UsedQuotaFiles)
  1751. // rename a file inside vdir2 overwriting an existing, we now have:
  1752. // - vdir1/dir1/testFileName.rename
  1753. // - vdir1/dir2/testFileName1
  1754. // - vdir2/dir1/testFileName.rename (initial testFileName1)
  1755. err = client.Rename(path.Join(vdirPath2, dir2, testFileName1), path.Join(vdirPath2, dir1, testFileName+".rename"))
  1756. assert.NoError(t, err)
  1757. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1758. assert.NoError(t, err)
  1759. assert.Equal(t, 2, user.UsedQuotaFiles)
  1760. assert.Equal(t, testFileSize+testFileSize1, user.UsedQuotaSize)
  1761. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  1762. assert.NoError(t, err)
  1763. assert.Equal(t, testFileSize1, f.UsedQuotaSize)
  1764. assert.Equal(t, 1, f.UsedQuotaFiles)
  1765. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  1766. assert.NoError(t, err)
  1767. assert.Equal(t, testFileSize+testFileSize1, f.UsedQuotaSize)
  1768. assert.Equal(t, 2, f.UsedQuotaFiles)
  1769. // rename a file inside vdir1 overwriting an existing, we now have:
  1770. // - vdir1/dir1/testFileName.rename (initial testFileName1)
  1771. // - vdir2/dir1/testFileName.rename (initial testFileName1)
  1772. err = client.Rename(path.Join(vdirPath1, dir2, testFileName1), path.Join(vdirPath1, dir1, testFileName+".rename"))
  1773. assert.NoError(t, err)
  1774. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1775. assert.NoError(t, err)
  1776. assert.Equal(t, 1, user.UsedQuotaFiles)
  1777. assert.Equal(t, testFileSize1, user.UsedQuotaSize)
  1778. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  1779. assert.NoError(t, err)
  1780. assert.Equal(t, testFileSize1, f.UsedQuotaSize)
  1781. assert.Equal(t, 1, f.UsedQuotaFiles)
  1782. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  1783. assert.NoError(t, err)
  1784. assert.Equal(t, testFileSize1, f.UsedQuotaSize)
  1785. assert.Equal(t, 1, f.UsedQuotaFiles)
  1786. // rename a directory inside the same virtual folder, quota should not change
  1787. err = client.RemoveDirectory(path.Join(vdirPath1, dir2))
  1788. assert.NoError(t, err)
  1789. err = client.RemoveDirectory(path.Join(vdirPath2, dir2))
  1790. assert.NoError(t, err)
  1791. err = client.Rename(path.Join(vdirPath1, dir1), path.Join(vdirPath1, dir2))
  1792. assert.NoError(t, err)
  1793. err = client.Rename(path.Join(vdirPath2, dir1), path.Join(vdirPath2, dir2))
  1794. assert.NoError(t, err)
  1795. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1796. assert.NoError(t, err)
  1797. assert.Equal(t, 1, user.UsedQuotaFiles)
  1798. assert.Equal(t, testFileSize1, user.UsedQuotaSize)
  1799. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  1800. assert.NoError(t, err)
  1801. assert.Equal(t, testFileSize1, f.UsedQuotaSize)
  1802. assert.Equal(t, 1, f.UsedQuotaFiles)
  1803. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  1804. assert.NoError(t, err)
  1805. assert.Equal(t, testFileSize1, f.UsedQuotaSize)
  1806. assert.Equal(t, 1, f.UsedQuotaFiles)
  1807. }
  1808. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  1809. assert.NoError(t, err)
  1810. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName1}, http.StatusOK)
  1811. assert.NoError(t, err)
  1812. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName2}, http.StatusOK)
  1813. assert.NoError(t, err)
  1814. err = os.RemoveAll(user.GetHomeDir())
  1815. assert.NoError(t, err)
  1816. err = os.RemoveAll(mappedPath1)
  1817. assert.NoError(t, err)
  1818. err = os.RemoveAll(mappedPath2)
  1819. assert.NoError(t, err)
  1820. }
  1821. func TestQuotaRenameBetweenVirtualFolder(t *testing.T) {
  1822. u := getTestUser()
  1823. u.QuotaFiles = 100
  1824. mappedPath1 := filepath.Join(os.TempDir(), "vdir1")
  1825. folderName1 := filepath.Base(mappedPath1)
  1826. vdirPath1 := "/vdir1"
  1827. mappedPath2 := filepath.Join(os.TempDir(), "vdir2")
  1828. folderName2 := filepath.Base(mappedPath2)
  1829. vdirPath2 := "/vdir2"
  1830. f1 := vfs.BaseVirtualFolder{
  1831. Name: folderName1,
  1832. MappedPath: mappedPath1,
  1833. }
  1834. _, _, err := httpdtest.AddFolder(f1, http.StatusCreated)
  1835. assert.NoError(t, err)
  1836. f2 := vfs.BaseVirtualFolder{
  1837. Name: folderName2,
  1838. MappedPath: mappedPath2,
  1839. }
  1840. _, _, err = httpdtest.AddFolder(f2, http.StatusCreated)
  1841. assert.NoError(t, err)
  1842. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  1843. BaseVirtualFolder: vfs.BaseVirtualFolder{
  1844. Name: folderName1,
  1845. },
  1846. VirtualPath: vdirPath1,
  1847. // quota is included in the user's one
  1848. QuotaFiles: -1,
  1849. QuotaSize: -1,
  1850. })
  1851. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  1852. BaseVirtualFolder: vfs.BaseVirtualFolder{
  1853. Name: folderName2,
  1854. },
  1855. VirtualPath: vdirPath2,
  1856. // quota is unlimited and excluded from user's one
  1857. QuotaFiles: 0,
  1858. QuotaSize: 0,
  1859. })
  1860. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  1861. assert.NoError(t, err)
  1862. conn, client, err := getSftpClient(user)
  1863. if assert.NoError(t, err) {
  1864. defer conn.Close()
  1865. defer client.Close()
  1866. testFileName1 := "test_file1.dat"
  1867. testFileSize := int64(131072)
  1868. testFileSize1 := int64(65535)
  1869. dir1 := "dir1"
  1870. dir2 := "dir2"
  1871. err = client.Mkdir(path.Join(vdirPath1, dir1))
  1872. assert.NoError(t, err)
  1873. err = client.Mkdir(path.Join(vdirPath1, dir2))
  1874. assert.NoError(t, err)
  1875. err = client.Mkdir(path.Join(vdirPath2, dir1))
  1876. assert.NoError(t, err)
  1877. err = client.Mkdir(path.Join(vdirPath2, dir2))
  1878. assert.NoError(t, err)
  1879. err = writeSFTPFile(path.Join(vdirPath1, dir1, testFileName), testFileSize, client)
  1880. assert.NoError(t, err)
  1881. err = writeSFTPFile(path.Join(vdirPath1, dir2, testFileName1), testFileSize1, client)
  1882. assert.NoError(t, err)
  1883. err = writeSFTPFile(path.Join(vdirPath2, dir1, testFileName), testFileSize, client)
  1884. assert.NoError(t, err)
  1885. err = writeSFTPFile(path.Join(vdirPath2, dir2, testFileName1), testFileSize1, client)
  1886. assert.NoError(t, err)
  1887. // initial files:
  1888. // - vdir1/dir1/testFileName
  1889. // - vdir1/dir2/testFileName1
  1890. // - vdir2/dir1/testFileName
  1891. // - vdir2/dir2/testFileName1
  1892. //
  1893. // rename a file from vdir1 to vdir2, vdir1 is included inside user quota, so we have:
  1894. // - vdir1/dir1/testFileName
  1895. // - vdir2/dir1/testFileName
  1896. // - vdir2/dir2/testFileName1
  1897. // - vdir2/dir1/testFileName1.rename
  1898. err = client.Rename(path.Join(vdirPath1, dir2, testFileName1), path.Join(vdirPath2, dir1, testFileName1+".rename"))
  1899. assert.NoError(t, err)
  1900. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1901. assert.NoError(t, err)
  1902. assert.Equal(t, 1, user.UsedQuotaFiles)
  1903. assert.Equal(t, testFileSize, user.UsedQuotaSize)
  1904. f, _, err := httpdtest.GetFolderByName(folderName1, http.StatusOK)
  1905. assert.NoError(t, err)
  1906. assert.Equal(t, testFileSize, f.UsedQuotaSize)
  1907. assert.Equal(t, 1, f.UsedQuotaFiles)
  1908. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  1909. assert.NoError(t, err)
  1910. assert.Equal(t, testFileSize+testFileSize1+testFileSize1, f.UsedQuotaSize)
  1911. assert.Equal(t, 3, f.UsedQuotaFiles)
  1912. // rename a file from vdir2 to vdir1, vdir2 is not included inside user quota, so we have:
  1913. // - vdir1/dir1/testFileName
  1914. // - vdir1/dir2/testFileName.rename
  1915. // - vdir2/dir2/testFileName1
  1916. // - vdir2/dir1/testFileName1.rename
  1917. err = client.Rename(path.Join(vdirPath2, dir1, testFileName), path.Join(vdirPath1, dir2, testFileName+".rename"))
  1918. assert.NoError(t, err)
  1919. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1920. assert.NoError(t, err)
  1921. assert.Equal(t, 2, user.UsedQuotaFiles)
  1922. assert.Equal(t, testFileSize*2, user.UsedQuotaSize)
  1923. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  1924. assert.NoError(t, err)
  1925. assert.Equal(t, testFileSize*2, f.UsedQuotaSize)
  1926. assert.Equal(t, 2, f.UsedQuotaFiles)
  1927. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  1928. assert.NoError(t, err)
  1929. assert.Equal(t, testFileSize1*2, f.UsedQuotaSize)
  1930. assert.Equal(t, 2, f.UsedQuotaFiles)
  1931. // rename a file from vdir1 to vdir2 overwriting an existing file, vdir1 is included inside user quota, so we have:
  1932. // - vdir1/dir2/testFileName.rename
  1933. // - vdir2/dir2/testFileName1 (is the initial testFileName)
  1934. // - vdir2/dir1/testFileName1.rename
  1935. err = client.Rename(path.Join(vdirPath1, dir1, testFileName), path.Join(vdirPath2, dir2, testFileName1))
  1936. assert.NoError(t, err)
  1937. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1938. assert.NoError(t, err)
  1939. assert.Equal(t, 1, user.UsedQuotaFiles)
  1940. assert.Equal(t, testFileSize, user.UsedQuotaSize)
  1941. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  1942. assert.NoError(t, err)
  1943. assert.Equal(t, testFileSize, f.UsedQuotaSize)
  1944. assert.Equal(t, 1, f.UsedQuotaFiles)
  1945. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  1946. assert.NoError(t, err)
  1947. assert.Equal(t, testFileSize1+testFileSize, f.UsedQuotaSize)
  1948. assert.Equal(t, 2, f.UsedQuotaFiles)
  1949. // rename a file from vdir2 to vdir1 overwriting an existing file, vdir2 is not included inside user quota, so we have:
  1950. // - vdir1/dir2/testFileName.rename (is the initial testFileName1)
  1951. // - vdir2/dir2/testFileName1 (is the initial testFileName)
  1952. err = client.Rename(path.Join(vdirPath2, dir1, testFileName1+".rename"), path.Join(vdirPath1, dir2, testFileName+".rename"))
  1953. assert.NoError(t, err)
  1954. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1955. assert.NoError(t, err)
  1956. assert.Equal(t, 1, user.UsedQuotaFiles)
  1957. assert.Equal(t, testFileSize1, user.UsedQuotaSize)
  1958. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  1959. assert.NoError(t, err)
  1960. assert.Equal(t, testFileSize1, f.UsedQuotaSize)
  1961. assert.Equal(t, 1, f.UsedQuotaFiles)
  1962. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  1963. assert.NoError(t, err)
  1964. assert.Equal(t, testFileSize, f.UsedQuotaSize)
  1965. assert.Equal(t, 1, f.UsedQuotaFiles)
  1966. err = writeSFTPFile(path.Join(vdirPath1, dir2, testFileName), testFileSize, client)
  1967. assert.NoError(t, err)
  1968. err = writeSFTPFile(path.Join(vdirPath2, dir2, testFileName), testFileSize1, client)
  1969. assert.NoError(t, err)
  1970. err = writeSFTPFile(path.Join(vdirPath2, dir2, testFileName+"1.dupl"), testFileSize1, client)
  1971. assert.NoError(t, err)
  1972. err = client.RemoveDirectory(path.Join(vdirPath1, dir1))
  1973. assert.NoError(t, err)
  1974. err = client.RemoveDirectory(path.Join(vdirPath2, dir1))
  1975. assert.NoError(t, err)
  1976. // - vdir1/dir2/testFileName.rename (initial testFileName1)
  1977. // - vdir1/dir2/testFileName
  1978. // - vdir2/dir2/testFileName1 (initial testFileName)
  1979. // - vdir2/dir2/testFileName (initial testFileName1)
  1980. // - vdir2/dir2/testFileName1.dupl
  1981. // rename directories between the two virtual folders
  1982. err = client.Rename(path.Join(vdirPath2, dir2), path.Join(vdirPath1, dir1))
  1983. assert.NoError(t, err)
  1984. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  1985. assert.NoError(t, err)
  1986. assert.Equal(t, 5, user.UsedQuotaFiles)
  1987. assert.Equal(t, testFileSize1*3+testFileSize*2, user.UsedQuotaSize)
  1988. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  1989. assert.NoError(t, err)
  1990. assert.Equal(t, testFileSize1*3+testFileSize*2, f.UsedQuotaSize)
  1991. assert.Equal(t, 5, f.UsedQuotaFiles)
  1992. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  1993. assert.NoError(t, err)
  1994. assert.Equal(t, int64(0), f.UsedQuotaSize)
  1995. assert.Equal(t, 0, f.UsedQuotaFiles)
  1996. // now move on vpath2
  1997. err = client.Rename(path.Join(vdirPath1, dir2), path.Join(vdirPath2, dir1))
  1998. assert.NoError(t, err)
  1999. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  2000. assert.NoError(t, err)
  2001. assert.Equal(t, 3, user.UsedQuotaFiles)
  2002. assert.Equal(t, testFileSize1*2+testFileSize, user.UsedQuotaSize)
  2003. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  2004. assert.NoError(t, err)
  2005. assert.Equal(t, testFileSize1*2+testFileSize, f.UsedQuotaSize)
  2006. assert.Equal(t, 3, f.UsedQuotaFiles)
  2007. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  2008. assert.NoError(t, err)
  2009. assert.Equal(t, testFileSize+testFileSize1, f.UsedQuotaSize)
  2010. assert.Equal(t, 2, f.UsedQuotaFiles)
  2011. }
  2012. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  2013. assert.NoError(t, err)
  2014. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName1}, http.StatusOK)
  2015. assert.NoError(t, err)
  2016. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName2}, http.StatusOK)
  2017. assert.NoError(t, err)
  2018. err = os.RemoveAll(user.GetHomeDir())
  2019. assert.NoError(t, err)
  2020. err = os.RemoveAll(mappedPath1)
  2021. assert.NoError(t, err)
  2022. err = os.RemoveAll(mappedPath2)
  2023. assert.NoError(t, err)
  2024. }
  2025. func TestQuotaRenameFromVirtualFolder(t *testing.T) {
  2026. u := getTestUser()
  2027. u.QuotaFiles = 100
  2028. mappedPath1 := filepath.Join(os.TempDir(), "vdir1")
  2029. folderName1 := filepath.Base(mappedPath1)
  2030. vdirPath1 := "/vdir1"
  2031. mappedPath2 := filepath.Join(os.TempDir(), "vdir2")
  2032. folderName2 := filepath.Base(mappedPath2)
  2033. vdirPath2 := "/vdir2"
  2034. f1 := vfs.BaseVirtualFolder{
  2035. Name: folderName1,
  2036. MappedPath: mappedPath1,
  2037. }
  2038. _, _, err := httpdtest.AddFolder(f1, http.StatusCreated)
  2039. assert.NoError(t, err)
  2040. f2 := vfs.BaseVirtualFolder{
  2041. Name: folderName2,
  2042. MappedPath: mappedPath2,
  2043. }
  2044. _, _, err = httpdtest.AddFolder(f2, http.StatusCreated)
  2045. assert.NoError(t, err)
  2046. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  2047. BaseVirtualFolder: vfs.BaseVirtualFolder{
  2048. Name: folderName1,
  2049. },
  2050. VirtualPath: vdirPath1,
  2051. // quota is included in the user's one
  2052. QuotaFiles: -1,
  2053. QuotaSize: -1,
  2054. })
  2055. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  2056. BaseVirtualFolder: vfs.BaseVirtualFolder{
  2057. Name: folderName2,
  2058. },
  2059. VirtualPath: vdirPath2,
  2060. // quota is unlimited and excluded from user's one
  2061. QuotaFiles: 0,
  2062. QuotaSize: 0,
  2063. })
  2064. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  2065. assert.NoError(t, err)
  2066. conn, client, err := getSftpClient(user)
  2067. if assert.NoError(t, err) {
  2068. defer conn.Close()
  2069. defer client.Close()
  2070. testFileName1 := "test_file1.dat"
  2071. testFileSize := int64(131072)
  2072. testFileSize1 := int64(65535)
  2073. dir1 := "dir1"
  2074. dir2 := "dir2"
  2075. err = client.Mkdir(path.Join(vdirPath1, dir1))
  2076. assert.NoError(t, err)
  2077. err = client.Mkdir(path.Join(vdirPath1, dir2))
  2078. assert.NoError(t, err)
  2079. err = client.Mkdir(path.Join(vdirPath2, dir1))
  2080. assert.NoError(t, err)
  2081. err = client.Mkdir(path.Join(vdirPath2, dir2))
  2082. assert.NoError(t, err)
  2083. err = writeSFTPFile(path.Join(vdirPath1, dir1, testFileName), testFileSize, client)
  2084. assert.NoError(t, err)
  2085. err = writeSFTPFile(path.Join(vdirPath1, dir2, testFileName1), testFileSize1, client)
  2086. assert.NoError(t, err)
  2087. err = writeSFTPFile(path.Join(vdirPath2, dir1, testFileName), testFileSize, client)
  2088. assert.NoError(t, err)
  2089. err = writeSFTPFile(path.Join(vdirPath2, dir2, testFileName1), testFileSize1, client)
  2090. assert.NoError(t, err)
  2091. // initial files:
  2092. // - vdir1/dir1/testFileName
  2093. // - vdir1/dir2/testFileName1
  2094. // - vdir2/dir1/testFileName
  2095. // - vdir2/dir2/testFileName1
  2096. //
  2097. // rename a file from vdir1 to the user home dir, vdir1 is included in user quota so we have:
  2098. // - testFileName
  2099. // - vdir1/dir2/testFileName1
  2100. // - vdir2/dir1/testFileName
  2101. // - vdir2/dir2/testFileName1
  2102. err = client.Rename(path.Join(vdirPath1, dir1, testFileName), path.Join(testFileName))
  2103. assert.NoError(t, err)
  2104. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  2105. assert.NoError(t, err)
  2106. assert.Equal(t, 2, user.UsedQuotaFiles)
  2107. assert.Equal(t, testFileSize+testFileSize1, user.UsedQuotaSize)
  2108. f, _, err := httpdtest.GetFolderByName(folderName1, http.StatusOK)
  2109. assert.NoError(t, err)
  2110. assert.Equal(t, testFileSize1, f.UsedQuotaSize)
  2111. assert.Equal(t, 1, f.UsedQuotaFiles)
  2112. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  2113. assert.NoError(t, err)
  2114. assert.Equal(t, testFileSize+testFileSize1, f.UsedQuotaSize)
  2115. assert.Equal(t, 2, f.UsedQuotaFiles)
  2116. // rename a file from vdir2 to the user home dir, vdir2 is not included in user quota so we have:
  2117. // - testFileName
  2118. // - testFileName1
  2119. // - vdir1/dir2/testFileName1
  2120. // - vdir2/dir1/testFileName
  2121. err = client.Rename(path.Join(vdirPath2, dir2, testFileName1), path.Join(testFileName1))
  2122. assert.NoError(t, err)
  2123. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  2124. assert.NoError(t, err)
  2125. assert.Equal(t, 3, user.UsedQuotaFiles)
  2126. assert.Equal(t, testFileSize+testFileSize1+testFileSize1, user.UsedQuotaSize)
  2127. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  2128. assert.NoError(t, err)
  2129. assert.Equal(t, testFileSize1, f.UsedQuotaSize)
  2130. assert.Equal(t, 1, f.UsedQuotaFiles)
  2131. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  2132. assert.NoError(t, err)
  2133. assert.Equal(t, testFileSize, f.UsedQuotaSize)
  2134. assert.Equal(t, 1, f.UsedQuotaFiles)
  2135. // rename a file from vdir1 to the user home dir overwriting an existing file, vdir1 is included in user quota so we have:
  2136. // - testFileName (initial testFileName1)
  2137. // - testFileName1
  2138. // - vdir2/dir1/testFileName
  2139. err = client.Rename(path.Join(vdirPath1, dir2, testFileName1), path.Join(testFileName))
  2140. assert.NoError(t, err)
  2141. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  2142. assert.NoError(t, err)
  2143. assert.Equal(t, 2, user.UsedQuotaFiles)
  2144. assert.Equal(t, testFileSize1+testFileSize1, user.UsedQuotaSize)
  2145. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  2146. assert.NoError(t, err)
  2147. assert.Equal(t, int64(0), f.UsedQuotaSize)
  2148. assert.Equal(t, 0, f.UsedQuotaFiles)
  2149. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  2150. assert.NoError(t, err)
  2151. assert.Equal(t, testFileSize, f.UsedQuotaSize)
  2152. assert.Equal(t, 1, f.UsedQuotaFiles)
  2153. // rename a file from vdir2 to the user home dir overwriting an existing file, vdir2 is not included in user quota so we have:
  2154. // - testFileName (initial testFileName1)
  2155. // - testFileName1 (initial testFileName)
  2156. err = client.Rename(path.Join(vdirPath2, dir1, testFileName), path.Join(testFileName1))
  2157. assert.NoError(t, err)
  2158. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  2159. assert.NoError(t, err)
  2160. assert.Equal(t, 2, user.UsedQuotaFiles)
  2161. assert.Equal(t, testFileSize+testFileSize1, user.UsedQuotaSize)
  2162. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  2163. assert.NoError(t, err)
  2164. assert.Equal(t, int64(0), f.UsedQuotaSize)
  2165. assert.Equal(t, 0, f.UsedQuotaFiles)
  2166. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  2167. assert.NoError(t, err)
  2168. assert.Equal(t, int64(0), f.UsedQuotaSize)
  2169. assert.Equal(t, 0, f.UsedQuotaFiles)
  2170. // dir rename
  2171. err = writeSFTPFile(path.Join(vdirPath1, dir1, testFileName), testFileSize, client)
  2172. assert.NoError(t, err)
  2173. err = writeSFTPFile(path.Join(vdirPath1, dir1, testFileName1), testFileSize1, client)
  2174. assert.NoError(t, err)
  2175. err = writeSFTPFile(path.Join(vdirPath2, dir1, testFileName), testFileSize, client)
  2176. assert.NoError(t, err)
  2177. err = writeSFTPFile(path.Join(vdirPath2, dir1, testFileName1), testFileSize1, client)
  2178. assert.NoError(t, err)
  2179. // - testFileName (initial testFileName1)
  2180. // - testFileName1 (initial testFileName)
  2181. // - vdir1/dir1/testFileName
  2182. // - vdir1/dir1/testFileName1
  2183. // - dir1/testFileName
  2184. // - dir1/testFileName1
  2185. err = client.Rename(path.Join(vdirPath2, dir1), dir1)
  2186. assert.NoError(t, err)
  2187. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  2188. assert.NoError(t, err)
  2189. assert.Equal(t, 6, user.UsedQuotaFiles)
  2190. assert.Equal(t, testFileSize*3+testFileSize1*3, user.UsedQuotaSize)
  2191. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  2192. assert.NoError(t, err)
  2193. assert.Equal(t, testFileSize+testFileSize1, f.UsedQuotaSize)
  2194. assert.Equal(t, 2, f.UsedQuotaFiles)
  2195. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  2196. assert.NoError(t, err)
  2197. assert.Equal(t, int64(0), f.UsedQuotaSize)
  2198. assert.Equal(t, 0, f.UsedQuotaFiles)
  2199. // - testFileName (initial testFileName1)
  2200. // - testFileName1 (initial testFileName)
  2201. // - dir2/testFileName
  2202. // - dir2/testFileName1
  2203. // - dir1/testFileName
  2204. // - dir1/testFileName1
  2205. err = client.Rename(path.Join(vdirPath1, dir1), dir2)
  2206. assert.NoError(t, err)
  2207. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  2208. assert.NoError(t, err)
  2209. assert.Equal(t, 6, user.UsedQuotaFiles)
  2210. assert.Equal(t, testFileSize*3+testFileSize1*3, user.UsedQuotaSize)
  2211. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  2212. assert.NoError(t, err)
  2213. assert.Equal(t, int64(0), f.UsedQuotaSize)
  2214. assert.Equal(t, 0, f.UsedQuotaFiles)
  2215. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  2216. assert.NoError(t, err)
  2217. assert.Equal(t, int64(0), f.UsedQuotaSize)
  2218. assert.Equal(t, 0, f.UsedQuotaFiles)
  2219. }
  2220. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  2221. assert.NoError(t, err)
  2222. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName1}, http.StatusOK)
  2223. assert.NoError(t, err)
  2224. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName2}, http.StatusOK)
  2225. assert.NoError(t, err)
  2226. err = os.RemoveAll(user.GetHomeDir())
  2227. assert.NoError(t, err)
  2228. err = os.RemoveAll(mappedPath1)
  2229. assert.NoError(t, err)
  2230. err = os.RemoveAll(mappedPath2)
  2231. assert.NoError(t, err)
  2232. }
  2233. func TestQuotaRenameToVirtualFolder(t *testing.T) {
  2234. u := getTestUser()
  2235. u.QuotaFiles = 100
  2236. mappedPath1 := filepath.Join(os.TempDir(), "vdir1")
  2237. folderName1 := filepath.Base(mappedPath1)
  2238. vdirPath1 := "/vdir1"
  2239. mappedPath2 := filepath.Join(os.TempDir(), "vdir2")
  2240. folderName2 := filepath.Base(mappedPath2)
  2241. vdirPath2 := "/vdir2"
  2242. f1 := vfs.BaseVirtualFolder{
  2243. Name: folderName1,
  2244. MappedPath: mappedPath1,
  2245. }
  2246. _, _, err := httpdtest.AddFolder(f1, http.StatusCreated)
  2247. assert.NoError(t, err)
  2248. f2 := vfs.BaseVirtualFolder{
  2249. Name: folderName2,
  2250. MappedPath: mappedPath2,
  2251. }
  2252. _, _, err = httpdtest.AddFolder(f2, http.StatusCreated)
  2253. assert.NoError(t, err)
  2254. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  2255. BaseVirtualFolder: vfs.BaseVirtualFolder{
  2256. Name: folderName1,
  2257. },
  2258. VirtualPath: vdirPath1,
  2259. // quota is included in the user's one
  2260. QuotaFiles: -1,
  2261. QuotaSize: -1,
  2262. })
  2263. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  2264. BaseVirtualFolder: vfs.BaseVirtualFolder{
  2265. Name: folderName2,
  2266. },
  2267. VirtualPath: vdirPath2,
  2268. // quota is unlimited and excluded from user's one
  2269. QuotaFiles: 0,
  2270. QuotaSize: 0,
  2271. })
  2272. u.Permissions[vdirPath1] = []string{dataprovider.PermListItems, dataprovider.PermDownload, dataprovider.PermUpload,
  2273. dataprovider.PermOverwrite, dataprovider.PermDelete, dataprovider.PermCreateSymlinks, dataprovider.PermCreateDirs,
  2274. dataprovider.PermRename}
  2275. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  2276. assert.NoError(t, err)
  2277. conn, client, err := getSftpClient(user)
  2278. if assert.NoError(t, err) {
  2279. defer conn.Close()
  2280. defer client.Close()
  2281. testFileName1 := "test_file1.dat"
  2282. testFileSize := int64(131072)
  2283. testFileSize1 := int64(65535)
  2284. dir1 := "dir1"
  2285. dir2 := "dir2"
  2286. err = client.Mkdir(path.Join(vdirPath1, dir1))
  2287. assert.NoError(t, err)
  2288. err = client.Mkdir(path.Join(vdirPath1, dir2))
  2289. assert.NoError(t, err)
  2290. err = client.Mkdir(path.Join(vdirPath2, dir1))
  2291. assert.NoError(t, err)
  2292. err = client.Mkdir(path.Join(vdirPath2, dir2))
  2293. assert.NoError(t, err)
  2294. err = writeSFTPFile(testFileName, testFileSize, client)
  2295. assert.NoError(t, err)
  2296. err = writeSFTPFile(testFileName1, testFileSize1, client)
  2297. assert.NoError(t, err)
  2298. // initial files:
  2299. // - testFileName
  2300. // - testFileName1
  2301. //
  2302. // rename a file from user home dir to vdir1, vdir1 is included in user quota so we have:
  2303. // - testFileName
  2304. // - /vdir1/dir1/testFileName1
  2305. err = client.Rename(testFileName1, path.Join(vdirPath1, dir1, testFileName1))
  2306. assert.NoError(t, err)
  2307. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  2308. assert.NoError(t, err)
  2309. assert.Equal(t, 2, user.UsedQuotaFiles)
  2310. assert.Equal(t, testFileSize+testFileSize1, user.UsedQuotaSize)
  2311. f, _, err := httpdtest.GetFolderByName(folderName1, http.StatusOK)
  2312. assert.NoError(t, err)
  2313. assert.Equal(t, testFileSize1, f.UsedQuotaSize)
  2314. assert.Equal(t, 1, f.UsedQuotaFiles)
  2315. // rename a file from user home dir to vdir2, vdir2 is not included in user quota so we have:
  2316. // - /vdir2/dir1/testFileName
  2317. // - /vdir1/dir1/testFileName1
  2318. err = client.Rename(testFileName, path.Join(vdirPath2, dir1, testFileName))
  2319. assert.NoError(t, err)
  2320. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  2321. assert.NoError(t, err)
  2322. assert.Equal(t, 1, user.UsedQuotaFiles)
  2323. assert.Equal(t, testFileSize1, user.UsedQuotaSize)
  2324. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  2325. assert.NoError(t, err)
  2326. assert.Equal(t, testFileSize, f.UsedQuotaSize)
  2327. assert.Equal(t, 1, f.UsedQuotaFiles)
  2328. // upload two new files to the user home dir so we have:
  2329. // - testFileName
  2330. // - testFileName1
  2331. // - /vdir1/dir1/testFileName1
  2332. // - /vdir2/dir1/testFileName
  2333. err = writeSFTPFile(testFileName, testFileSize, client)
  2334. assert.NoError(t, err)
  2335. err = writeSFTPFile(testFileName1, testFileSize1, client)
  2336. assert.NoError(t, err)
  2337. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  2338. assert.NoError(t, err)
  2339. assert.Equal(t, 3, user.UsedQuotaFiles)
  2340. assert.Equal(t, testFileSize+testFileSize1+testFileSize1, user.UsedQuotaSize)
  2341. // rename a file from user home dir to vdir1 overwriting an existing file, vdir1 is included in user quota so we have:
  2342. // - testFileName1
  2343. // - /vdir1/dir1/testFileName1 (initial testFileName)
  2344. // - /vdir2/dir1/testFileName
  2345. err = client.Rename(testFileName, path.Join(vdirPath1, dir1, testFileName1))
  2346. assert.NoError(t, err)
  2347. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  2348. assert.NoError(t, err)
  2349. assert.Equal(t, 2, user.UsedQuotaFiles)
  2350. assert.Equal(t, testFileSize+testFileSize1, user.UsedQuotaSize)
  2351. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  2352. assert.NoError(t, err)
  2353. assert.Equal(t, testFileSize, f.UsedQuotaSize)
  2354. assert.Equal(t, 1, f.UsedQuotaFiles)
  2355. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  2356. assert.NoError(t, err)
  2357. assert.Equal(t, testFileSize, f.UsedQuotaSize)
  2358. assert.Equal(t, 1, f.UsedQuotaFiles)
  2359. // rename a file from user home dir to vdir2 overwriting an existing file, vdir2 is not included in user quota so we have:
  2360. // - /vdir1/dir1/testFileName1 (initial testFileName)
  2361. // - /vdir2/dir1/testFileName (initial testFileName1)
  2362. err = client.Rename(testFileName1, path.Join(vdirPath2, dir1, testFileName))
  2363. assert.NoError(t, err)
  2364. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  2365. assert.NoError(t, err)
  2366. assert.Equal(t, 1, user.UsedQuotaFiles)
  2367. assert.Equal(t, testFileSize, user.UsedQuotaSize)
  2368. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  2369. assert.NoError(t, err)
  2370. assert.Equal(t, testFileSize, f.UsedQuotaSize)
  2371. assert.Equal(t, 1, f.UsedQuotaFiles)
  2372. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  2373. assert.NoError(t, err)
  2374. assert.Equal(t, testFileSize1, f.UsedQuotaSize)
  2375. assert.Equal(t, 1, f.UsedQuotaFiles)
  2376. err = client.Mkdir(dir1)
  2377. assert.NoError(t, err)
  2378. err = writeSFTPFile(path.Join(dir1, testFileName), testFileSize, client)
  2379. assert.NoError(t, err)
  2380. err = writeSFTPFile(path.Join(dir1, testFileName1), testFileSize1, client)
  2381. assert.NoError(t, err)
  2382. // - /dir1/testFileName
  2383. // - /dir1/testFileName1
  2384. // - /vdir1/dir1/testFileName1 (initial testFileName)
  2385. // - /vdir2/dir1/testFileName (initial testFileName1)
  2386. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  2387. assert.NoError(t, err)
  2388. assert.Equal(t, 3, user.UsedQuotaFiles)
  2389. assert.Equal(t, testFileSize*2+testFileSize1, user.UsedQuotaSize)
  2390. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  2391. assert.NoError(t, err)
  2392. assert.Equal(t, testFileSize, f.UsedQuotaSize)
  2393. assert.Equal(t, 1, f.UsedQuotaFiles)
  2394. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  2395. assert.NoError(t, err)
  2396. assert.Equal(t, testFileSize1, f.UsedQuotaSize)
  2397. assert.Equal(t, 1, f.UsedQuotaFiles)
  2398. // - /vdir1/adir/testFileName
  2399. // - /vdir1/adir/testFileName1
  2400. // - /vdir1/dir1/testFileName1 (initial testFileName)
  2401. // - /vdir2/dir1/testFileName (initial testFileName1)
  2402. err = client.Rename(dir1, path.Join(vdirPath1, "adir"))
  2403. assert.NoError(t, err)
  2404. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  2405. assert.NoError(t, err)
  2406. assert.Equal(t, 3, user.UsedQuotaFiles)
  2407. assert.Equal(t, testFileSize*2+testFileSize1, user.UsedQuotaSize)
  2408. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  2409. assert.NoError(t, err)
  2410. assert.Equal(t, testFileSize*2+testFileSize1, f.UsedQuotaSize)
  2411. assert.Equal(t, 3, f.UsedQuotaFiles)
  2412. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  2413. assert.NoError(t, err)
  2414. assert.Equal(t, testFileSize1, f.UsedQuotaSize)
  2415. assert.Equal(t, 1, f.UsedQuotaFiles)
  2416. err = client.Mkdir(dir1)
  2417. assert.NoError(t, err)
  2418. err = writeSFTPFile(path.Join(dir1, testFileName), testFileSize, client)
  2419. assert.NoError(t, err)
  2420. err = writeSFTPFile(path.Join(dir1, testFileName1), testFileSize1, client)
  2421. assert.NoError(t, err)
  2422. // - /vdir1/adir/testFileName
  2423. // - /vdir1/adir/testFileName1
  2424. // - /vdir1/dir1/testFileName1 (initial testFileName)
  2425. // - /vdir2/dir1/testFileName (initial testFileName1)
  2426. // - /vdir2/adir/testFileName
  2427. // - /vdir2/adir/testFileName1
  2428. err = client.Rename(dir1, path.Join(vdirPath2, "adir"))
  2429. assert.NoError(t, err)
  2430. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  2431. assert.NoError(t, err)
  2432. assert.Equal(t, 3, user.UsedQuotaFiles)
  2433. assert.Equal(t, testFileSize*2+testFileSize1, user.UsedQuotaSize)
  2434. f, _, err = httpdtest.GetFolderByName(folderName1, http.StatusOK)
  2435. assert.NoError(t, err)
  2436. assert.Equal(t, testFileSize*2+testFileSize1, f.UsedQuotaSize)
  2437. assert.Equal(t, 3, f.UsedQuotaFiles)
  2438. f, _, err = httpdtest.GetFolderByName(folderName2, http.StatusOK)
  2439. assert.NoError(t, err)
  2440. assert.Equal(t, testFileSize1*2+testFileSize, f.UsedQuotaSize)
  2441. assert.Equal(t, 3, f.UsedQuotaFiles)
  2442. }
  2443. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  2444. assert.NoError(t, err)
  2445. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName1}, http.StatusOK)
  2446. assert.NoError(t, err)
  2447. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName2}, http.StatusOK)
  2448. assert.NoError(t, err)
  2449. err = os.RemoveAll(user.GetHomeDir())
  2450. assert.NoError(t, err)
  2451. err = os.RemoveAll(mappedPath1)
  2452. assert.NoError(t, err)
  2453. err = os.RemoveAll(mappedPath2)
  2454. assert.NoError(t, err)
  2455. }
  2456. func TestTransferQuotaLimits(t *testing.T) {
  2457. u := getTestUser()
  2458. u.TotalDataTransfer = 1
  2459. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  2460. assert.NoError(t, err)
  2461. conn, client, err := getSftpClient(user)
  2462. if assert.NoError(t, err) {
  2463. defer conn.Close()
  2464. defer client.Close()
  2465. testFileSize := int64(524288)
  2466. err = writeSFTPFile(testFileName, testFileSize, client)
  2467. assert.NoError(t, err)
  2468. f, err := client.Open(testFileName)
  2469. assert.NoError(t, err)
  2470. contents := make([]byte, testFileSize)
  2471. n, err := io.ReadFull(f, contents)
  2472. assert.NoError(t, err)
  2473. assert.Equal(t, int(testFileSize), n)
  2474. assert.Len(t, contents, int(testFileSize))
  2475. err = f.Close()
  2476. assert.NoError(t, err)
  2477. _, err = client.Open(testFileName)
  2478. if assert.Error(t, err) {
  2479. assert.Contains(t, err.Error(), "SSH_FX_FAILURE")
  2480. assert.Contains(t, err.Error(), common.ErrReadQuotaExceeded.Error())
  2481. }
  2482. err = writeSFTPFile(testFileName, testFileSize, client)
  2483. if assert.Error(t, err) {
  2484. assert.Contains(t, err.Error(), "SSH_FX_FAILURE")
  2485. assert.Contains(t, err.Error(), common.ErrQuotaExceeded.Error())
  2486. }
  2487. }
  2488. // test the limit while uploading/downloading
  2489. user.TotalDataTransfer = 0
  2490. user.UploadDataTransfer = 1
  2491. user.DownloadDataTransfer = 1
  2492. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  2493. assert.NoError(t, err)
  2494. conn, client, err = getSftpClient(user)
  2495. if assert.NoError(t, err) {
  2496. defer conn.Close()
  2497. defer client.Close()
  2498. testFileSize := int64(450000)
  2499. err = writeSFTPFile(testFileName, testFileSize, client)
  2500. assert.NoError(t, err)
  2501. f, err := client.Open(testFileName)
  2502. if assert.NoError(t, err) {
  2503. _, err = io.Copy(io.Discard, f)
  2504. assert.NoError(t, err)
  2505. err = f.Close()
  2506. assert.NoError(t, err)
  2507. }
  2508. f, err = client.Open(testFileName)
  2509. if assert.NoError(t, err) {
  2510. _, err = io.Copy(io.Discard, f)
  2511. if assert.Error(t, err) {
  2512. assert.Contains(t, err.Error(), "SSH_FX_FAILURE")
  2513. assert.Contains(t, err.Error(), common.ErrReadQuotaExceeded.Error())
  2514. }
  2515. err = f.Close()
  2516. assert.Error(t, err)
  2517. }
  2518. err = writeSFTPFile(testFileName, testFileSize, client)
  2519. if assert.Error(t, err) {
  2520. assert.Contains(t, err.Error(), "SSH_FX_FAILURE")
  2521. assert.Contains(t, err.Error(), common.ErrQuotaExceeded.Error())
  2522. }
  2523. }
  2524. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  2525. assert.NoError(t, err)
  2526. err = os.RemoveAll(user.GetHomeDir())
  2527. assert.NoError(t, err)
  2528. }
  2529. func TestVirtualFoldersLink(t *testing.T) {
  2530. u := getTestUser()
  2531. mappedPath1 := filepath.Join(os.TempDir(), "vdir1")
  2532. folderName1 := filepath.Base(mappedPath1)
  2533. vdirPath1 := "/vdir1"
  2534. mappedPath2 := filepath.Join(os.TempDir(), "vdir2")
  2535. folderName2 := filepath.Base(mappedPath2)
  2536. vdirPath2 := "/vdir2"
  2537. f1 := vfs.BaseVirtualFolder{
  2538. Name: folderName1,
  2539. MappedPath: mappedPath1,
  2540. }
  2541. _, _, err := httpdtest.AddFolder(f1, http.StatusCreated)
  2542. assert.NoError(t, err)
  2543. f2 := vfs.BaseVirtualFolder{
  2544. Name: folderName2,
  2545. MappedPath: mappedPath2,
  2546. }
  2547. _, _, err = httpdtest.AddFolder(f2, http.StatusCreated)
  2548. assert.NoError(t, err)
  2549. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  2550. BaseVirtualFolder: vfs.BaseVirtualFolder{
  2551. Name: folderName1,
  2552. },
  2553. VirtualPath: vdirPath1,
  2554. // quota is included in the user's one
  2555. QuotaFiles: -1,
  2556. QuotaSize: -1,
  2557. })
  2558. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  2559. BaseVirtualFolder: vfs.BaseVirtualFolder{
  2560. Name: folderName2,
  2561. },
  2562. VirtualPath: vdirPath2,
  2563. // quota is unlimited and excluded from user's one
  2564. QuotaFiles: 0,
  2565. QuotaSize: 0,
  2566. })
  2567. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  2568. assert.NoError(t, err)
  2569. conn, client, err := getSftpClient(user)
  2570. if assert.NoError(t, err) {
  2571. defer conn.Close()
  2572. defer client.Close()
  2573. testFileSize := int64(131072)
  2574. testDir := "adir"
  2575. err = writeSFTPFile(testFileName, testFileSize, client)
  2576. assert.NoError(t, err)
  2577. err = writeSFTPFile(path.Join(vdirPath1, testFileName), testFileSize, client)
  2578. assert.NoError(t, err)
  2579. err = writeSFTPFile(path.Join(vdirPath2, testFileName), testFileSize, client)
  2580. assert.NoError(t, err)
  2581. err = client.Mkdir(path.Join(vdirPath1, testDir))
  2582. assert.NoError(t, err)
  2583. err = client.Mkdir(path.Join(vdirPath2, testDir))
  2584. assert.NoError(t, err)
  2585. err = client.Symlink(testFileName, testFileName+".link")
  2586. assert.NoError(t, err)
  2587. err = client.Symlink(path.Join(vdirPath1, testFileName), path.Join(vdirPath1, testFileName+".link"))
  2588. assert.NoError(t, err)
  2589. err = client.Symlink(path.Join(vdirPath1, testFileName), path.Join(vdirPath1, testDir, testFileName+".link"))
  2590. assert.NoError(t, err)
  2591. err = client.Symlink(path.Join(vdirPath2, testFileName), path.Join(vdirPath2, testFileName+".link"))
  2592. assert.NoError(t, err)
  2593. err = client.Symlink(path.Join(vdirPath2, testFileName), path.Join(vdirPath2, testDir, testFileName+".link"))
  2594. assert.NoError(t, err)
  2595. err = client.Symlink(path.Join("/", testFileName), path.Join(vdirPath1, testFileName+".link1")) //nolint:goconst
  2596. if assert.Error(t, err) {
  2597. assert.Contains(t, err.Error(), "SSH_FX_OP_UNSUPPORTED")
  2598. }
  2599. err = client.Symlink(path.Join("/", testFileName), path.Join(vdirPath1, testDir, testFileName+".link1"))
  2600. if assert.Error(t, err) {
  2601. assert.Contains(t, err.Error(), "SSH_FX_OP_UNSUPPORTED")
  2602. }
  2603. err = client.Symlink(path.Join("/", testFileName), path.Join(vdirPath2, testFileName+".link1"))
  2604. if assert.Error(t, err) {
  2605. assert.Contains(t, err.Error(), "SSH_FX_OP_UNSUPPORTED")
  2606. }
  2607. err = client.Symlink(path.Join("/", testFileName), path.Join(vdirPath2, testDir, testFileName+".link1"))
  2608. if assert.Error(t, err) {
  2609. assert.Contains(t, err.Error(), "SSH_FX_OP_UNSUPPORTED")
  2610. }
  2611. err = client.Symlink(path.Join(vdirPath1, testFileName), testFileName+".link1")
  2612. if assert.Error(t, err) {
  2613. assert.Contains(t, err.Error(), "SSH_FX_OP_UNSUPPORTED")
  2614. }
  2615. err = client.Symlink(path.Join(vdirPath2, testFileName), testFileName+".link1")
  2616. if assert.Error(t, err) {
  2617. assert.Contains(t, err.Error(), "SSH_FX_OP_UNSUPPORTED")
  2618. }
  2619. err = client.Symlink(path.Join(vdirPath1, testFileName), path.Join(vdirPath2, testDir, testFileName+".link1"))
  2620. if assert.Error(t, err) {
  2621. assert.Contains(t, err.Error(), "SSH_FX_OP_UNSUPPORTED")
  2622. }
  2623. err = client.Symlink(path.Join(vdirPath2, testFileName), path.Join(vdirPath1, testFileName+".link1"))
  2624. if assert.Error(t, err) {
  2625. assert.Contains(t, err.Error(), "SSH_FX_OP_UNSUPPORTED")
  2626. }
  2627. err = client.Symlink("/", "/roolink")
  2628. assert.ErrorIs(t, err, os.ErrPermission)
  2629. err = client.Symlink(testFileName, "/")
  2630. assert.ErrorIs(t, err, os.ErrPermission)
  2631. err = client.Symlink(testFileName, vdirPath1)
  2632. if assert.Error(t, err) {
  2633. assert.Contains(t, err.Error(), "SSH_FX_OP_UNSUPPORTED")
  2634. }
  2635. err = client.Symlink(vdirPath1, testFileName+".link2")
  2636. if assert.Error(t, err) {
  2637. assert.Contains(t, err.Error(), "SSH_FX_OP_UNSUPPORTED")
  2638. }
  2639. }
  2640. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  2641. assert.NoError(t, err)
  2642. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName1}, http.StatusOK)
  2643. assert.NoError(t, err)
  2644. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName2}, http.StatusOK)
  2645. assert.NoError(t, err)
  2646. err = os.RemoveAll(user.GetHomeDir())
  2647. assert.NoError(t, err)
  2648. err = os.RemoveAll(mappedPath1)
  2649. assert.NoError(t, err)
  2650. err = os.RemoveAll(mappedPath2)
  2651. assert.NoError(t, err)
  2652. }
  2653. func TestCrossFolderRename(t *testing.T) {
  2654. folder1 := "folder1"
  2655. folder2 := "folder2"
  2656. folder3 := "folder3"
  2657. folder4 := "folder4"
  2658. folder5 := "folder5"
  2659. folder6 := "folder6"
  2660. folder7 := "folder7"
  2661. baseUser, resp, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  2662. assert.NoError(t, err, string(resp))
  2663. f1 := vfs.BaseVirtualFolder{
  2664. Name: folder1,
  2665. MappedPath: filepath.Join(os.TempDir(), folder1),
  2666. FsConfig: vfs.Filesystem{
  2667. Provider: sdk.CryptedFilesystemProvider,
  2668. CryptConfig: vfs.CryptFsConfig{
  2669. Passphrase: kms.NewPlainSecret(defaultPassword),
  2670. },
  2671. },
  2672. }
  2673. _, _, err = httpdtest.AddFolder(f1, http.StatusCreated)
  2674. assert.NoError(t, err)
  2675. f2 := vfs.BaseVirtualFolder{
  2676. Name: folder2,
  2677. MappedPath: filepath.Join(os.TempDir(), folder2),
  2678. FsConfig: vfs.Filesystem{
  2679. Provider: sdk.CryptedFilesystemProvider,
  2680. CryptConfig: vfs.CryptFsConfig{
  2681. Passphrase: kms.NewPlainSecret(defaultPassword),
  2682. },
  2683. },
  2684. }
  2685. _, _, err = httpdtest.AddFolder(f2, http.StatusCreated)
  2686. assert.NoError(t, err)
  2687. f3 := vfs.BaseVirtualFolder{
  2688. Name: folder3,
  2689. MappedPath: filepath.Join(os.TempDir(), folder3),
  2690. FsConfig: vfs.Filesystem{
  2691. Provider: sdk.CryptedFilesystemProvider,
  2692. CryptConfig: vfs.CryptFsConfig{
  2693. Passphrase: kms.NewPlainSecret(defaultPassword + "mod"),
  2694. },
  2695. },
  2696. }
  2697. _, _, err = httpdtest.AddFolder(f3, http.StatusCreated)
  2698. assert.NoError(t, err)
  2699. f4 := vfs.BaseVirtualFolder{
  2700. Name: folder4,
  2701. MappedPath: filepath.Join(os.TempDir(), folder4),
  2702. FsConfig: vfs.Filesystem{
  2703. Provider: sdk.SFTPFilesystemProvider,
  2704. SFTPConfig: vfs.SFTPFsConfig{
  2705. BaseSFTPFsConfig: sdk.BaseSFTPFsConfig{
  2706. Endpoint: sftpServerAddr,
  2707. Username: baseUser.Username,
  2708. Prefix: path.Join("/", folder4),
  2709. },
  2710. Password: kms.NewPlainSecret(defaultPassword),
  2711. },
  2712. },
  2713. }
  2714. _, _, err = httpdtest.AddFolder(f4, http.StatusCreated)
  2715. assert.NoError(t, err)
  2716. f5 := vfs.BaseVirtualFolder{
  2717. Name: folder5,
  2718. MappedPath: filepath.Join(os.TempDir(), folder5),
  2719. FsConfig: vfs.Filesystem{
  2720. Provider: sdk.SFTPFilesystemProvider,
  2721. SFTPConfig: vfs.SFTPFsConfig{
  2722. BaseSFTPFsConfig: sdk.BaseSFTPFsConfig{
  2723. Endpoint: sftpServerAddr,
  2724. Username: baseUser.Username,
  2725. Prefix: path.Join("/", folder5),
  2726. },
  2727. Password: kms.NewPlainSecret(defaultPassword),
  2728. },
  2729. },
  2730. }
  2731. _, _, err = httpdtest.AddFolder(f5, http.StatusCreated)
  2732. assert.NoError(t, err)
  2733. f6 := vfs.BaseVirtualFolder{
  2734. Name: folder6,
  2735. MappedPath: filepath.Join(os.TempDir(), folder6),
  2736. FsConfig: vfs.Filesystem{
  2737. Provider: sdk.SFTPFilesystemProvider,
  2738. SFTPConfig: vfs.SFTPFsConfig{
  2739. BaseSFTPFsConfig: sdk.BaseSFTPFsConfig{
  2740. Endpoint: "127.0.0.1:4024",
  2741. Username: baseUser.Username,
  2742. Prefix: path.Join("/", folder6),
  2743. },
  2744. Password: kms.NewPlainSecret(defaultPassword),
  2745. },
  2746. },
  2747. }
  2748. _, _, err = httpdtest.AddFolder(f6, http.StatusCreated)
  2749. assert.NoError(t, err)
  2750. f7 := vfs.BaseVirtualFolder{
  2751. Name: folder7,
  2752. MappedPath: filepath.Join(os.TempDir(), folder7),
  2753. FsConfig: vfs.Filesystem{
  2754. Provider: sdk.SFTPFilesystemProvider,
  2755. SFTPConfig: vfs.SFTPFsConfig{
  2756. BaseSFTPFsConfig: sdk.BaseSFTPFsConfig{
  2757. Endpoint: sftpServerAddr,
  2758. Username: baseUser.Username,
  2759. Prefix: path.Join("/", folder4),
  2760. },
  2761. Password: kms.NewPlainSecret(defaultPassword),
  2762. },
  2763. },
  2764. }
  2765. _, _, err = httpdtest.AddFolder(f7, http.StatusCreated)
  2766. assert.NoError(t, err)
  2767. u := getCryptFsUser()
  2768. u.VirtualFolders = []vfs.VirtualFolder{
  2769. {
  2770. BaseVirtualFolder: vfs.BaseVirtualFolder{
  2771. Name: folder1,
  2772. },
  2773. VirtualPath: path.Join("/", folder1),
  2774. QuotaSize: -1,
  2775. QuotaFiles: -1,
  2776. },
  2777. {
  2778. BaseVirtualFolder: vfs.BaseVirtualFolder{
  2779. Name: folder2,
  2780. },
  2781. VirtualPath: path.Join("/", folder2),
  2782. QuotaSize: -1,
  2783. QuotaFiles: -1,
  2784. },
  2785. {
  2786. BaseVirtualFolder: vfs.BaseVirtualFolder{
  2787. Name: folder3,
  2788. },
  2789. VirtualPath: path.Join("/", folder3),
  2790. QuotaSize: -1,
  2791. QuotaFiles: -1,
  2792. },
  2793. {
  2794. BaseVirtualFolder: vfs.BaseVirtualFolder{
  2795. Name: folder4,
  2796. },
  2797. VirtualPath: path.Join("/", folder4),
  2798. QuotaSize: -1,
  2799. QuotaFiles: -1,
  2800. },
  2801. {
  2802. BaseVirtualFolder: vfs.BaseVirtualFolder{
  2803. Name: folder5,
  2804. },
  2805. VirtualPath: path.Join("/", folder5),
  2806. QuotaSize: -1,
  2807. QuotaFiles: -1,
  2808. },
  2809. {
  2810. BaseVirtualFolder: vfs.BaseVirtualFolder{
  2811. Name: folder6,
  2812. },
  2813. VirtualPath: path.Join("/", folder6),
  2814. QuotaSize: -1,
  2815. QuotaFiles: -1,
  2816. },
  2817. {
  2818. BaseVirtualFolder: vfs.BaseVirtualFolder{
  2819. Name: folder7,
  2820. },
  2821. VirtualPath: path.Join("/", folder7),
  2822. QuotaSize: -1,
  2823. QuotaFiles: -1,
  2824. },
  2825. }
  2826. user, resp, err := httpdtest.AddUser(u, http.StatusCreated)
  2827. assert.NoError(t, err, string(resp))
  2828. conn, client, err := getSftpClient(user)
  2829. if assert.NoError(t, err) {
  2830. defer conn.Close()
  2831. defer client.Close()
  2832. subDir := "testSubDir"
  2833. err = client.Mkdir(subDir)
  2834. assert.NoError(t, err)
  2835. err = writeSFTPFile(path.Join(subDir, "afile.bin"), 64, client)
  2836. assert.NoError(t, err)
  2837. err = client.Rename(subDir, path.Join("/", folder1, subDir))
  2838. assert.NoError(t, err)
  2839. _, err = client.Stat(path.Join("/", folder1, subDir))
  2840. assert.NoError(t, err)
  2841. _, err = client.Stat(path.Join("/", folder1, subDir, "afile.bin"))
  2842. assert.NoError(t, err)
  2843. err = client.Rename(path.Join("/", folder1, subDir), path.Join("/", folder2, subDir))
  2844. assert.NoError(t, err)
  2845. _, err = client.Stat(path.Join("/", folder2, subDir))
  2846. assert.NoError(t, err)
  2847. _, err = client.Stat(path.Join("/", folder2, subDir, "afile.bin"))
  2848. assert.NoError(t, err)
  2849. err = client.Rename(path.Join("/", folder2, subDir), path.Join("/", folder3, subDir))
  2850. assert.ErrorIs(t, err, os.ErrPermission)
  2851. err = writeSFTPFile(path.Join("/", folder3, "file.bin"), 64, client)
  2852. assert.NoError(t, err)
  2853. err = client.Rename(path.Join("/", folder3, "file.bin"), "/renamed.bin")
  2854. assert.ErrorIs(t, err, os.ErrPermission)
  2855. err = client.Rename(path.Join("/", folder3, "file.bin"), path.Join("/", folder2, "/renamed.bin"))
  2856. assert.ErrorIs(t, err, os.ErrPermission)
  2857. err = client.Rename(path.Join("/", folder3, "file.bin"), path.Join("/", folder3, "/renamed.bin"))
  2858. assert.NoError(t, err)
  2859. err = writeSFTPFile("/afile.bin", 64, client)
  2860. assert.NoError(t, err)
  2861. err = client.Rename("afile.bin", path.Join("/", folder4, "afile_renamed.bin"))
  2862. assert.ErrorIs(t, err, os.ErrPermission)
  2863. err = writeSFTPFile(path.Join("/", folder4, "afile.bin"), 64, client)
  2864. assert.NoError(t, err)
  2865. err = client.Rename(path.Join("/", folder4, "afile.bin"), path.Join("/", folder5, "afile_renamed.bin"))
  2866. assert.NoError(t, err)
  2867. err = client.Rename(path.Join("/", folder5, "afile_renamed.bin"), path.Join("/", folder6, "afile_renamed.bin"))
  2868. assert.ErrorIs(t, err, os.ErrPermission)
  2869. err = writeSFTPFile(path.Join("/", folder4, "afile.bin"), 64, client)
  2870. assert.NoError(t, err)
  2871. _, err = client.Stat(path.Join("/", folder7, "afile.bin"))
  2872. assert.NoError(t, err)
  2873. err = client.Rename(path.Join("/", folder4, "afile.bin"), path.Join("/", folder7, "afile.bin"))
  2874. assert.NoError(t, err)
  2875. }
  2876. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  2877. assert.NoError(t, err)
  2878. err = os.RemoveAll(user.GetHomeDir())
  2879. assert.NoError(t, err)
  2880. _, err = httpdtest.RemoveUser(baseUser, http.StatusOK)
  2881. assert.NoError(t, err)
  2882. err = os.RemoveAll(baseUser.GetHomeDir())
  2883. assert.NoError(t, err)
  2884. for _, folderName := range []string{folder1, folder2, folder3, folder4, folder5, folder6, folder7} {
  2885. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName}, http.StatusOK)
  2886. assert.NoError(t, err)
  2887. err = os.RemoveAll(filepath.Join(os.TempDir(), folderName))
  2888. assert.NoError(t, err)
  2889. }
  2890. }
  2891. func TestDirs(t *testing.T) {
  2892. u := getTestUser()
  2893. mappedPath := filepath.Join(os.TempDir(), "vdir")
  2894. folderName := filepath.Base(mappedPath)
  2895. vdirPath := "/path/vdir"
  2896. f := vfs.BaseVirtualFolder{
  2897. Name: folderName,
  2898. MappedPath: mappedPath,
  2899. }
  2900. _, _, err := httpdtest.AddFolder(f, http.StatusCreated)
  2901. assert.NoError(t, err)
  2902. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  2903. BaseVirtualFolder: vfs.BaseVirtualFolder{
  2904. Name: folderName,
  2905. },
  2906. VirtualPath: vdirPath,
  2907. })
  2908. u.Permissions["/subdir"] = []string{dataprovider.PermDownload, dataprovider.PermUpload,
  2909. dataprovider.PermDelete, dataprovider.PermCreateDirs, dataprovider.PermRename, dataprovider.PermListItems}
  2910. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  2911. assert.NoError(t, err)
  2912. conn, client, err := getSftpClient(user)
  2913. if assert.NoError(t, err) {
  2914. defer conn.Close()
  2915. defer client.Close()
  2916. info, err := client.ReadDir("/")
  2917. if assert.NoError(t, err) {
  2918. if assert.Len(t, info, 1) {
  2919. assert.Equal(t, "path", info[0].Name())
  2920. }
  2921. }
  2922. fi, err := client.Stat(path.Dir(vdirPath))
  2923. if assert.NoError(t, err) {
  2924. assert.True(t, fi.IsDir())
  2925. }
  2926. err = client.RemoveDirectory("/")
  2927. assert.ErrorIs(t, err, os.ErrPermission)
  2928. err = client.RemoveDirectory(vdirPath)
  2929. assert.ErrorIs(t, err, os.ErrPermission)
  2930. err = client.RemoveDirectory(path.Dir(vdirPath))
  2931. if assert.Error(t, err) {
  2932. assert.Contains(t, err.Error(), "SSH_FX_OP_UNSUPPORTED")
  2933. }
  2934. err = client.Mkdir(vdirPath)
  2935. assert.ErrorIs(t, err, os.ErrPermission)
  2936. err = client.Mkdir("adir")
  2937. assert.NoError(t, err)
  2938. err = client.Rename("/adir", path.Dir(vdirPath))
  2939. if assert.Error(t, err) {
  2940. assert.Contains(t, err.Error(), "SSH_FX_OP_UNSUPPORTED")
  2941. }
  2942. err = client.MkdirAll("/subdir/adir")
  2943. assert.NoError(t, err)
  2944. err = client.Rename("adir", "subdir/adir")
  2945. if assert.Error(t, err) {
  2946. assert.Contains(t, err.Error(), "SSH_FX_OP_UNSUPPORTED")
  2947. }
  2948. err = writeSFTPFile("/subdir/afile.bin", 64, client)
  2949. assert.NoError(t, err)
  2950. err = writeSFTPFile("/afile.bin", 32, client)
  2951. assert.NoError(t, err)
  2952. err = client.Rename("afile.bin", "subdir/afile.bin")
  2953. assert.ErrorIs(t, err, os.ErrPermission)
  2954. err = client.Rename("afile.bin", "subdir/afile1.bin")
  2955. assert.NoError(t, err)
  2956. err = client.Rename(path.Dir(vdirPath), "renamed_vdir")
  2957. if assert.Error(t, err) {
  2958. assert.Contains(t, err.Error(), "SSH_FX_OP_UNSUPPORTED")
  2959. }
  2960. }
  2961. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  2962. assert.NoError(t, err)
  2963. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName}, http.StatusOK)
  2964. assert.NoError(t, err)
  2965. err = os.RemoveAll(user.GetHomeDir())
  2966. assert.NoError(t, err)
  2967. err = os.RemoveAll(mappedPath)
  2968. assert.NoError(t, err)
  2969. }
  2970. func TestCryptFsStat(t *testing.T) {
  2971. user, _, err := httpdtest.AddUser(getCryptFsUser(), http.StatusCreated)
  2972. assert.NoError(t, err)
  2973. conn, client, err := getSftpClient(user)
  2974. if assert.NoError(t, err) {
  2975. defer conn.Close()
  2976. defer client.Close()
  2977. testFileSize := int64(4096)
  2978. err = writeSFTPFile(testFileName, testFileSize, client)
  2979. assert.NoError(t, err)
  2980. info, err := client.Stat(testFileName)
  2981. if assert.NoError(t, err) {
  2982. assert.Equal(t, testFileSize, info.Size())
  2983. }
  2984. info, err = os.Stat(filepath.Join(user.HomeDir, testFileName))
  2985. if assert.NoError(t, err) {
  2986. assert.Greater(t, info.Size(), testFileSize)
  2987. }
  2988. }
  2989. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  2990. assert.NoError(t, err)
  2991. err = os.RemoveAll(user.GetHomeDir())
  2992. assert.NoError(t, err)
  2993. }
  2994. func TestFsPermissionErrors(t *testing.T) {
  2995. if runtime.GOOS == osWindows {
  2996. t.Skip("this test is not available on Windows")
  2997. }
  2998. user, _, err := httpdtest.AddUser(getCryptFsUser(), http.StatusCreated)
  2999. assert.NoError(t, err)
  3000. conn, client, err := getSftpClient(user)
  3001. if assert.NoError(t, err) {
  3002. defer conn.Close()
  3003. defer client.Close()
  3004. testDir := "tDir"
  3005. err = client.Mkdir(testDir)
  3006. assert.NoError(t, err)
  3007. err = os.Chmod(user.GetHomeDir(), 0111)
  3008. assert.NoError(t, err)
  3009. err = client.RemoveDirectory(testDir)
  3010. assert.ErrorIs(t, err, os.ErrPermission)
  3011. err = client.Rename(testDir, testDir+"1")
  3012. assert.ErrorIs(t, err, os.ErrPermission)
  3013. err = os.Chmod(user.GetHomeDir(), os.ModePerm)
  3014. assert.NoError(t, err)
  3015. }
  3016. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  3017. assert.NoError(t, err)
  3018. err = os.RemoveAll(user.GetHomeDir())
  3019. assert.NoError(t, err)
  3020. }
  3021. func TestRenameErrorOutsideHomeDir(t *testing.T) {
  3022. if runtime.GOOS == osWindows {
  3023. t.Skip("this test is not available on Windows")
  3024. }
  3025. oldUploadMode := common.Config.UploadMode
  3026. oldTempPath := common.Config.TempPath
  3027. common.Config.UploadMode = common.UploadModeAtomicWithResume
  3028. common.Config.TempPath = filepath.Clean(os.TempDir())
  3029. vfs.SetTempPath(common.Config.TempPath)
  3030. u := getTestUser()
  3031. u.QuotaFiles = 1000
  3032. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  3033. assert.NoError(t, err)
  3034. conn, client, err := getSftpClient(user)
  3035. if assert.NoError(t, err) {
  3036. defer conn.Close()
  3037. defer client.Close()
  3038. err = os.Chmod(user.GetHomeDir(), 0555)
  3039. assert.NoError(t, err)
  3040. err = checkBasicSFTP(client)
  3041. assert.NoError(t, err)
  3042. f, err := client.Create(testFileName)
  3043. assert.NoError(t, err)
  3044. _, err = f.Write(testFileContent)
  3045. assert.NoError(t, err)
  3046. err = f.Close()
  3047. assert.ErrorIs(t, err, os.ErrPermission)
  3048. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  3049. assert.NoError(t, err)
  3050. assert.Equal(t, 0, user.UsedQuotaFiles)
  3051. assert.Equal(t, int64(0), user.UsedQuotaSize)
  3052. err = os.Chmod(user.GetHomeDir(), os.ModeDir)
  3053. assert.NoError(t, err)
  3054. }
  3055. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  3056. assert.NoError(t, err)
  3057. err = os.RemoveAll(user.GetHomeDir())
  3058. assert.NoError(t, err)
  3059. common.Config.UploadMode = oldUploadMode
  3060. common.Config.TempPath = oldTempPath
  3061. vfs.SetTempPath(oldTempPath)
  3062. }
  3063. func TestResolvePathError(t *testing.T) {
  3064. u := getTestUser()
  3065. u.HomeDir = "relative_path"
  3066. conn := common.NewBaseConnection("", common.ProtocolFTP, "", "", u)
  3067. testPath := "apath"
  3068. _, err := conn.ListDir(testPath)
  3069. assert.Error(t, err)
  3070. err = conn.CreateDir(testPath, true)
  3071. assert.Error(t, err)
  3072. err = conn.RemoveDir(testPath)
  3073. assert.Error(t, err)
  3074. err = conn.Rename(testPath, testPath+"1")
  3075. assert.Error(t, err)
  3076. err = conn.CreateSymlink(testPath, testPath+".sym")
  3077. assert.Error(t, err)
  3078. _, err = conn.DoStat(testPath, 0, false)
  3079. assert.Error(t, err)
  3080. err = conn.RemoveAll(testPath)
  3081. assert.Error(t, err)
  3082. err = conn.SetStat(testPath, &common.StatAttributes{
  3083. Atime: time.Now(),
  3084. Mtime: time.Now(),
  3085. })
  3086. assert.Error(t, err)
  3087. u = getTestUser()
  3088. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  3089. BaseVirtualFolder: vfs.BaseVirtualFolder{
  3090. MappedPath: "relative_mapped_path",
  3091. },
  3092. VirtualPath: "/vpath",
  3093. })
  3094. err = os.MkdirAll(u.HomeDir, os.ModePerm)
  3095. assert.NoError(t, err)
  3096. conn.User = u
  3097. err = conn.Rename(testPath, "/vpath/subpath")
  3098. assert.Error(t, err)
  3099. outHomePath := filepath.Join(os.TempDir(), testFileName)
  3100. err = os.WriteFile(outHomePath, testFileContent, os.ModePerm)
  3101. assert.NoError(t, err)
  3102. err = os.Symlink(outHomePath, filepath.Join(u.HomeDir, testFileName+".link"))
  3103. assert.NoError(t, err)
  3104. err = os.WriteFile(filepath.Join(u.HomeDir, testFileName), testFileContent, os.ModePerm)
  3105. assert.NoError(t, err)
  3106. err = conn.CreateSymlink(testFileName, testFileName+".link")
  3107. assert.Error(t, err)
  3108. err = os.RemoveAll(u.GetHomeDir())
  3109. assert.NoError(t, err)
  3110. err = os.Remove(outHomePath)
  3111. assert.NoError(t, err)
  3112. }
  3113. func TestUserPasswordHashing(t *testing.T) {
  3114. if config.GetProviderConf().Driver == dataprovider.MemoryDataProviderName {
  3115. t.Skip("this test is not supported with the memory provider")
  3116. }
  3117. u := getTestUser()
  3118. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  3119. assert.NoError(t, err)
  3120. err = dataprovider.Close()
  3121. assert.NoError(t, err)
  3122. err = config.LoadConfig(configDir, "")
  3123. assert.NoError(t, err)
  3124. providerConf := config.GetProviderConf()
  3125. providerConf.PasswordHashing.Algo = dataprovider.HashingAlgoArgon2ID
  3126. err = dataprovider.Initialize(providerConf, configDir, true)
  3127. assert.NoError(t, err)
  3128. currentUser, err := dataprovider.UserExists(user.Username, "")
  3129. assert.NoError(t, err)
  3130. assert.True(t, strings.HasPrefix(currentUser.Password, "$2a$"))
  3131. conn, client, err := getSftpClient(user)
  3132. if assert.NoError(t, err) {
  3133. defer conn.Close()
  3134. defer client.Close()
  3135. err = checkBasicSFTP(client)
  3136. assert.NoError(t, err)
  3137. }
  3138. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  3139. assert.NoError(t, err)
  3140. err = os.RemoveAll(user.GetHomeDir())
  3141. assert.NoError(t, err)
  3142. u = getTestUser()
  3143. user, _, err = httpdtest.AddUser(u, http.StatusCreated)
  3144. assert.NoError(t, err)
  3145. currentUser, err = dataprovider.UserExists(user.Username, "")
  3146. assert.NoError(t, err)
  3147. assert.True(t, strings.HasPrefix(currentUser.Password, "$argon2id$"))
  3148. conn, client, err = getSftpClient(user)
  3149. if assert.NoError(t, err) {
  3150. defer conn.Close()
  3151. defer client.Close()
  3152. err = checkBasicSFTP(client)
  3153. assert.NoError(t, err)
  3154. }
  3155. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  3156. assert.NoError(t, err)
  3157. err = os.RemoveAll(user.GetHomeDir())
  3158. assert.NoError(t, err)
  3159. err = dataprovider.Close()
  3160. assert.NoError(t, err)
  3161. err = config.LoadConfig(configDir, "")
  3162. assert.NoError(t, err)
  3163. providerConf = config.GetProviderConf()
  3164. err = dataprovider.Initialize(providerConf, configDir, true)
  3165. assert.NoError(t, err)
  3166. }
  3167. func TestAllowList(t *testing.T) {
  3168. configCopy := common.Config
  3169. entries := []dataprovider.IPListEntry{
  3170. {
  3171. IPOrNet: "172.18.1.1/32",
  3172. Type: dataprovider.IPListTypeAllowList,
  3173. Mode: dataprovider.ListModeAllow,
  3174. Protocols: 0,
  3175. },
  3176. {
  3177. IPOrNet: "172.18.1.2/32",
  3178. Type: dataprovider.IPListTypeAllowList,
  3179. Mode: dataprovider.ListModeAllow,
  3180. Protocols: 0,
  3181. },
  3182. {
  3183. IPOrNet: "10.8.7.0/24",
  3184. Type: dataprovider.IPListTypeAllowList,
  3185. Mode: dataprovider.ListModeAllow,
  3186. Protocols: 5,
  3187. },
  3188. {
  3189. IPOrNet: "0.0.0.0/0",
  3190. Type: dataprovider.IPListTypeAllowList,
  3191. Mode: dataprovider.ListModeAllow,
  3192. Protocols: 8,
  3193. },
  3194. {
  3195. IPOrNet: "::/0",
  3196. Type: dataprovider.IPListTypeAllowList,
  3197. Mode: dataprovider.ListModeAllow,
  3198. Protocols: 8,
  3199. },
  3200. }
  3201. for _, e := range entries {
  3202. _, resp, err := httpdtest.AddIPListEntry(e, http.StatusCreated)
  3203. assert.NoError(t, err, string(resp))
  3204. }
  3205. common.Config.AllowListStatus = 1
  3206. err := common.Initialize(common.Config, 0)
  3207. assert.NoError(t, err)
  3208. assert.True(t, common.Config.IsAllowListEnabled())
  3209. testIP := "172.18.1.1"
  3210. assert.NoError(t, common.Connections.IsNewConnectionAllowed(testIP, common.ProtocolFTP))
  3211. entry := entries[0]
  3212. entry.Protocols = 1
  3213. _, _, err = httpdtest.UpdateIPListEntry(entry, http.StatusOK)
  3214. assert.NoError(t, err)
  3215. assert.Error(t, common.Connections.IsNewConnectionAllowed(testIP, common.ProtocolFTP))
  3216. assert.NoError(t, common.Connections.IsNewConnectionAllowed(testIP, common.ProtocolSSH))
  3217. _, err = httpdtest.RemoveIPListEntry(entry, http.StatusOK)
  3218. assert.NoError(t, err)
  3219. entries = entries[1:]
  3220. assert.Error(t, common.Connections.IsNewConnectionAllowed(testIP, common.ProtocolSSH))
  3221. assert.Error(t, common.Connections.IsNewConnectionAllowed("172.18.1.3", common.ProtocolSSH))
  3222. assert.NoError(t, common.Connections.IsNewConnectionAllowed("172.18.1.3", common.ProtocolHTTP))
  3223. assert.NoError(t, common.Connections.IsNewConnectionAllowed("10.8.7.3", common.ProtocolWebDAV))
  3224. assert.NoError(t, common.Connections.IsNewConnectionAllowed("10.8.7.4", common.ProtocolSSH))
  3225. assert.Error(t, common.Connections.IsNewConnectionAllowed("10.8.7.4", common.ProtocolFTP))
  3226. assert.NoError(t, common.Connections.IsNewConnectionAllowed("10.8.7.4", common.ProtocolHTTP))
  3227. assert.NoError(t, common.Connections.IsNewConnectionAllowed("2001:0db8::1428:57ab", common.ProtocolHTTP))
  3228. assert.Error(t, common.Connections.IsNewConnectionAllowed("2001:0db8::1428:57ab", common.ProtocolSSH))
  3229. assert.Error(t, common.Connections.IsNewConnectionAllowed("10.8.8.2", common.ProtocolWebDAV))
  3230. assert.Error(t, common.Connections.IsNewConnectionAllowed("invalid IP", common.ProtocolHTTP))
  3231. common.Config = configCopy
  3232. err = common.Initialize(common.Config, 0)
  3233. assert.NoError(t, err)
  3234. assert.False(t, common.Config.IsAllowListEnabled())
  3235. for _, e := range entries {
  3236. _, err := httpdtest.RemoveIPListEntry(e, http.StatusOK)
  3237. assert.NoError(t, err)
  3238. }
  3239. }
  3240. func TestDbDefenderErrors(t *testing.T) {
  3241. if !isDbDefenderSupported() {
  3242. t.Skip("this test is not supported with the current database provider")
  3243. }
  3244. configCopy := common.Config
  3245. common.Config.DefenderConfig.Enabled = true
  3246. common.Config.DefenderConfig.Driver = common.DefenderDriverProvider
  3247. err := common.Initialize(common.Config, 0)
  3248. assert.NoError(t, err)
  3249. testIP := "127.1.1.1"
  3250. hosts, err := common.GetDefenderHosts()
  3251. assert.NoError(t, err)
  3252. assert.Len(t, hosts, 0)
  3253. common.AddDefenderEvent(testIP, common.ProtocolSSH, common.HostEventLimitExceeded)
  3254. hosts, err = common.GetDefenderHosts()
  3255. assert.NoError(t, err)
  3256. assert.Len(t, hosts, 1)
  3257. score, err := common.GetDefenderScore(testIP)
  3258. assert.NoError(t, err)
  3259. assert.Equal(t, 3, score)
  3260. banTime, err := common.GetDefenderBanTime(testIP)
  3261. assert.NoError(t, err)
  3262. assert.Nil(t, banTime)
  3263. err = dataprovider.Close()
  3264. assert.NoError(t, err)
  3265. common.AddDefenderEvent(testIP, common.ProtocolFTP, common.HostEventLimitExceeded)
  3266. _, err = common.GetDefenderHosts()
  3267. assert.Error(t, err)
  3268. _, err = common.GetDefenderHost(testIP)
  3269. assert.Error(t, err)
  3270. _, err = common.GetDefenderBanTime(testIP)
  3271. assert.Error(t, err)
  3272. _, err = common.GetDefenderScore(testIP)
  3273. assert.Error(t, err)
  3274. err = config.LoadConfig(configDir, "")
  3275. assert.NoError(t, err)
  3276. providerConf := config.GetProviderConf()
  3277. err = dataprovider.Initialize(providerConf, configDir, true)
  3278. assert.NoError(t, err)
  3279. err = dataprovider.CleanupDefender(util.GetTimeAsMsSinceEpoch(time.Now().Add(1 * time.Hour)))
  3280. assert.NoError(t, err)
  3281. common.Config = configCopy
  3282. err = common.Initialize(common.Config, 0)
  3283. assert.NoError(t, err)
  3284. }
  3285. func TestDelayedQuotaUpdater(t *testing.T) {
  3286. err := dataprovider.Close()
  3287. assert.NoError(t, err)
  3288. err = config.LoadConfig(configDir, "")
  3289. assert.NoError(t, err)
  3290. providerConf := config.GetProviderConf()
  3291. providerConf.DelayedQuotaUpdate = 120
  3292. err = dataprovider.Initialize(providerConf, configDir, true)
  3293. assert.NoError(t, err)
  3294. u := getTestUser()
  3295. u.QuotaFiles = 100
  3296. u.TotalDataTransfer = 2000
  3297. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  3298. assert.NoError(t, err)
  3299. err = dataprovider.UpdateUserQuota(&user, 10, 6000, false)
  3300. assert.NoError(t, err)
  3301. err = dataprovider.UpdateUserTransferQuota(&user, 100, 200, false)
  3302. assert.NoError(t, err)
  3303. files, size, ulSize, dlSize, err := dataprovider.GetUsedQuota(user.Username)
  3304. assert.NoError(t, err)
  3305. assert.Equal(t, 10, files)
  3306. assert.Equal(t, int64(6000), size)
  3307. assert.Equal(t, int64(100), ulSize)
  3308. assert.Equal(t, int64(200), dlSize)
  3309. userGet, err := dataprovider.UserExists(user.Username, "")
  3310. assert.NoError(t, err)
  3311. assert.Equal(t, 0, userGet.UsedQuotaFiles)
  3312. assert.Equal(t, int64(0), userGet.UsedQuotaSize)
  3313. assert.Equal(t, int64(0), userGet.UsedUploadDataTransfer)
  3314. assert.Equal(t, int64(0), userGet.UsedDownloadDataTransfer)
  3315. err = dataprovider.UpdateUserQuota(&user, 10, 6000, true)
  3316. assert.NoError(t, err)
  3317. err = dataprovider.UpdateUserTransferQuota(&user, 100, 200, true)
  3318. assert.NoError(t, err)
  3319. files, size, ulSize, dlSize, err = dataprovider.GetUsedQuota(user.Username)
  3320. assert.NoError(t, err)
  3321. assert.Equal(t, 10, files)
  3322. assert.Equal(t, int64(6000), size)
  3323. assert.Equal(t, int64(100), ulSize)
  3324. assert.Equal(t, int64(200), dlSize)
  3325. userGet, err = dataprovider.UserExists(user.Username, "")
  3326. assert.NoError(t, err)
  3327. assert.Equal(t, 10, userGet.UsedQuotaFiles)
  3328. assert.Equal(t, int64(6000), userGet.UsedQuotaSize)
  3329. assert.Equal(t, int64(100), userGet.UsedUploadDataTransfer)
  3330. assert.Equal(t, int64(200), userGet.UsedDownloadDataTransfer)
  3331. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  3332. assert.NoError(t, err)
  3333. err = os.RemoveAll(user.GetHomeDir())
  3334. assert.NoError(t, err)
  3335. folder := vfs.BaseVirtualFolder{
  3336. Name: "folder",
  3337. MappedPath: filepath.Join(os.TempDir(), "p"),
  3338. }
  3339. err = dataprovider.AddFolder(&folder, "", "", "")
  3340. assert.NoError(t, err)
  3341. err = dataprovider.UpdateVirtualFolderQuota(&folder, 10, 6000, false)
  3342. assert.NoError(t, err)
  3343. files, size, err = dataprovider.GetUsedVirtualFolderQuota(folder.Name)
  3344. assert.NoError(t, err)
  3345. assert.Equal(t, 10, files)
  3346. assert.Equal(t, int64(6000), size)
  3347. folderGet, err := dataprovider.GetFolderByName(folder.Name)
  3348. assert.NoError(t, err)
  3349. assert.Equal(t, 0, folderGet.UsedQuotaFiles)
  3350. assert.Equal(t, int64(0), folderGet.UsedQuotaSize)
  3351. err = dataprovider.UpdateVirtualFolderQuota(&folder, 10, 6000, true)
  3352. assert.NoError(t, err)
  3353. files, size, err = dataprovider.GetUsedVirtualFolderQuota(folder.Name)
  3354. assert.NoError(t, err)
  3355. assert.Equal(t, 10, files)
  3356. assert.Equal(t, int64(6000), size)
  3357. folderGet, err = dataprovider.GetFolderByName(folder.Name)
  3358. assert.NoError(t, err)
  3359. assert.Equal(t, 10, folderGet.UsedQuotaFiles)
  3360. assert.Equal(t, int64(6000), folderGet.UsedQuotaSize)
  3361. err = dataprovider.DeleteFolder(folder.Name, "", "", "")
  3362. assert.NoError(t, err)
  3363. err = dataprovider.Close()
  3364. assert.NoError(t, err)
  3365. err = config.LoadConfig(configDir, "")
  3366. assert.NoError(t, err)
  3367. providerConf = config.GetProviderConf()
  3368. err = dataprovider.Initialize(providerConf, configDir, true)
  3369. assert.NoError(t, err)
  3370. }
  3371. func TestPasswordCaching(t *testing.T) {
  3372. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  3373. assert.NoError(t, err)
  3374. dbUser, err := dataprovider.UserExists(user.Username, "")
  3375. assert.NoError(t, err)
  3376. found, match := dataprovider.CheckCachedUserPassword(user.Username, defaultPassword, dbUser.Password)
  3377. assert.False(t, found)
  3378. assert.False(t, match)
  3379. user.Password = "wrong"
  3380. _, _, err = getSftpClient(user)
  3381. assert.Error(t, err)
  3382. found, match = dataprovider.CheckCachedUserPassword(user.Username, defaultPassword, dbUser.Password)
  3383. assert.False(t, found)
  3384. assert.False(t, match)
  3385. user.Password = ""
  3386. conn, client, err := getSftpClient(user)
  3387. if assert.NoError(t, err) {
  3388. defer conn.Close()
  3389. defer client.Close()
  3390. err = checkBasicSFTP(client)
  3391. assert.NoError(t, err)
  3392. }
  3393. found, match = dataprovider.CheckCachedUserPassword(user.Username, defaultPassword, dbUser.Password)
  3394. assert.True(t, found)
  3395. assert.True(t, match)
  3396. found, match = dataprovider.CheckCachedUserPassword(user.Username, defaultPassword+"_", dbUser.Password)
  3397. assert.True(t, found)
  3398. assert.False(t, match)
  3399. found, match = dataprovider.CheckCachedUserPassword(user.Username+"_", defaultPassword, dbUser.Password)
  3400. assert.False(t, found)
  3401. assert.False(t, match)
  3402. user, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  3403. assert.NoError(t, err)
  3404. // the password was not changed
  3405. found, match = dataprovider.CheckCachedUserPassword(user.Username, defaultPassword, dbUser.Password)
  3406. assert.True(t, found)
  3407. assert.True(t, match)
  3408. // the password hash will change
  3409. user.Password = defaultPassword
  3410. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  3411. assert.NoError(t, err)
  3412. dbUser, err = dataprovider.UserExists(user.Username, "")
  3413. assert.NoError(t, err)
  3414. found, match = dataprovider.CheckCachedUserPassword(user.Username, defaultPassword, dbUser.Password)
  3415. assert.False(t, found)
  3416. assert.False(t, match)
  3417. conn, client, err = getSftpClient(user)
  3418. if assert.NoError(t, err) {
  3419. defer conn.Close()
  3420. defer client.Close()
  3421. err = checkBasicSFTP(client)
  3422. assert.NoError(t, err)
  3423. }
  3424. found, match = dataprovider.CheckCachedUserPassword(user.Username, defaultPassword, dbUser.Password)
  3425. assert.True(t, found)
  3426. assert.True(t, match)
  3427. //change password
  3428. newPassword := defaultPassword + "mod"
  3429. user.Password = newPassword
  3430. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  3431. assert.NoError(t, err)
  3432. dbUser, err = dataprovider.UserExists(user.Username, "")
  3433. assert.NoError(t, err)
  3434. found, match = dataprovider.CheckCachedUserPassword(user.Username, newPassword, dbUser.Password)
  3435. assert.False(t, found)
  3436. assert.False(t, match)
  3437. conn, client, err = getSftpClient(user)
  3438. if assert.NoError(t, err) {
  3439. defer conn.Close()
  3440. defer client.Close()
  3441. err = checkBasicSFTP(client)
  3442. assert.NoError(t, err)
  3443. }
  3444. found, match = dataprovider.CheckCachedUserPassword(user.Username, defaultPassword, dbUser.Password)
  3445. assert.True(t, found)
  3446. assert.False(t, match)
  3447. found, match = dataprovider.CheckCachedUserPassword(user.Username, newPassword, dbUser.Password)
  3448. assert.True(t, found)
  3449. assert.True(t, match)
  3450. // update the password
  3451. err = dataprovider.UpdateUserPassword(user.Username, defaultPassword, "", "", "")
  3452. assert.NoError(t, err)
  3453. dbUser, err = dataprovider.UserExists(user.Username, "")
  3454. assert.NoError(t, err)
  3455. // the stored hash does not match
  3456. found, match = dataprovider.CheckCachedUserPassword(user.Username, defaultPassword, dbUser.Password)
  3457. assert.False(t, found)
  3458. assert.False(t, match)
  3459. user.Password = defaultPassword
  3460. conn, client, err = getSftpClient(user)
  3461. if assert.NoError(t, err) {
  3462. defer conn.Close()
  3463. defer client.Close()
  3464. err = checkBasicSFTP(client)
  3465. assert.NoError(t, err)
  3466. }
  3467. found, match = dataprovider.CheckCachedUserPassword(user.Username, defaultPassword, dbUser.Password)
  3468. assert.True(t, found)
  3469. assert.True(t, match)
  3470. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  3471. assert.NoError(t, err)
  3472. err = os.RemoveAll(user.GetHomeDir())
  3473. assert.NoError(t, err)
  3474. found, match = dataprovider.CheckCachedUserPassword(user.Username, defaultPassword, dbUser.Password)
  3475. assert.False(t, found)
  3476. assert.False(t, match)
  3477. }
  3478. func TestEventRule(t *testing.T) {
  3479. if runtime.GOOS == osWindows {
  3480. t.Skip("this test is not available on Windows")
  3481. }
  3482. smtpCfg := smtp.Config{
  3483. Host: "127.0.0.1",
  3484. Port: 2525,
  3485. From: "notification@example.com",
  3486. TemplatesPath: "templates",
  3487. }
  3488. err := smtpCfg.Initialize(configDir, true)
  3489. require.NoError(t, err)
  3490. a1 := dataprovider.BaseEventAction{
  3491. Name: "action1",
  3492. Type: dataprovider.ActionTypeHTTP,
  3493. Options: dataprovider.BaseEventActionOptions{
  3494. HTTPConfig: dataprovider.EventActionHTTPConfig{
  3495. Endpoint: "http://localhost",
  3496. Timeout: 20,
  3497. Method: http.MethodGet,
  3498. },
  3499. },
  3500. }
  3501. a2 := dataprovider.BaseEventAction{
  3502. Name: "action2",
  3503. Type: dataprovider.ActionTypeBackup,
  3504. }
  3505. a3 := dataprovider.BaseEventAction{
  3506. Name: "action3",
  3507. Type: dataprovider.ActionTypeEmail,
  3508. Options: dataprovider.BaseEventActionOptions{
  3509. EmailConfig: dataprovider.EventActionEmailConfig{
  3510. Recipients: []string{"test1@example.com", "test2@example.com"},
  3511. Bcc: []string{"test3@example.com"},
  3512. Subject: `New "{{Event}}" from "{{Name}}" status {{StatusString}}`,
  3513. Body: "Fs path {{FsPath}}, size: {{FileSize}}, protocol: {{Protocol}}, IP: {{IP}} Data: {{ObjectData}} {{ErrorString}}",
  3514. },
  3515. },
  3516. }
  3517. a4 := dataprovider.BaseEventAction{
  3518. Name: "action4",
  3519. Type: dataprovider.ActionTypeEmail,
  3520. Options: dataprovider.BaseEventActionOptions{
  3521. EmailConfig: dataprovider.EventActionEmailConfig{
  3522. Recipients: []string{"failure@example.com"},
  3523. Subject: `Failed "{{Event}}" from "{{Name}}"`,
  3524. Body: "Fs path {{FsPath}}, protocol: {{Protocol}}, IP: {{IP}} {{ErrorString}}",
  3525. },
  3526. },
  3527. }
  3528. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  3529. assert.NoError(t, err)
  3530. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  3531. assert.NoError(t, err)
  3532. action3, _, err := httpdtest.AddEventAction(a3, http.StatusCreated)
  3533. assert.NoError(t, err)
  3534. action4, _, err := httpdtest.AddEventAction(a4, http.StatusCreated)
  3535. assert.NoError(t, err)
  3536. r1 := dataprovider.EventRule{
  3537. Name: "test rule1",
  3538. Status: 1,
  3539. Trigger: dataprovider.EventTriggerFsEvent,
  3540. Conditions: dataprovider.EventConditions{
  3541. FsEvents: []string{"upload"},
  3542. Options: dataprovider.ConditionOptions{
  3543. FsPaths: []dataprovider.ConditionPattern{
  3544. {
  3545. Pattern: "/subdir/*.dat",
  3546. },
  3547. {
  3548. Pattern: "/**/*.txt",
  3549. },
  3550. },
  3551. },
  3552. },
  3553. Actions: []dataprovider.EventAction{
  3554. {
  3555. BaseEventAction: dataprovider.BaseEventAction{
  3556. Name: action1.Name,
  3557. },
  3558. Order: 1,
  3559. Options: dataprovider.EventActionOptions{
  3560. ExecuteSync: true,
  3561. StopOnFailure: true,
  3562. },
  3563. },
  3564. {
  3565. BaseEventAction: dataprovider.BaseEventAction{
  3566. Name: action2.Name,
  3567. },
  3568. Order: 2,
  3569. },
  3570. {
  3571. BaseEventAction: dataprovider.BaseEventAction{
  3572. Name: action3.Name,
  3573. },
  3574. Order: 3,
  3575. },
  3576. {
  3577. BaseEventAction: dataprovider.BaseEventAction{
  3578. Name: action4.Name,
  3579. },
  3580. Order: 4,
  3581. Options: dataprovider.EventActionOptions{
  3582. IsFailureAction: true,
  3583. },
  3584. },
  3585. },
  3586. }
  3587. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  3588. assert.NoError(t, err)
  3589. r2 := dataprovider.EventRule{
  3590. Name: "test rule2",
  3591. Status: 1,
  3592. Trigger: dataprovider.EventTriggerFsEvent,
  3593. Conditions: dataprovider.EventConditions{
  3594. FsEvents: []string{"download"},
  3595. Options: dataprovider.ConditionOptions{
  3596. FsPaths: []dataprovider.ConditionPattern{
  3597. {
  3598. Pattern: "/**/*.dat",
  3599. },
  3600. },
  3601. },
  3602. },
  3603. Actions: []dataprovider.EventAction{
  3604. {
  3605. BaseEventAction: dataprovider.BaseEventAction{
  3606. Name: action3.Name,
  3607. },
  3608. Order: 1,
  3609. },
  3610. {
  3611. BaseEventAction: dataprovider.BaseEventAction{
  3612. Name: action4.Name,
  3613. },
  3614. Order: 2,
  3615. Options: dataprovider.EventActionOptions{
  3616. IsFailureAction: true,
  3617. },
  3618. },
  3619. },
  3620. }
  3621. rule2, _, err := httpdtest.AddEventRule(r2, http.StatusCreated)
  3622. assert.NoError(t, err)
  3623. r3 := dataprovider.EventRule{
  3624. Name: "test rule3",
  3625. Status: 1,
  3626. Trigger: dataprovider.EventTriggerProviderEvent,
  3627. Conditions: dataprovider.EventConditions{
  3628. ProviderEvents: []string{"delete"},
  3629. },
  3630. Actions: []dataprovider.EventAction{
  3631. {
  3632. BaseEventAction: dataprovider.BaseEventAction{
  3633. Name: action3.Name,
  3634. },
  3635. Order: 1,
  3636. },
  3637. },
  3638. }
  3639. rule3, _, err := httpdtest.AddEventRule(r3, http.StatusCreated)
  3640. assert.NoError(t, err)
  3641. uploadScriptPath := filepath.Join(os.TempDir(), "upload.sh")
  3642. u := getTestUser()
  3643. u.DownloadDataTransfer = 1
  3644. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  3645. assert.NoError(t, err)
  3646. movedFileName := "moved.dat"
  3647. movedPath := filepath.Join(user.HomeDir, movedFileName)
  3648. err = os.WriteFile(uploadScriptPath, getUploadScriptContent(movedPath, "", 0), 0755)
  3649. assert.NoError(t, err)
  3650. action1.Type = dataprovider.ActionTypeCommand
  3651. action1.Options = dataprovider.BaseEventActionOptions{
  3652. CmdConfig: dataprovider.EventActionCommandConfig{
  3653. Cmd: uploadScriptPath,
  3654. Timeout: 10,
  3655. EnvVars: []dataprovider.KeyValue{
  3656. {
  3657. Key: "SFTPGO_ACTION_PATH",
  3658. Value: "{{FsPath}}",
  3659. },
  3660. {
  3661. Key: "CUSTOM_ENV_VAR",
  3662. Value: "value",
  3663. },
  3664. },
  3665. },
  3666. }
  3667. action1, _, err = httpdtest.UpdateEventAction(action1, http.StatusOK)
  3668. assert.NoError(t, err)
  3669. dirName := "subdir"
  3670. conn, client, err := getSftpClient(user)
  3671. if assert.NoError(t, err) {
  3672. defer conn.Close()
  3673. defer client.Close()
  3674. size := int64(32768)
  3675. // rule conditions does not match
  3676. err = writeSFTPFileNoCheck(testFileName, size, client)
  3677. assert.NoError(t, err)
  3678. info, err := client.Stat(testFileName)
  3679. if assert.NoError(t, err) {
  3680. assert.Equal(t, size, info.Size())
  3681. }
  3682. err = client.Mkdir(dirName)
  3683. assert.NoError(t, err)
  3684. err = client.Mkdir("subdir1")
  3685. assert.NoError(t, err)
  3686. // rule conditions match
  3687. lastReceivedEmail.reset()
  3688. err = writeSFTPFileNoCheck(path.Join(dirName, testFileName), size, client)
  3689. assert.NoError(t, err)
  3690. _, err = client.Stat(path.Join(dirName, testFileName))
  3691. assert.Error(t, err)
  3692. info, err = client.Stat(movedFileName)
  3693. if assert.NoError(t, err) {
  3694. assert.Equal(t, size, info.Size())
  3695. }
  3696. assert.Eventually(t, func() bool {
  3697. return lastReceivedEmail.get().From != ""
  3698. }, 3000*time.Millisecond, 100*time.Millisecond)
  3699. email := lastReceivedEmail.get()
  3700. assert.Len(t, email.To, 3)
  3701. assert.True(t, util.Contains(email.To, "test1@example.com"))
  3702. assert.True(t, util.Contains(email.To, "test2@example.com"))
  3703. assert.True(t, util.Contains(email.To, "test3@example.com"))
  3704. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: New "upload" from "%s" status OK`, user.Username))
  3705. // test the failure action, we download a file that exceeds the transfer quota limit
  3706. err = writeSFTPFileNoCheck(path.Join("subdir1", testFileName), 1*1024*1024+65535, client)
  3707. assert.NoError(t, err)
  3708. lastReceivedEmail.reset()
  3709. f, err := client.Open(path.Join("subdir1", testFileName))
  3710. assert.NoError(t, err)
  3711. _, err = io.ReadAll(f)
  3712. if assert.Error(t, err) {
  3713. assert.Contains(t, err.Error(), common.ErrReadQuotaExceeded.Error())
  3714. }
  3715. err = f.Close()
  3716. assert.Error(t, err)
  3717. assert.Eventually(t, func() bool {
  3718. return lastReceivedEmail.get().From != ""
  3719. }, 3000*time.Millisecond, 100*time.Millisecond)
  3720. email = lastReceivedEmail.get()
  3721. assert.Len(t, email.To, 3)
  3722. assert.True(t, util.Contains(email.To, "test1@example.com"))
  3723. assert.True(t, util.Contains(email.To, "test2@example.com"))
  3724. assert.True(t, util.Contains(email.To, "test3@example.com"))
  3725. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: New "download" from "%s" status KO`, user.Username))
  3726. assert.Contains(t, email.Data, `"download" failed`)
  3727. assert.Contains(t, email.Data, common.ErrReadQuotaExceeded.Error())
  3728. _, err = httpdtest.UpdateTransferQuotaUsage(user, "", http.StatusOK)
  3729. assert.NoError(t, err)
  3730. // remove the upload script to test the failure action
  3731. err = os.Remove(uploadScriptPath)
  3732. assert.NoError(t, err)
  3733. lastReceivedEmail.reset()
  3734. err = writeSFTPFileNoCheck(path.Join(dirName, testFileName), size, client)
  3735. assert.Error(t, err)
  3736. assert.Eventually(t, func() bool {
  3737. return lastReceivedEmail.get().From != ""
  3738. }, 3000*time.Millisecond, 100*time.Millisecond)
  3739. email = lastReceivedEmail.get()
  3740. assert.Len(t, email.To, 1)
  3741. assert.True(t, util.Contains(email.To, "failure@example.com"))
  3742. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: Failed "upload" from "%s"`, user.Username))
  3743. assert.Contains(t, email.Data, fmt.Sprintf(`action %q failed`, action1.Name))
  3744. // now test the download rule
  3745. lastReceivedEmail.reset()
  3746. f, err = client.Open(movedFileName)
  3747. assert.NoError(t, err)
  3748. contents, err := io.ReadAll(f)
  3749. assert.NoError(t, err)
  3750. err = f.Close()
  3751. assert.NoError(t, err)
  3752. assert.Len(t, contents, int(size))
  3753. assert.Eventually(t, func() bool {
  3754. return lastReceivedEmail.get().From != ""
  3755. }, 3000*time.Millisecond, 100*time.Millisecond)
  3756. email = lastReceivedEmail.get()
  3757. assert.Len(t, email.To, 3)
  3758. assert.True(t, util.Contains(email.To, "test1@example.com"))
  3759. assert.True(t, util.Contains(email.To, "test2@example.com"))
  3760. assert.True(t, util.Contains(email.To, "test3@example.com"))
  3761. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: New "download" from "%s"`, user.Username))
  3762. }
  3763. // test upload action command with arguments
  3764. action1.Options.CmdConfig.Args = []string{"{{Event}}", "{{VirtualPath}}", "custom_arg"}
  3765. action1, _, err = httpdtest.UpdateEventAction(action1, http.StatusOK)
  3766. assert.NoError(t, err)
  3767. uploadLogFilePath := filepath.Join(os.TempDir(), "upload.log")
  3768. err = os.WriteFile(uploadScriptPath, getUploadScriptContent(movedPath, uploadLogFilePath, 0), 0755)
  3769. assert.NoError(t, err)
  3770. conn, client, err = getSftpClient(user)
  3771. if assert.NoError(t, err) {
  3772. defer conn.Close()
  3773. defer client.Close()
  3774. err = writeSFTPFileNoCheck(path.Join(dirName, testFileName), 123, client)
  3775. assert.NoError(t, err)
  3776. logContent, err := os.ReadFile(uploadLogFilePath)
  3777. assert.NoError(t, err)
  3778. assert.Equal(t, fmt.Sprintf("upload %s custom_arg", util.CleanPath(path.Join(dirName, testFileName))),
  3779. strings.TrimSpace(string(logContent)))
  3780. err = os.Remove(uploadLogFilePath)
  3781. assert.NoError(t, err)
  3782. lastReceivedEmail.reset()
  3783. assert.Eventually(t, func() bool {
  3784. return lastReceivedEmail.get().From != ""
  3785. }, 3000*time.Millisecond, 100*time.Millisecond)
  3786. }
  3787. lastReceivedEmail.reset()
  3788. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  3789. assert.NoError(t, err)
  3790. _, err = httpdtest.RemoveEventRule(rule2, http.StatusOK)
  3791. assert.NoError(t, err)
  3792. assert.Eventually(t, func() bool {
  3793. return lastReceivedEmail.get().From != ""
  3794. }, 3000*time.Millisecond, 100*time.Millisecond)
  3795. email := lastReceivedEmail.get()
  3796. assert.Len(t, email.To, 3)
  3797. assert.True(t, util.Contains(email.To, "test1@example.com"))
  3798. assert.True(t, util.Contains(email.To, "test2@example.com"))
  3799. assert.True(t, util.Contains(email.To, "test3@example.com"))
  3800. assert.Contains(t, email.Data, `Subject: New "delete" from "admin"`)
  3801. _, err = httpdtest.RemoveEventRule(rule3, http.StatusOK)
  3802. assert.NoError(t, err)
  3803. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  3804. assert.NoError(t, err)
  3805. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  3806. assert.NoError(t, err)
  3807. _, err = httpdtest.RemoveEventAction(action3, http.StatusOK)
  3808. assert.NoError(t, err)
  3809. _, err = httpdtest.RemoveEventAction(action4, http.StatusOK)
  3810. assert.NoError(t, err)
  3811. lastReceivedEmail.reset()
  3812. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  3813. assert.NoError(t, err)
  3814. err = os.RemoveAll(user.GetHomeDir())
  3815. assert.NoError(t, err)
  3816. smtpCfg = smtp.Config{}
  3817. err = smtpCfg.Initialize(configDir, true)
  3818. require.NoError(t, err)
  3819. }
  3820. func TestEventRuleProviderEvents(t *testing.T) {
  3821. if runtime.GOOS == osWindows {
  3822. t.Skip("this test is not available on Windows")
  3823. }
  3824. smtpCfg := smtp.Config{
  3825. Host: "127.0.0.1",
  3826. Port: 2525,
  3827. From: "notification@example.com",
  3828. TemplatesPath: "templates",
  3829. }
  3830. err := smtpCfg.Initialize(configDir, true)
  3831. require.NoError(t, err)
  3832. saveObjectScriptPath := filepath.Join(os.TempDir(), "provider.sh")
  3833. outPath := filepath.Join(os.TempDir(), "provider_out.json")
  3834. err = os.WriteFile(saveObjectScriptPath, getSaveProviderObjectScriptContent(outPath, 0), 0755)
  3835. assert.NoError(t, err)
  3836. a1 := dataprovider.BaseEventAction{
  3837. Name: "a1",
  3838. Type: dataprovider.ActionTypeCommand,
  3839. Options: dataprovider.BaseEventActionOptions{
  3840. CmdConfig: dataprovider.EventActionCommandConfig{
  3841. Cmd: saveObjectScriptPath,
  3842. Timeout: 10,
  3843. EnvVars: []dataprovider.KeyValue{
  3844. {
  3845. Key: "SFTPGO_OBJECT_DATA",
  3846. Value: "{{ObjectData}}",
  3847. },
  3848. },
  3849. },
  3850. },
  3851. }
  3852. a2 := dataprovider.BaseEventAction{
  3853. Name: "a2",
  3854. Type: dataprovider.ActionTypeEmail,
  3855. Options: dataprovider.BaseEventActionOptions{
  3856. EmailConfig: dataprovider.EventActionEmailConfig{
  3857. Recipients: []string{"test3@example.com"},
  3858. Subject: `New "{{Event}}" from "{{Name}}"`,
  3859. Body: "Object name: {{ObjectName}} object type: {{ObjectType}} Data: {{ObjectData}}",
  3860. },
  3861. },
  3862. }
  3863. a3 := dataprovider.BaseEventAction{
  3864. Name: "a3",
  3865. Type: dataprovider.ActionTypeEmail,
  3866. Options: dataprovider.BaseEventActionOptions{
  3867. EmailConfig: dataprovider.EventActionEmailConfig{
  3868. Recipients: []string{"failure@example.com"},
  3869. Subject: `Failed "{{Event}}" from "{{Name}}"`,
  3870. Body: "Object name: {{ObjectName}} object type: {{ObjectType}}, IP: {{IP}}",
  3871. },
  3872. },
  3873. }
  3874. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  3875. assert.NoError(t, err)
  3876. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  3877. assert.NoError(t, err)
  3878. action3, _, err := httpdtest.AddEventAction(a3, http.StatusCreated)
  3879. assert.NoError(t, err)
  3880. r := dataprovider.EventRule{
  3881. Name: "rule",
  3882. Status: 1,
  3883. Trigger: dataprovider.EventTriggerProviderEvent,
  3884. Conditions: dataprovider.EventConditions{
  3885. ProviderEvents: []string{"update"},
  3886. },
  3887. Actions: []dataprovider.EventAction{
  3888. {
  3889. BaseEventAction: dataprovider.BaseEventAction{
  3890. Name: action1.Name,
  3891. },
  3892. Order: 1,
  3893. Options: dataprovider.EventActionOptions{
  3894. StopOnFailure: true,
  3895. },
  3896. },
  3897. {
  3898. BaseEventAction: dataprovider.BaseEventAction{
  3899. Name: action2.Name,
  3900. },
  3901. Order: 2,
  3902. },
  3903. {
  3904. BaseEventAction: dataprovider.BaseEventAction{
  3905. Name: action3.Name,
  3906. },
  3907. Order: 3,
  3908. Options: dataprovider.EventActionOptions{
  3909. IsFailureAction: true,
  3910. StopOnFailure: true,
  3911. },
  3912. },
  3913. },
  3914. }
  3915. rule, _, err := httpdtest.AddEventRule(r, http.StatusCreated)
  3916. assert.NoError(t, err)
  3917. lastReceivedEmail.reset()
  3918. // create and update a folder to trigger the rule
  3919. folder := vfs.BaseVirtualFolder{
  3920. Name: "ftest rule",
  3921. MappedPath: filepath.Join(os.TempDir(), "p"),
  3922. }
  3923. folder, _, err = httpdtest.AddFolder(folder, http.StatusCreated)
  3924. assert.NoError(t, err)
  3925. // no action is triggered on add
  3926. assert.NoFileExists(t, outPath)
  3927. // update the folder
  3928. _, _, err = httpdtest.UpdateFolder(folder, http.StatusOK)
  3929. assert.NoError(t, err)
  3930. if assert.Eventually(t, func() bool {
  3931. _, err := os.Stat(outPath)
  3932. return err == nil
  3933. }, 2*time.Second, 100*time.Millisecond) {
  3934. content, err := os.ReadFile(outPath)
  3935. assert.NoError(t, err)
  3936. var folderGet vfs.BaseVirtualFolder
  3937. err = json.Unmarshal(content, &folderGet)
  3938. assert.NoError(t, err)
  3939. assert.Equal(t, folder, folderGet)
  3940. err = os.Remove(outPath)
  3941. assert.NoError(t, err)
  3942. assert.Eventually(t, func() bool {
  3943. return lastReceivedEmail.get().From != ""
  3944. }, 3000*time.Millisecond, 100*time.Millisecond)
  3945. email := lastReceivedEmail.get()
  3946. assert.Len(t, email.To, 1)
  3947. assert.True(t, util.Contains(email.To, "test3@example.com"))
  3948. assert.Contains(t, email.Data, `Subject: New "update" from "admin"`)
  3949. }
  3950. // now delete the script to generate an error
  3951. lastReceivedEmail.reset()
  3952. err = os.Remove(saveObjectScriptPath)
  3953. assert.NoError(t, err)
  3954. _, _, err = httpdtest.UpdateFolder(folder, http.StatusOK)
  3955. assert.NoError(t, err)
  3956. assert.NoFileExists(t, outPath)
  3957. assert.Eventually(t, func() bool {
  3958. return lastReceivedEmail.get().From != ""
  3959. }, 3000*time.Millisecond, 100*time.Millisecond)
  3960. email := lastReceivedEmail.get()
  3961. assert.Len(t, email.To, 1)
  3962. assert.True(t, util.Contains(email.To, "failure@example.com"))
  3963. assert.Contains(t, email.Data, `Subject: Failed "update" from "admin"`)
  3964. assert.Contains(t, email.Data, fmt.Sprintf("Object name: %s object type: folder", folder.Name))
  3965. lastReceivedEmail.reset()
  3966. // generate an error for the failure action
  3967. smtpCfg = smtp.Config{}
  3968. err = smtpCfg.Initialize(configDir, true)
  3969. require.NoError(t, err)
  3970. _, _, err = httpdtest.UpdateFolder(folder, http.StatusOK)
  3971. assert.NoError(t, err)
  3972. assert.NoFileExists(t, outPath)
  3973. email = lastReceivedEmail.get()
  3974. assert.Len(t, email.To, 0)
  3975. _, err = httpdtest.RemoveFolder(folder, http.StatusOK)
  3976. assert.NoError(t, err)
  3977. _, err = httpdtest.RemoveEventRule(rule, http.StatusOK)
  3978. assert.NoError(t, err)
  3979. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  3980. assert.NoError(t, err)
  3981. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  3982. assert.NoError(t, err)
  3983. _, err = httpdtest.RemoveEventAction(action3, http.StatusOK)
  3984. assert.NoError(t, err)
  3985. }
  3986. func TestEventRuleFsActions(t *testing.T) {
  3987. dirsToCreate := []string{
  3988. "/basedir/1",
  3989. "/basedir/sub/2",
  3990. "/basedir/3",
  3991. }
  3992. a1 := dataprovider.BaseEventAction{
  3993. Name: "a1",
  3994. Type: dataprovider.ActionTypeFilesystem,
  3995. Options: dataprovider.BaseEventActionOptions{
  3996. FsConfig: dataprovider.EventActionFilesystemConfig{
  3997. Type: dataprovider.FilesystemActionMkdirs,
  3998. MkDirs: dirsToCreate,
  3999. },
  4000. },
  4001. }
  4002. a2 := dataprovider.BaseEventAction{
  4003. Name: "a2",
  4004. Type: dataprovider.ActionTypeFilesystem,
  4005. Options: dataprovider.BaseEventActionOptions{
  4006. FsConfig: dataprovider.EventActionFilesystemConfig{
  4007. Type: dataprovider.FilesystemActionRename,
  4008. Renames: []dataprovider.KeyValue{
  4009. {
  4010. Key: "/{{VirtualDirPath}}/{{ObjectName}}",
  4011. Value: "/{{ObjectName}}_renamed",
  4012. },
  4013. },
  4014. },
  4015. },
  4016. }
  4017. a3 := dataprovider.BaseEventAction{
  4018. Name: "a3",
  4019. Type: dataprovider.ActionTypeFilesystem,
  4020. Options: dataprovider.BaseEventActionOptions{
  4021. FsConfig: dataprovider.EventActionFilesystemConfig{
  4022. Type: dataprovider.FilesystemActionDelete,
  4023. Deletes: []string{"/{{ObjectName}}_renamed"},
  4024. },
  4025. },
  4026. }
  4027. a4 := dataprovider.BaseEventAction{
  4028. Name: "a4",
  4029. Type: dataprovider.ActionTypeFolderQuotaReset,
  4030. }
  4031. a5 := dataprovider.BaseEventAction{
  4032. Name: "a5",
  4033. Type: dataprovider.ActionTypeUserQuotaReset,
  4034. }
  4035. a6 := dataprovider.BaseEventAction{
  4036. Name: "a6",
  4037. Type: dataprovider.ActionTypeFilesystem,
  4038. Options: dataprovider.BaseEventActionOptions{
  4039. FsConfig: dataprovider.EventActionFilesystemConfig{
  4040. Type: dataprovider.FilesystemActionExist,
  4041. Exist: []string{"/{{VirtualPath}}"},
  4042. },
  4043. },
  4044. }
  4045. action1, resp, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  4046. assert.NoError(t, err, string(resp))
  4047. action2, resp, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  4048. assert.NoError(t, err, string(resp))
  4049. action3, resp, err := httpdtest.AddEventAction(a3, http.StatusCreated)
  4050. assert.NoError(t, err, string(resp))
  4051. action4, resp, err := httpdtest.AddEventAction(a4, http.StatusCreated)
  4052. assert.NoError(t, err, string(resp))
  4053. action5, resp, err := httpdtest.AddEventAction(a5, http.StatusCreated)
  4054. assert.NoError(t, err, string(resp))
  4055. action6, resp, err := httpdtest.AddEventAction(a6, http.StatusCreated)
  4056. assert.NoError(t, err, string(resp))
  4057. r1 := dataprovider.EventRule{
  4058. Name: "r1",
  4059. Status: 1,
  4060. Trigger: dataprovider.EventTriggerProviderEvent,
  4061. Conditions: dataprovider.EventConditions{
  4062. ProviderEvents: []string{"add"},
  4063. },
  4064. Actions: []dataprovider.EventAction{
  4065. {
  4066. BaseEventAction: dataprovider.BaseEventAction{
  4067. Name: action1.Name,
  4068. },
  4069. Order: 1,
  4070. },
  4071. },
  4072. }
  4073. r2 := dataprovider.EventRule{
  4074. Name: "r2",
  4075. Status: 1,
  4076. Trigger: dataprovider.EventTriggerFsEvent,
  4077. Conditions: dataprovider.EventConditions{
  4078. FsEvents: []string{"upload"},
  4079. },
  4080. Actions: []dataprovider.EventAction{
  4081. {
  4082. BaseEventAction: dataprovider.BaseEventAction{
  4083. Name: action2.Name,
  4084. },
  4085. Order: 1,
  4086. Options: dataprovider.EventActionOptions{
  4087. ExecuteSync: true,
  4088. },
  4089. },
  4090. {
  4091. BaseEventAction: dataprovider.BaseEventAction{
  4092. Name: action5.Name,
  4093. },
  4094. Order: 2,
  4095. },
  4096. },
  4097. }
  4098. r3 := dataprovider.EventRule{
  4099. Name: "r3",
  4100. Status: 1,
  4101. Trigger: dataprovider.EventTriggerFsEvent,
  4102. Conditions: dataprovider.EventConditions{
  4103. FsEvents: []string{"mkdir"},
  4104. },
  4105. Actions: []dataprovider.EventAction{
  4106. {
  4107. BaseEventAction: dataprovider.BaseEventAction{
  4108. Name: action3.Name,
  4109. },
  4110. Order: 1,
  4111. },
  4112. {
  4113. BaseEventAction: dataprovider.BaseEventAction{
  4114. Name: action6.Name,
  4115. },
  4116. Order: 2,
  4117. },
  4118. },
  4119. }
  4120. r4 := dataprovider.EventRule{
  4121. Name: "r4",
  4122. Status: 1,
  4123. Trigger: dataprovider.EventTriggerFsEvent,
  4124. Conditions: dataprovider.EventConditions{
  4125. FsEvents: []string{"rmdir"},
  4126. },
  4127. Actions: []dataprovider.EventAction{
  4128. {
  4129. BaseEventAction: dataprovider.BaseEventAction{
  4130. Name: action4.Name,
  4131. },
  4132. Order: 1,
  4133. },
  4134. },
  4135. }
  4136. r5 := dataprovider.EventRule{
  4137. Name: "r5",
  4138. Status: 1,
  4139. Trigger: dataprovider.EventTriggerProviderEvent,
  4140. Conditions: dataprovider.EventConditions{
  4141. ProviderEvents: []string{"add"},
  4142. },
  4143. Actions: []dataprovider.EventAction{
  4144. {
  4145. BaseEventAction: dataprovider.BaseEventAction{
  4146. Name: action4.Name,
  4147. },
  4148. Order: 1,
  4149. },
  4150. },
  4151. }
  4152. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  4153. assert.NoError(t, err)
  4154. rule2, _, err := httpdtest.AddEventRule(r2, http.StatusCreated)
  4155. assert.NoError(t, err)
  4156. rule3, _, err := httpdtest.AddEventRule(r3, http.StatusCreated)
  4157. assert.NoError(t, err)
  4158. rule4, _, err := httpdtest.AddEventRule(r4, http.StatusCreated)
  4159. assert.NoError(t, err)
  4160. rule5, _, err := httpdtest.AddEventRule(r5, http.StatusCreated)
  4161. assert.NoError(t, err)
  4162. folderMappedPath := filepath.Join(os.TempDir(), "folder")
  4163. err = os.MkdirAll(folderMappedPath, os.ModePerm)
  4164. assert.NoError(t, err)
  4165. err = os.WriteFile(filepath.Join(folderMappedPath, "file.txt"), []byte("1"), 0666)
  4166. assert.NoError(t, err)
  4167. folder, _, err := httpdtest.AddFolder(vfs.BaseVirtualFolder{
  4168. Name: "test folder",
  4169. MappedPath: folderMappedPath,
  4170. }, http.StatusCreated)
  4171. assert.NoError(t, err)
  4172. assert.Eventually(t, func() bool {
  4173. folderGet, _, err := httpdtest.GetFolderByName(folder.Name, http.StatusOK)
  4174. if err != nil {
  4175. return false
  4176. }
  4177. return folderGet.UsedQuotaFiles == 1 && folderGet.UsedQuotaSize == 1
  4178. }, 2*time.Second, 100*time.Millisecond)
  4179. u := getTestUser()
  4180. u.Filters.DisableFsChecks = true
  4181. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  4182. assert.NoError(t, err)
  4183. conn, client, err := getSftpClient(user)
  4184. if assert.NoError(t, err) {
  4185. defer conn.Close()
  4186. defer client.Close()
  4187. // check initial directories creation
  4188. for _, dir := range dirsToCreate {
  4189. assert.Eventually(t, func() bool {
  4190. _, err := client.Stat(dir)
  4191. return err == nil
  4192. }, 2*time.Second, 100*time.Millisecond)
  4193. }
  4194. // upload a file and check the sync rename
  4195. size := int64(32768)
  4196. err = writeSFTPFileNoCheck(path.Join("basedir", testFileName), size, client)
  4197. assert.NoError(t, err)
  4198. _, err = client.Stat(path.Join("basedir", testFileName))
  4199. assert.Error(t, err)
  4200. info, err := client.Stat(testFileName + "_renamed") //nolint:goconst
  4201. if assert.NoError(t, err) {
  4202. assert.Equal(t, size, info.Size())
  4203. }
  4204. assert.NoError(t, err)
  4205. assert.Eventually(t, func() bool {
  4206. userGet, _, err := httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  4207. if err != nil {
  4208. return false
  4209. }
  4210. return userGet.UsedQuotaFiles == 1 && userGet.UsedQuotaSize == size
  4211. }, 2*time.Second, 100*time.Millisecond)
  4212. for i := 0; i < 2; i++ {
  4213. err = client.Mkdir(testFileName)
  4214. assert.NoError(t, err)
  4215. assert.Eventually(t, func() bool {
  4216. _, err = client.Stat(testFileName + "_renamed")
  4217. return err != nil
  4218. }, 2*time.Second, 100*time.Millisecond)
  4219. err = client.RemoveDirectory(testFileName)
  4220. assert.NoError(t, err)
  4221. }
  4222. err = client.Mkdir(testFileName + "_renamed")
  4223. assert.NoError(t, err)
  4224. err = client.Mkdir(testFileName)
  4225. assert.NoError(t, err)
  4226. assert.Eventually(t, func() bool {
  4227. _, err = client.Stat(testFileName + "_renamed")
  4228. return err != nil
  4229. }, 2*time.Second, 100*time.Millisecond)
  4230. }
  4231. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  4232. assert.NoError(t, err)
  4233. err = os.RemoveAll(user.GetHomeDir())
  4234. assert.NoError(t, err)
  4235. _, err = httpdtest.RemoveFolder(folder, http.StatusOK)
  4236. assert.NoError(t, err)
  4237. err = os.RemoveAll(folderMappedPath)
  4238. assert.NoError(t, err)
  4239. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  4240. assert.NoError(t, err)
  4241. _, err = httpdtest.RemoveEventRule(rule2, http.StatusOK)
  4242. assert.NoError(t, err)
  4243. _, err = httpdtest.RemoveEventRule(rule3, http.StatusOK)
  4244. assert.NoError(t, err)
  4245. _, err = httpdtest.RemoveEventRule(rule4, http.StatusOK)
  4246. assert.NoError(t, err)
  4247. _, err = httpdtest.RemoveEventRule(rule5, http.StatusOK)
  4248. assert.NoError(t, err)
  4249. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  4250. assert.NoError(t, err)
  4251. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  4252. assert.NoError(t, err)
  4253. _, err = httpdtest.RemoveEventAction(action3, http.StatusOK)
  4254. assert.NoError(t, err)
  4255. _, err = httpdtest.RemoveEventAction(action4, http.StatusOK)
  4256. assert.NoError(t, err)
  4257. _, err = httpdtest.RemoveEventAction(action5, http.StatusOK)
  4258. assert.NoError(t, err)
  4259. _, err = httpdtest.RemoveEventAction(action6, http.StatusOK)
  4260. assert.NoError(t, err)
  4261. }
  4262. func TestUploadEventRule(t *testing.T) {
  4263. smtpCfg := smtp.Config{
  4264. Host: "127.0.0.1",
  4265. Port: 2525,
  4266. From: "notification@example.com",
  4267. TemplatesPath: "templates",
  4268. }
  4269. err := smtpCfg.Initialize(configDir, true)
  4270. require.NoError(t, err)
  4271. a1 := dataprovider.BaseEventAction{
  4272. Name: "action1",
  4273. Type: dataprovider.ActionTypeEmail,
  4274. Options: dataprovider.BaseEventActionOptions{
  4275. EmailConfig: dataprovider.EventActionEmailConfig{
  4276. Recipients: []string{"test1@example.com"},
  4277. Subject: `New "{{Event}}" from "{{Name}}" status {{StatusString}}`,
  4278. Body: "Fs path {{FsPath}}, size: {{FileSize}}, protocol: {{Protocol}}, IP: {{IP}} Data: {{ObjectData}} {{ErrorString}}",
  4279. },
  4280. },
  4281. }
  4282. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  4283. assert.NoError(t, err)
  4284. r1 := dataprovider.EventRule{
  4285. Name: "test rule1",
  4286. Status: 1,
  4287. Trigger: dataprovider.EventTriggerFsEvent,
  4288. Conditions: dataprovider.EventConditions{
  4289. FsEvents: []string{"upload"},
  4290. Options: dataprovider.ConditionOptions{
  4291. FsPaths: []dataprovider.ConditionPattern{
  4292. {
  4293. Pattern: "/**/*.filepart",
  4294. InverseMatch: true,
  4295. },
  4296. },
  4297. },
  4298. },
  4299. Actions: []dataprovider.EventAction{
  4300. {
  4301. BaseEventAction: dataprovider.BaseEventAction{
  4302. Name: action1.Name,
  4303. },
  4304. Order: 1,
  4305. Options: dataprovider.EventActionOptions{
  4306. ExecuteSync: true,
  4307. },
  4308. },
  4309. },
  4310. }
  4311. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  4312. assert.NoError(t, err)
  4313. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  4314. assert.NoError(t, err)
  4315. conn, client, err := getSftpClient(user)
  4316. if assert.NoError(t, err) {
  4317. defer conn.Close()
  4318. defer client.Close()
  4319. lastReceivedEmail.reset()
  4320. err = writeSFTPFileNoCheck("/test.filepart", 32768, client)
  4321. assert.NoError(t, err)
  4322. email := lastReceivedEmail.get()
  4323. assert.Empty(t, email.From)
  4324. lastReceivedEmail.reset()
  4325. err = writeSFTPFileNoCheck(testFileName, 32768, client)
  4326. assert.NoError(t, err)
  4327. email = lastReceivedEmail.get()
  4328. assert.Len(t, email.To, 1)
  4329. assert.Contains(t, email.Data, `Subject: New "upload"`)
  4330. }
  4331. r2 := dataprovider.EventRule{
  4332. Name: "test rule2",
  4333. Status: 1,
  4334. Trigger: dataprovider.EventTriggerFsEvent,
  4335. Conditions: dataprovider.EventConditions{
  4336. FsEvents: []string{"rename"},
  4337. Options: dataprovider.ConditionOptions{
  4338. FsPaths: []dataprovider.ConditionPattern{
  4339. {
  4340. Pattern: "/**/*.filepart",
  4341. },
  4342. },
  4343. },
  4344. },
  4345. Actions: []dataprovider.EventAction{
  4346. {
  4347. BaseEventAction: dataprovider.BaseEventAction{
  4348. Name: action1.Name,
  4349. },
  4350. Order: 1,
  4351. },
  4352. },
  4353. }
  4354. rule2, _, err := httpdtest.AddEventRule(r2, http.StatusCreated)
  4355. assert.NoError(t, err)
  4356. conn, client, err = getSftpClient(user)
  4357. if assert.NoError(t, err) {
  4358. defer conn.Close()
  4359. defer client.Close()
  4360. tempName := "file.filepart"
  4361. lastReceivedEmail.reset()
  4362. err = writeSFTPFileNoCheck(tempName, 32768, client)
  4363. assert.NoError(t, err)
  4364. email := lastReceivedEmail.get()
  4365. assert.Empty(t, email.From)
  4366. lastReceivedEmail.reset()
  4367. err = client.Rename(tempName, testFileName)
  4368. assert.NoError(t, err)
  4369. assert.Eventually(t, func() bool {
  4370. return lastReceivedEmail.get().From != ""
  4371. }, 3000*time.Millisecond, 100*time.Millisecond)
  4372. email = lastReceivedEmail.get()
  4373. assert.Len(t, email.To, 1)
  4374. assert.Contains(t, email.Data, `Subject: New "rename"`)
  4375. }
  4376. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  4377. assert.NoError(t, err)
  4378. _, err = httpdtest.RemoveEventRule(rule2, http.StatusOK)
  4379. assert.NoError(t, err)
  4380. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  4381. assert.NoError(t, err)
  4382. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  4383. assert.NoError(t, err)
  4384. err = os.RemoveAll(user.GetHomeDir())
  4385. assert.NoError(t, err)
  4386. smtpCfg = smtp.Config{}
  4387. err = smtpCfg.Initialize(configDir, true)
  4388. require.NoError(t, err)
  4389. }
  4390. func TestEventRulePreDelete(t *testing.T) {
  4391. movePath := "recycle bin"
  4392. a1 := dataprovider.BaseEventAction{
  4393. Name: "a1",
  4394. Type: dataprovider.ActionTypeFilesystem,
  4395. Options: dataprovider.BaseEventActionOptions{
  4396. FsConfig: dataprovider.EventActionFilesystemConfig{
  4397. Type: dataprovider.FilesystemActionRename,
  4398. Renames: []dataprovider.KeyValue{
  4399. {
  4400. Key: "/{{VirtualPath}}",
  4401. Value: fmt.Sprintf("/%s/{{VirtualPath}}", movePath),
  4402. },
  4403. },
  4404. },
  4405. },
  4406. }
  4407. action1, resp, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  4408. assert.NoError(t, err, string(resp))
  4409. r1 := dataprovider.EventRule{
  4410. Name: "rule1",
  4411. Status: 1,
  4412. Trigger: dataprovider.EventTriggerFsEvent,
  4413. Conditions: dataprovider.EventConditions{
  4414. FsEvents: []string{"pre-delete"},
  4415. Options: dataprovider.ConditionOptions{
  4416. FsPaths: []dataprovider.ConditionPattern{
  4417. {
  4418. Pattern: fmt.Sprintf("/%s/**", movePath),
  4419. InverseMatch: true,
  4420. },
  4421. },
  4422. },
  4423. },
  4424. Actions: []dataprovider.EventAction{
  4425. {
  4426. BaseEventAction: dataprovider.BaseEventAction{
  4427. Name: action1.Name,
  4428. },
  4429. Order: 1,
  4430. Options: dataprovider.EventActionOptions{
  4431. ExecuteSync: true,
  4432. },
  4433. },
  4434. },
  4435. }
  4436. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  4437. assert.NoError(t, err)
  4438. f := vfs.BaseVirtualFolder{
  4439. Name: movePath,
  4440. MappedPath: filepath.Join(os.TempDir(), movePath),
  4441. }
  4442. _, _, err = httpdtest.AddFolder(f, http.StatusCreated)
  4443. assert.NoError(t, err)
  4444. u := getTestUser()
  4445. u.QuotaFiles = 1000
  4446. u.VirtualFolders = []vfs.VirtualFolder{
  4447. {
  4448. BaseVirtualFolder: vfs.BaseVirtualFolder{
  4449. Name: movePath,
  4450. },
  4451. VirtualPath: "/" + movePath,
  4452. QuotaFiles: 1000,
  4453. },
  4454. }
  4455. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  4456. assert.NoError(t, err)
  4457. conn, client, err := getSftpClient(user)
  4458. if assert.NoError(t, err) {
  4459. defer conn.Close()
  4460. defer client.Close()
  4461. testDir := "sub dir"
  4462. err = client.MkdirAll(testDir)
  4463. assert.NoError(t, err)
  4464. err = writeSFTPFile(testFileName, 100, client)
  4465. assert.NoError(t, err)
  4466. err = writeSFTPFile(path.Join(testDir, testFileName), 100, client)
  4467. assert.NoError(t, err)
  4468. err = client.Remove(testFileName)
  4469. assert.NoError(t, err)
  4470. err = client.Remove(path.Join(testDir, testFileName))
  4471. assert.NoError(t, err)
  4472. // check files
  4473. _, err = client.Stat(testFileName)
  4474. assert.ErrorIs(t, err, os.ErrNotExist)
  4475. _, err = client.Stat(path.Join(testDir, testFileName))
  4476. assert.ErrorIs(t, err, os.ErrNotExist)
  4477. _, err = client.Stat(path.Join("/", movePath, testFileName))
  4478. assert.NoError(t, err)
  4479. _, err = client.Stat(path.Join("/", movePath, testDir, testFileName))
  4480. assert.NoError(t, err)
  4481. // check quota
  4482. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  4483. assert.NoError(t, err)
  4484. assert.Equal(t, 0, user.UsedQuotaFiles)
  4485. assert.Equal(t, int64(0), user.UsedQuotaSize)
  4486. folder, _, err := httpdtest.GetFolderByName(movePath, http.StatusOK)
  4487. assert.NoError(t, err)
  4488. assert.Equal(t, 2, folder.UsedQuotaFiles)
  4489. assert.Equal(t, int64(200), folder.UsedQuotaSize)
  4490. // pre-delete action is not executed in movePath
  4491. err = client.Remove(path.Join("/", movePath, testFileName))
  4492. assert.NoError(t, err)
  4493. // check quota
  4494. folder, _, err = httpdtest.GetFolderByName(movePath, http.StatusOK)
  4495. assert.NoError(t, err)
  4496. assert.Equal(t, 1, folder.UsedQuotaFiles)
  4497. assert.Equal(t, int64(100), folder.UsedQuotaSize)
  4498. }
  4499. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  4500. assert.NoError(t, err)
  4501. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  4502. assert.NoError(t, err)
  4503. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  4504. assert.NoError(t, err)
  4505. err = os.RemoveAll(user.GetHomeDir())
  4506. assert.NoError(t, err)
  4507. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: movePath}, http.StatusOK)
  4508. assert.NoError(t, err)
  4509. err = os.RemoveAll(filepath.Join(os.TempDir(), movePath))
  4510. assert.NoError(t, err)
  4511. }
  4512. func TestEventRulePreDownloadUpload(t *testing.T) {
  4513. testDir := "/d"
  4514. a1 := dataprovider.BaseEventAction{
  4515. Name: "a1",
  4516. Type: dataprovider.ActionTypeFilesystem,
  4517. Options: dataprovider.BaseEventActionOptions{
  4518. FsConfig: dataprovider.EventActionFilesystemConfig{
  4519. Type: dataprovider.FilesystemActionMkdirs,
  4520. MkDirs: []string{testDir},
  4521. },
  4522. },
  4523. }
  4524. action1, resp, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  4525. assert.NoError(t, err, string(resp))
  4526. a2 := dataprovider.BaseEventAction{
  4527. Name: "a2",
  4528. Type: dataprovider.ActionTypeFilesystem,
  4529. Options: dataprovider.BaseEventActionOptions{
  4530. FsConfig: dataprovider.EventActionFilesystemConfig{
  4531. Type: dataprovider.FilesystemActionRename,
  4532. Renames: []dataprovider.KeyValue{
  4533. {
  4534. Key: "/missing source",
  4535. Value: "/missing target",
  4536. },
  4537. },
  4538. },
  4539. },
  4540. }
  4541. action2, resp, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  4542. assert.NoError(t, err, string(resp))
  4543. r1 := dataprovider.EventRule{
  4544. Name: "rule1",
  4545. Status: 1,
  4546. Trigger: dataprovider.EventTriggerFsEvent,
  4547. Conditions: dataprovider.EventConditions{
  4548. FsEvents: []string{"pre-download", "pre-upload"},
  4549. },
  4550. Actions: []dataprovider.EventAction{
  4551. {
  4552. BaseEventAction: dataprovider.BaseEventAction{
  4553. Name: action1.Name,
  4554. },
  4555. Order: 1,
  4556. Options: dataprovider.EventActionOptions{
  4557. ExecuteSync: true,
  4558. },
  4559. },
  4560. },
  4561. }
  4562. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  4563. assert.NoError(t, err)
  4564. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  4565. assert.NoError(t, err)
  4566. conn, client, err := getSftpClient(user)
  4567. if assert.NoError(t, err) {
  4568. defer conn.Close()
  4569. defer client.Close()
  4570. // the rule will always succeed, so uploads/downloads will work
  4571. err = writeSFTPFile(testFileName, 100, client)
  4572. assert.NoError(t, err)
  4573. _, err = client.Stat(testDir)
  4574. assert.NoError(t, err)
  4575. err = client.RemoveDirectory(testDir)
  4576. assert.NoError(t, err)
  4577. f, err := client.Open(testFileName)
  4578. assert.NoError(t, err)
  4579. contents := make([]byte, 100)
  4580. n, err := io.ReadFull(f, contents)
  4581. assert.NoError(t, err)
  4582. assert.Equal(t, int(100), n)
  4583. err = f.Close()
  4584. assert.NoError(t, err)
  4585. // disable the rule
  4586. rule1.Status = 0
  4587. _, _, err = httpdtest.UpdateEventRule(rule1, http.StatusOK)
  4588. assert.NoError(t, err)
  4589. err = client.RemoveDirectory(testDir)
  4590. assert.NoError(t, err)
  4591. err = client.Remove(testFileName)
  4592. assert.NoError(t, err)
  4593. err = writeSFTPFile(testFileName, 100, client)
  4594. assert.NoError(t, err)
  4595. _, err = client.Stat(testDir)
  4596. assert.ErrorIs(t, err, fs.ErrNotExist)
  4597. // now update the rule so that it will always fail
  4598. rule1.Status = 1
  4599. rule1.Actions = []dataprovider.EventAction{
  4600. {
  4601. BaseEventAction: dataprovider.BaseEventAction{
  4602. Name: action2.Name,
  4603. },
  4604. Order: 1,
  4605. Options: dataprovider.EventActionOptions{
  4606. ExecuteSync: true,
  4607. },
  4608. },
  4609. }
  4610. _, _, err = httpdtest.UpdateEventRule(rule1, http.StatusOK)
  4611. assert.NoError(t, err)
  4612. _, err = client.Open(testFileName)
  4613. assert.ErrorIs(t, err, os.ErrPermission)
  4614. err = client.Remove(testFileName)
  4615. assert.NoError(t, err)
  4616. err = writeSFTPFile(testFileName, 100, client)
  4617. assert.ErrorIs(t, err, os.ErrPermission)
  4618. }
  4619. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  4620. assert.NoError(t, err)
  4621. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  4622. assert.NoError(t, err)
  4623. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  4624. assert.NoError(t, err)
  4625. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  4626. assert.NoError(t, err)
  4627. err = os.RemoveAll(user.GetHomeDir())
  4628. assert.NoError(t, err)
  4629. }
  4630. func TestEventActionCommandEnvVars(t *testing.T) {
  4631. if runtime.GOOS == osWindows {
  4632. t.Skip("this test is not available on Windows")
  4633. }
  4634. envName := "MY_ENV"
  4635. uploadScriptPath := filepath.Join(os.TempDir(), "upload.sh")
  4636. err := os.WriteFile(uploadScriptPath, getUploadScriptEnvContent(envName), 0755)
  4637. assert.NoError(t, err)
  4638. a1 := dataprovider.BaseEventAction{
  4639. Name: "action1",
  4640. Type: dataprovider.ActionTypeCommand,
  4641. Options: dataprovider.BaseEventActionOptions{
  4642. CmdConfig: dataprovider.EventActionCommandConfig{
  4643. Cmd: uploadScriptPath,
  4644. Timeout: 10,
  4645. EnvVars: []dataprovider.KeyValue{
  4646. {
  4647. Key: envName,
  4648. Value: "$",
  4649. },
  4650. },
  4651. },
  4652. },
  4653. }
  4654. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  4655. assert.NoError(t, err)
  4656. r1 := dataprovider.EventRule{
  4657. Name: "test rule1",
  4658. Status: 1,
  4659. Trigger: dataprovider.EventTriggerFsEvent,
  4660. Conditions: dataprovider.EventConditions{
  4661. FsEvents: []string{"upload"},
  4662. },
  4663. Actions: []dataprovider.EventAction{
  4664. {
  4665. BaseEventAction: dataprovider.BaseEventAction{
  4666. Name: action1.Name,
  4667. },
  4668. Order: 1,
  4669. Options: dataprovider.EventActionOptions{
  4670. ExecuteSync: true,
  4671. },
  4672. },
  4673. },
  4674. }
  4675. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  4676. assert.NoError(t, err)
  4677. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  4678. assert.NoError(t, err)
  4679. conn, client, err := getSftpClient(user)
  4680. if assert.NoError(t, err) {
  4681. defer conn.Close()
  4682. defer client.Close()
  4683. err = writeSFTPFileNoCheck(testFileName, 100, client)
  4684. assert.Error(t, err)
  4685. }
  4686. os.Setenv(envName, "1")
  4687. defer os.Unsetenv(envName)
  4688. conn, client, err = getSftpClient(user)
  4689. if assert.NoError(t, err) {
  4690. defer conn.Close()
  4691. defer client.Close()
  4692. err = writeSFTPFileNoCheck(testFileName, 100, client)
  4693. assert.NoError(t, err)
  4694. }
  4695. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  4696. assert.NoError(t, err)
  4697. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  4698. assert.NoError(t, err)
  4699. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  4700. assert.NoError(t, err)
  4701. err = os.RemoveAll(user.GetHomeDir())
  4702. assert.NoError(t, err)
  4703. err = os.Remove(uploadScriptPath)
  4704. assert.NoError(t, err)
  4705. }
  4706. func TestFsActionCopy(t *testing.T) {
  4707. a1 := dataprovider.BaseEventAction{
  4708. Name: "a1",
  4709. Type: dataprovider.ActionTypeFilesystem,
  4710. Options: dataprovider.BaseEventActionOptions{
  4711. FsConfig: dataprovider.EventActionFilesystemConfig{
  4712. Type: dataprovider.FilesystemActionCopy,
  4713. Copy: []dataprovider.KeyValue{
  4714. {
  4715. Key: "/{{VirtualPath}}/",
  4716. Value: "/dircopy/",
  4717. },
  4718. },
  4719. },
  4720. },
  4721. }
  4722. action1, resp, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  4723. assert.NoError(t, err, string(resp))
  4724. r1 := dataprovider.EventRule{
  4725. Name: "rule1",
  4726. Status: 1,
  4727. Trigger: dataprovider.EventTriggerFsEvent,
  4728. Conditions: dataprovider.EventConditions{
  4729. FsEvents: []string{"upload"},
  4730. },
  4731. Actions: []dataprovider.EventAction{
  4732. {
  4733. BaseEventAction: dataprovider.BaseEventAction{
  4734. Name: action1.Name,
  4735. },
  4736. Order: 1,
  4737. Options: dataprovider.EventActionOptions{
  4738. ExecuteSync: true,
  4739. },
  4740. },
  4741. },
  4742. }
  4743. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  4744. assert.NoError(t, err)
  4745. u := getTestUser()
  4746. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  4747. assert.NoError(t, err)
  4748. conn, client, err := getSftpClient(user)
  4749. if assert.NoError(t, err) {
  4750. defer conn.Close()
  4751. defer client.Close()
  4752. err = writeSFTPFile(testFileName, 100, client)
  4753. assert.NoError(t, err)
  4754. _, err = client.Stat(path.Join("dircopy", testFileName))
  4755. assert.NoError(t, err)
  4756. action1.Options.FsConfig.Copy = []dataprovider.KeyValue{
  4757. {
  4758. Key: "/missing path",
  4759. Value: "/copied path",
  4760. },
  4761. }
  4762. _, _, err = httpdtest.UpdateEventAction(action1, http.StatusOK)
  4763. assert.NoError(t, err)
  4764. // copy a missing path will fail
  4765. err = writeSFTPFile(testFileName, 100, client)
  4766. assert.Error(t, err)
  4767. }
  4768. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  4769. assert.NoError(t, err)
  4770. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  4771. assert.NoError(t, err)
  4772. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  4773. assert.NoError(t, err)
  4774. err = os.RemoveAll(user.GetHomeDir())
  4775. assert.NoError(t, err)
  4776. }
  4777. func TestEventFsActionsGroupFilters(t *testing.T) {
  4778. smtpCfg := smtp.Config{
  4779. Host: "127.0.0.1",
  4780. Port: 2525,
  4781. From: "notification@example.com",
  4782. TemplatesPath: "templates",
  4783. }
  4784. err := smtpCfg.Initialize(configDir, true)
  4785. require.NoError(t, err)
  4786. a1 := dataprovider.BaseEventAction{
  4787. Name: "a1",
  4788. Type: dataprovider.ActionTypeEmail,
  4789. Options: dataprovider.BaseEventActionOptions{
  4790. EmailConfig: dataprovider.EventActionEmailConfig{
  4791. Recipients: []string{"example@example.net"},
  4792. Subject: `New "{{Event}}" from "{{Name}}" status {{StatusString}}`,
  4793. Body: "Fs path {{FsPath}}, size: {{FileSize}}, protocol: {{Protocol}}, IP: {{IP}} {{ErrorString}}",
  4794. },
  4795. },
  4796. }
  4797. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  4798. assert.NoError(t, err)
  4799. r1 := dataprovider.EventRule{
  4800. Name: "rule1",
  4801. Status: 1,
  4802. Trigger: dataprovider.EventTriggerFsEvent,
  4803. Conditions: dataprovider.EventConditions{
  4804. FsEvents: []string{"upload"},
  4805. Options: dataprovider.ConditionOptions{
  4806. GroupNames: []dataprovider.ConditionPattern{
  4807. {
  4808. Pattern: "group*",
  4809. },
  4810. },
  4811. },
  4812. },
  4813. Actions: []dataprovider.EventAction{
  4814. {
  4815. BaseEventAction: dataprovider.BaseEventAction{
  4816. Name: action1.Name,
  4817. },
  4818. Order: 1,
  4819. Options: dataprovider.EventActionOptions{
  4820. ExecuteSync: true,
  4821. },
  4822. },
  4823. },
  4824. }
  4825. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  4826. assert.NoError(t, err)
  4827. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  4828. assert.NoError(t, err)
  4829. conn, client, err := getSftpClient(user)
  4830. if assert.NoError(t, err) {
  4831. defer conn.Close()
  4832. defer client.Close()
  4833. // the user has no group, so the rule does not match
  4834. lastReceivedEmail.reset()
  4835. err = writeSFTPFile(testFileName, 32, client)
  4836. assert.NoError(t, err)
  4837. assert.Empty(t, lastReceivedEmail.get().From)
  4838. }
  4839. g1 := dataprovider.Group{
  4840. BaseGroup: sdk.BaseGroup{
  4841. Name: "agroup1",
  4842. },
  4843. }
  4844. group1, _, err := httpdtest.AddGroup(g1, http.StatusCreated)
  4845. assert.NoError(t, err)
  4846. g2 := dataprovider.Group{
  4847. BaseGroup: sdk.BaseGroup{
  4848. Name: "group2",
  4849. },
  4850. }
  4851. group2, _, err := httpdtest.AddGroup(g2, http.StatusCreated)
  4852. assert.NoError(t, err)
  4853. user.Groups = []sdk.GroupMapping{
  4854. {
  4855. Name: group1.Name,
  4856. Type: sdk.GroupTypePrimary,
  4857. },
  4858. }
  4859. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  4860. assert.NoError(t, err)
  4861. conn, client, err = getSftpClient(user)
  4862. if assert.NoError(t, err) {
  4863. defer conn.Close()
  4864. defer client.Close()
  4865. // the group does not match
  4866. lastReceivedEmail.reset()
  4867. err = writeSFTPFile(testFileName, 32, client)
  4868. assert.NoError(t, err)
  4869. assert.Empty(t, lastReceivedEmail.get().From)
  4870. }
  4871. user.Groups = append(user.Groups, sdk.GroupMapping{
  4872. Name: group2.Name,
  4873. Type: sdk.GroupTypeSecondary,
  4874. })
  4875. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  4876. assert.NoError(t, err)
  4877. conn, client, err = getSftpClient(user)
  4878. if assert.NoError(t, err) {
  4879. defer conn.Close()
  4880. defer client.Close()
  4881. // the group matches
  4882. lastReceivedEmail.reset()
  4883. err = writeSFTPFile(testFileName, 32, client)
  4884. assert.NoError(t, err)
  4885. assert.NotEmpty(t, lastReceivedEmail.get().From)
  4886. }
  4887. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  4888. assert.NoError(t, err)
  4889. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  4890. assert.NoError(t, err)
  4891. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  4892. assert.NoError(t, err)
  4893. err = os.RemoveAll(user.GetHomeDir())
  4894. assert.NoError(t, err)
  4895. _, err = httpdtest.RemoveGroup(group1, http.StatusOK)
  4896. assert.NoError(t, err)
  4897. _, err = httpdtest.RemoveGroup(group2, http.StatusOK)
  4898. assert.NoError(t, err)
  4899. smtpCfg = smtp.Config{}
  4900. err = smtpCfg.Initialize(configDir, true)
  4901. require.NoError(t, err)
  4902. }
  4903. func TestBackupAsAttachment(t *testing.T) {
  4904. smtpCfg := smtp.Config{
  4905. Host: "127.0.0.1",
  4906. Port: 2525,
  4907. From: "notification@example.com",
  4908. TemplatesPath: "templates",
  4909. }
  4910. err := smtpCfg.Initialize(configDir, true)
  4911. require.NoError(t, err)
  4912. a1 := dataprovider.BaseEventAction{
  4913. Name: "a1",
  4914. Type: dataprovider.ActionTypeBackup,
  4915. }
  4916. a2 := dataprovider.BaseEventAction{
  4917. Name: "a2",
  4918. Type: dataprovider.ActionTypeEmail,
  4919. Options: dataprovider.BaseEventActionOptions{
  4920. EmailConfig: dataprovider.EventActionEmailConfig{
  4921. Recipients: []string{"test@example.com"},
  4922. Subject: `"{{Event}} {{StatusString}}"`,
  4923. Body: "Domain: {{Name}}",
  4924. Attachments: []string{"/{{VirtualPath}}"},
  4925. },
  4926. },
  4927. }
  4928. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  4929. assert.NoError(t, err)
  4930. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  4931. assert.NoError(t, err)
  4932. r1 := dataprovider.EventRule{
  4933. Name: "test rule certificate",
  4934. Status: 1,
  4935. Trigger: dataprovider.EventTriggerCertificate,
  4936. Actions: []dataprovider.EventAction{
  4937. {
  4938. BaseEventAction: dataprovider.BaseEventAction{
  4939. Name: action1.Name,
  4940. },
  4941. Order: 1,
  4942. },
  4943. {
  4944. BaseEventAction: dataprovider.BaseEventAction{
  4945. Name: action2.Name,
  4946. },
  4947. Order: 2,
  4948. },
  4949. },
  4950. }
  4951. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  4952. assert.NoError(t, err)
  4953. lastReceivedEmail.reset()
  4954. renewalEvent := "Certificate renewal"
  4955. common.HandleCertificateEvent(common.EventParams{
  4956. Name: "example.com",
  4957. Timestamp: time.Now().UnixNano(),
  4958. Status: 1,
  4959. Event: renewalEvent,
  4960. })
  4961. assert.Eventually(t, func() bool {
  4962. return lastReceivedEmail.get().From != ""
  4963. }, 3000*time.Millisecond, 100*time.Millisecond)
  4964. email := lastReceivedEmail.get()
  4965. assert.Len(t, email.To, 1)
  4966. assert.True(t, util.Contains(email.To, "test@example.com"))
  4967. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "%s OK"`, renewalEvent))
  4968. assert.Contains(t, email.Data, `Domain: example.com`)
  4969. assert.Contains(t, email.Data, "Content-Type: application/json")
  4970. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  4971. assert.NoError(t, err)
  4972. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  4973. assert.NoError(t, err)
  4974. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  4975. assert.NoError(t, err)
  4976. smtpCfg = smtp.Config{}
  4977. err = smtpCfg.Initialize(configDir, true)
  4978. require.NoError(t, err)
  4979. }
  4980. func TestEventActionHTTPMultipart(t *testing.T) {
  4981. a1 := dataprovider.BaseEventAction{
  4982. Name: "action1",
  4983. Type: dataprovider.ActionTypeHTTP,
  4984. Options: dataprovider.BaseEventActionOptions{
  4985. HTTPConfig: dataprovider.EventActionHTTPConfig{
  4986. Endpoint: fmt.Sprintf("http://%s/multipart", httpAddr),
  4987. Method: http.MethodPut,
  4988. Parts: []dataprovider.HTTPPart{
  4989. {
  4990. Name: "part1",
  4991. Headers: []dataprovider.KeyValue{
  4992. {
  4993. Key: "Content-Type",
  4994. Value: "application/json",
  4995. },
  4996. },
  4997. Body: `{"FilePath": "{{VirtualPath}}"}`,
  4998. },
  4999. {
  5000. Name: "file",
  5001. Filepath: "/{{VirtualPath}}",
  5002. },
  5003. },
  5004. },
  5005. },
  5006. }
  5007. action1, resp, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  5008. assert.NoError(t, err, string(resp))
  5009. r1 := dataprovider.EventRule{
  5010. Name: "test http multipart",
  5011. Status: 1,
  5012. Trigger: dataprovider.EventTriggerFsEvent,
  5013. Conditions: dataprovider.EventConditions{
  5014. FsEvents: []string{"upload"},
  5015. },
  5016. Actions: []dataprovider.EventAction{
  5017. {
  5018. BaseEventAction: dataprovider.BaseEventAction{
  5019. Name: action1.Name,
  5020. },
  5021. Options: dataprovider.EventActionOptions{
  5022. ExecuteSync: true,
  5023. },
  5024. Order: 1,
  5025. },
  5026. },
  5027. }
  5028. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  5029. assert.NoError(t, err)
  5030. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  5031. assert.NoError(t, err)
  5032. conn, client, err := getSftpClient(user)
  5033. if assert.NoError(t, err) {
  5034. defer conn.Close()
  5035. defer client.Close()
  5036. f, err := client.Create(testFileName)
  5037. assert.NoError(t, err)
  5038. _, err = f.Write(testFileContent)
  5039. assert.NoError(t, err)
  5040. err = f.Close()
  5041. assert.NoError(t, err)
  5042. // now add an missing file to the http multipart action
  5043. action1.Options.HTTPConfig.Parts = append(action1.Options.HTTPConfig.Parts, dataprovider.HTTPPart{
  5044. Name: "file1",
  5045. Filepath: "/missing",
  5046. })
  5047. _, resp, err = httpdtest.UpdateEventAction(action1, http.StatusOK)
  5048. assert.NoError(t, err, string(resp))
  5049. f, err = client.Create("testfile.txt")
  5050. assert.NoError(t, err)
  5051. _, err = f.Write(testFileContent)
  5052. assert.NoError(t, err)
  5053. err = f.Close()
  5054. assert.Error(t, err)
  5055. }
  5056. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  5057. assert.NoError(t, err)
  5058. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  5059. assert.NoError(t, err)
  5060. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  5061. assert.NoError(t, err)
  5062. err = os.RemoveAll(user.GetHomeDir())
  5063. assert.NoError(t, err)
  5064. }
  5065. func TestEventActionCompress(t *testing.T) {
  5066. a1 := dataprovider.BaseEventAction{
  5067. Name: "action1",
  5068. Type: dataprovider.ActionTypeFilesystem,
  5069. Options: dataprovider.BaseEventActionOptions{
  5070. FsConfig: dataprovider.EventActionFilesystemConfig{
  5071. Type: dataprovider.FilesystemActionCompress,
  5072. Compress: dataprovider.EventActionFsCompress{
  5073. Name: "/{{VirtualPath}}.zip",
  5074. Paths: []string{"/{{VirtualPath}}"},
  5075. },
  5076. },
  5077. },
  5078. }
  5079. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  5080. assert.NoError(t, err)
  5081. r1 := dataprovider.EventRule{
  5082. Name: "test compress",
  5083. Status: 1,
  5084. Trigger: dataprovider.EventTriggerFsEvent,
  5085. Conditions: dataprovider.EventConditions{
  5086. FsEvents: []string{"upload"},
  5087. },
  5088. Actions: []dataprovider.EventAction{
  5089. {
  5090. BaseEventAction: dataprovider.BaseEventAction{
  5091. Name: action1.Name,
  5092. },
  5093. Order: 1,
  5094. Options: dataprovider.EventActionOptions{
  5095. ExecuteSync: true,
  5096. },
  5097. },
  5098. },
  5099. }
  5100. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  5101. assert.NoError(t, err)
  5102. u := getTestUser()
  5103. u.QuotaFiles = 1000
  5104. localUser, _, err := httpdtest.AddUser(u, http.StatusCreated)
  5105. assert.NoError(t, err)
  5106. u = getTestSFTPUser()
  5107. u.FsConfig.SFTPConfig.BufferSize = 1
  5108. u.QuotaFiles = 1000
  5109. sftpUser, _, err := httpdtest.AddUser(u, http.StatusCreated)
  5110. assert.NoError(t, err)
  5111. u = getCryptFsUser()
  5112. u.QuotaFiles = 1000
  5113. cryptFsUser, _, err := httpdtest.AddUser(u, http.StatusCreated)
  5114. assert.NoError(t, err)
  5115. for _, user := range []dataprovider.User{localUser, sftpUser, cryptFsUser} {
  5116. // cleanup home dir
  5117. err = os.RemoveAll(user.GetHomeDir())
  5118. assert.NoError(t, err)
  5119. rule1.Conditions.Options.Names = []dataprovider.ConditionPattern{
  5120. {
  5121. Pattern: user.Username,
  5122. },
  5123. }
  5124. _, _, err = httpdtest.UpdateEventRule(rule1, http.StatusOK)
  5125. assert.NoError(t, err)
  5126. conn, client, err := getSftpClient(user)
  5127. if assert.NoError(t, err) {
  5128. defer conn.Close()
  5129. defer client.Close()
  5130. expectedQuotaSize := int64(len(testFileContent))
  5131. expectedQuotaFiles := 1
  5132. if user.Username == cryptFsUser.Username {
  5133. encryptedFileSize, err := getEncryptedFileSize(expectedQuotaSize)
  5134. assert.NoError(t, err)
  5135. expectedQuotaSize = encryptedFileSize
  5136. }
  5137. f, err := client.Create(testFileName)
  5138. assert.NoError(t, err)
  5139. _, err = f.Write(testFileContent)
  5140. assert.NoError(t, err)
  5141. err = f.Close()
  5142. assert.NoError(t, err)
  5143. info, err := client.Stat(testFileName + ".zip") //nolint:goconst
  5144. if assert.NoError(t, err) {
  5145. assert.Greater(t, info.Size(), int64(0))
  5146. // check quota
  5147. archiveSize := info.Size()
  5148. if user.Username == cryptFsUser.Username {
  5149. encryptedFileSize, err := getEncryptedFileSize(archiveSize)
  5150. assert.NoError(t, err)
  5151. archiveSize = encryptedFileSize
  5152. }
  5153. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  5154. assert.NoError(t, err)
  5155. assert.Equal(t, expectedQuotaFiles+1, user.UsedQuotaFiles,
  5156. "quota file does no match for user %q", user.Username)
  5157. assert.Equal(t, expectedQuotaSize+archiveSize, user.UsedQuotaSize,
  5158. "quota size does no match for user %q", user.Username)
  5159. }
  5160. // now overwrite the same file
  5161. f, err = client.Create(testFileName)
  5162. assert.NoError(t, err)
  5163. _, err = f.Write(testFileContent)
  5164. assert.NoError(t, err)
  5165. err = f.Close()
  5166. assert.NoError(t, err)
  5167. info, err = client.Stat(testFileName + ".zip")
  5168. if assert.NoError(t, err) {
  5169. assert.Greater(t, info.Size(), int64(0))
  5170. archiveSize := info.Size()
  5171. if user.Username == cryptFsUser.Username {
  5172. encryptedFileSize, err := getEncryptedFileSize(archiveSize)
  5173. assert.NoError(t, err)
  5174. archiveSize = encryptedFileSize
  5175. }
  5176. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  5177. assert.NoError(t, err)
  5178. assert.Equal(t, expectedQuotaFiles+1, user.UsedQuotaFiles,
  5179. "quota file after overwrite does no match for user %q", user.Username)
  5180. assert.Equal(t, expectedQuotaSize+archiveSize, user.UsedQuotaSize,
  5181. "quota size after overwrite does no match for user %q", user.Username)
  5182. }
  5183. }
  5184. if user.Username == localUser.Username {
  5185. err = os.RemoveAll(user.GetHomeDir())
  5186. assert.NoError(t, err)
  5187. }
  5188. }
  5189. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  5190. assert.NoError(t, err)
  5191. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  5192. assert.NoError(t, err)
  5193. _, err = httpdtest.RemoveUser(sftpUser, http.StatusOK)
  5194. assert.NoError(t, err)
  5195. _, err = httpdtest.RemoveUser(localUser, http.StatusOK)
  5196. assert.NoError(t, err)
  5197. err = os.RemoveAll(localUser.GetHomeDir())
  5198. assert.NoError(t, err)
  5199. _, err = httpdtest.RemoveUser(cryptFsUser, http.StatusOK)
  5200. assert.NoError(t, err)
  5201. err = os.RemoveAll(cryptFsUser.GetHomeDir())
  5202. assert.NoError(t, err)
  5203. }
  5204. func TestEventActionCompressQuotaErrors(t *testing.T) {
  5205. smtpCfg := smtp.Config{
  5206. Host: "127.0.0.1",
  5207. Port: 2525,
  5208. From: "notify@example.com",
  5209. TemplatesPath: "templates",
  5210. }
  5211. err := smtpCfg.Initialize(configDir, true)
  5212. require.NoError(t, err)
  5213. testDir := "archiveDir"
  5214. zipPath := "/archive.zip"
  5215. a1 := dataprovider.BaseEventAction{
  5216. Name: "action1",
  5217. Type: dataprovider.ActionTypeFilesystem,
  5218. Options: dataprovider.BaseEventActionOptions{
  5219. FsConfig: dataprovider.EventActionFilesystemConfig{
  5220. Type: dataprovider.FilesystemActionCompress,
  5221. Compress: dataprovider.EventActionFsCompress{
  5222. Name: zipPath,
  5223. Paths: []string{"/" + testDir},
  5224. },
  5225. },
  5226. },
  5227. }
  5228. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  5229. assert.NoError(t, err)
  5230. a2 := dataprovider.BaseEventAction{
  5231. Name: "action2",
  5232. Type: dataprovider.ActionTypeEmail,
  5233. Options: dataprovider.BaseEventActionOptions{
  5234. EmailConfig: dataprovider.EventActionEmailConfig{
  5235. Recipients: []string{"test@example.com"},
  5236. Subject: `"Compress failed"`,
  5237. Body: "Error: {{ErrorString}}",
  5238. },
  5239. },
  5240. }
  5241. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  5242. assert.NoError(t, err)
  5243. r1 := dataprovider.EventRule{
  5244. Name: "test compress",
  5245. Status: 1,
  5246. Trigger: dataprovider.EventTriggerFsEvent,
  5247. Conditions: dataprovider.EventConditions{
  5248. FsEvents: []string{"rename"},
  5249. },
  5250. Actions: []dataprovider.EventAction{
  5251. {
  5252. BaseEventAction: dataprovider.BaseEventAction{
  5253. Name: action1.Name,
  5254. },
  5255. Order: 1,
  5256. },
  5257. {
  5258. BaseEventAction: dataprovider.BaseEventAction{
  5259. Name: action2.Name,
  5260. },
  5261. Options: dataprovider.EventActionOptions{
  5262. IsFailureAction: true,
  5263. },
  5264. Order: 2,
  5265. },
  5266. },
  5267. }
  5268. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  5269. assert.NoError(t, err)
  5270. fileSize := int64(100)
  5271. u := getTestUser()
  5272. u.QuotaSize = 10 * fileSize
  5273. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  5274. assert.NoError(t, err)
  5275. conn, client, err := getSftpClient(user)
  5276. if assert.NoError(t, err) {
  5277. defer conn.Close()
  5278. defer client.Close()
  5279. err = client.MkdirAll(path.Join(testDir, "1", "1"))
  5280. assert.NoError(t, err)
  5281. err = writeSFTPFile(path.Join(testDir, "1", testFileName), fileSize, client)
  5282. assert.NoError(t, err)
  5283. err = client.MkdirAll(path.Join(testDir, "2", "2"))
  5284. assert.NoError(t, err)
  5285. err = writeSFTPFile(path.Join(testDir, "2", testFileName), fileSize, client)
  5286. assert.NoError(t, err)
  5287. err = client.Symlink(path.Join(testDir, "2", testFileName), path.Join(testDir, "2", testFileName+"_link"))
  5288. assert.NoError(t, err)
  5289. // trigger the compress action
  5290. err = client.Mkdir("a")
  5291. assert.NoError(t, err)
  5292. err = client.Rename("a", "b")
  5293. assert.NoError(t, err)
  5294. assert.Eventually(t, func() bool {
  5295. _, err := client.Stat(zipPath)
  5296. return err == nil
  5297. }, 3*time.Second, 100*time.Millisecond)
  5298. err = client.Remove(zipPath)
  5299. assert.NoError(t, err)
  5300. // add other 6 file, the compress action should fail with a quota error
  5301. err = writeSFTPFile(path.Join(testDir, "1", "1", testFileName), fileSize, client)
  5302. assert.NoError(t, err)
  5303. err = writeSFTPFile(path.Join(testDir, "2", "2", testFileName), fileSize, client)
  5304. assert.NoError(t, err)
  5305. err = writeSFTPFile(path.Join(testDir, "1", "1", testFileName+"1"), fileSize, client)
  5306. assert.NoError(t, err)
  5307. err = writeSFTPFile(path.Join(testDir, "2", "2", testFileName+"2"), fileSize, client)
  5308. assert.NoError(t, err)
  5309. err = writeSFTPFile(path.Join(testDir, "1", testFileName+"1"), fileSize, client)
  5310. assert.NoError(t, err)
  5311. err = writeSFTPFile(path.Join(testDir, "2", testFileName+"2"), fileSize, client)
  5312. assert.NoError(t, err)
  5313. lastReceivedEmail.reset()
  5314. err = client.Rename("b", "a")
  5315. assert.NoError(t, err)
  5316. assert.Eventually(t, func() bool {
  5317. return lastReceivedEmail.get().From != ""
  5318. }, 3*time.Second, 100*time.Millisecond)
  5319. email := lastReceivedEmail.get()
  5320. assert.Len(t, email.To, 1)
  5321. assert.True(t, util.Contains(email.To, "test@example.com"))
  5322. assert.Contains(t, email.Data, `Subject: "Compress failed"`)
  5323. assert.Contains(t, email.Data, common.ErrQuotaExceeded.Error())
  5324. // update quota size so the user is already overquota
  5325. user.QuotaSize = 7 * fileSize
  5326. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  5327. assert.NoError(t, err)
  5328. lastReceivedEmail.reset()
  5329. err = client.Rename("a", "b")
  5330. assert.NoError(t, err)
  5331. assert.Eventually(t, func() bool {
  5332. return lastReceivedEmail.get().From != ""
  5333. }, 3*time.Second, 100*time.Millisecond)
  5334. email = lastReceivedEmail.get()
  5335. assert.Len(t, email.To, 1)
  5336. assert.True(t, util.Contains(email.To, "test@example.com"))
  5337. assert.Contains(t, email.Data, `Subject: "Compress failed"`)
  5338. assert.Contains(t, email.Data, common.ErrQuotaExceeded.Error())
  5339. // remove the path to compress to trigger an error for size estimation
  5340. out, err := runSSHCommand(fmt.Sprintf("sftpgo-remove %s", testDir), user)
  5341. assert.NoError(t, err, string(out))
  5342. lastReceivedEmail.reset()
  5343. err = client.Rename("b", "a")
  5344. assert.NoError(t, err)
  5345. assert.Eventually(t, func() bool {
  5346. return lastReceivedEmail.get().From != ""
  5347. }, 3*time.Second, 100*time.Millisecond)
  5348. email = lastReceivedEmail.get()
  5349. assert.Len(t, email.To, 1)
  5350. assert.True(t, util.Contains(email.To, "test@example.com"))
  5351. assert.Contains(t, email.Data, `Subject: "Compress failed"`)
  5352. assert.Contains(t, email.Data, "unable to estimate archive size")
  5353. }
  5354. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  5355. assert.NoError(t, err)
  5356. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  5357. assert.NoError(t, err)
  5358. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  5359. assert.NoError(t, err)
  5360. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  5361. assert.NoError(t, err)
  5362. err = os.RemoveAll(user.GetHomeDir())
  5363. assert.NoError(t, err)
  5364. smtpCfg = smtp.Config{}
  5365. err = smtpCfg.Initialize(configDir, true)
  5366. require.NoError(t, err)
  5367. }
  5368. func TestEventActionCompressQuotaFolder(t *testing.T) {
  5369. testDir := "/folder"
  5370. a1 := dataprovider.BaseEventAction{
  5371. Name: "action1",
  5372. Type: dataprovider.ActionTypeFilesystem,
  5373. Options: dataprovider.BaseEventActionOptions{
  5374. FsConfig: dataprovider.EventActionFilesystemConfig{
  5375. Type: dataprovider.FilesystemActionCompress,
  5376. Compress: dataprovider.EventActionFsCompress{
  5377. Name: "/{{VirtualPath}}.zip",
  5378. Paths: []string{"/{{VirtualPath}}", testDir},
  5379. },
  5380. },
  5381. },
  5382. }
  5383. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  5384. assert.NoError(t, err)
  5385. r1 := dataprovider.EventRule{
  5386. Name: "test compress",
  5387. Status: 1,
  5388. Trigger: dataprovider.EventTriggerFsEvent,
  5389. Conditions: dataprovider.EventConditions{
  5390. FsEvents: []string{"upload"},
  5391. },
  5392. Actions: []dataprovider.EventAction{
  5393. {
  5394. BaseEventAction: dataprovider.BaseEventAction{
  5395. Name: action1.Name,
  5396. },
  5397. Order: 1,
  5398. Options: dataprovider.EventActionOptions{
  5399. ExecuteSync: true,
  5400. },
  5401. },
  5402. },
  5403. }
  5404. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  5405. assert.NoError(t, err)
  5406. u := getTestUser()
  5407. u.QuotaFiles = 1000
  5408. mappedPath := filepath.Join(os.TempDir(), "virtualpath")
  5409. folderName := filepath.Base(mappedPath)
  5410. vdirPath := "/virtualpath"
  5411. f := vfs.BaseVirtualFolder{
  5412. Name: folderName,
  5413. MappedPath: mappedPath,
  5414. }
  5415. _, _, err = httpdtest.AddFolder(f, http.StatusCreated)
  5416. assert.NoError(t, err)
  5417. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  5418. BaseVirtualFolder: vfs.BaseVirtualFolder{
  5419. Name: folderName,
  5420. },
  5421. VirtualPath: vdirPath,
  5422. QuotaSize: -1,
  5423. QuotaFiles: -1,
  5424. })
  5425. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  5426. assert.NoError(t, err)
  5427. conn, client, err := getSftpClient(user)
  5428. if assert.NoError(t, err) {
  5429. defer conn.Close()
  5430. defer client.Close()
  5431. err = client.Mkdir(testDir)
  5432. assert.NoError(t, err)
  5433. expectedQuotaSize := int64(len(testFileContent))
  5434. expectedQuotaFiles := 1
  5435. err = client.Symlink(path.Join(testDir, testFileName), path.Join(testDir, testFileName+"_link"))
  5436. assert.NoError(t, err)
  5437. f, err := client.Create(path.Join(testDir, testFileName))
  5438. assert.NoError(t, err)
  5439. _, err = f.Write(testFileContent)
  5440. assert.NoError(t, err)
  5441. err = f.Close()
  5442. assert.NoError(t, err)
  5443. info, err := client.Stat(path.Join(testDir, testFileName) + ".zip")
  5444. if assert.NoError(t, err) {
  5445. assert.Greater(t, info.Size(), int64(0))
  5446. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  5447. assert.NoError(t, err)
  5448. expectedQuotaFiles++
  5449. expectedQuotaSize += info.Size()
  5450. assert.Equal(t, expectedQuotaFiles, user.UsedQuotaFiles)
  5451. assert.Equal(t, expectedQuotaSize, user.UsedQuotaSize)
  5452. }
  5453. vfolder, _, err := httpdtest.GetFolderByName(folderName, http.StatusOK)
  5454. assert.NoError(t, err)
  5455. assert.Equal(t, 0, vfolder.UsedQuotaFiles)
  5456. assert.Equal(t, int64(0), vfolder.UsedQuotaSize)
  5457. // upload in the virtual path
  5458. f, err = client.Create(path.Join(vdirPath, testFileName))
  5459. assert.NoError(t, err)
  5460. _, err = f.Write(testFileContent)
  5461. assert.NoError(t, err)
  5462. err = f.Close()
  5463. assert.NoError(t, err)
  5464. info, err = client.Stat(path.Join(vdirPath, testFileName) + ".zip")
  5465. if assert.NoError(t, err) {
  5466. assert.Greater(t, info.Size(), int64(0))
  5467. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  5468. assert.NoError(t, err)
  5469. expectedQuotaFiles += 2
  5470. expectedQuotaSize += info.Size() + int64(len(testFileContent))
  5471. assert.Equal(t, expectedQuotaFiles, user.UsedQuotaFiles)
  5472. assert.Equal(t, expectedQuotaSize, user.UsedQuotaSize)
  5473. vfolder, _, err := httpdtest.GetFolderByName(folderName, http.StatusOK)
  5474. assert.NoError(t, err)
  5475. assert.Equal(t, 2, vfolder.UsedQuotaFiles)
  5476. assert.Equal(t, info.Size()+int64(len(testFileContent)), vfolder.UsedQuotaSize)
  5477. }
  5478. }
  5479. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  5480. assert.NoError(t, err)
  5481. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  5482. assert.NoError(t, err)
  5483. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  5484. assert.NoError(t, err)
  5485. err = os.RemoveAll(user.GetHomeDir())
  5486. assert.NoError(t, err)
  5487. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName}, http.StatusOK)
  5488. assert.NoError(t, err)
  5489. err = os.RemoveAll(mappedPath)
  5490. assert.NoError(t, err)
  5491. }
  5492. func TestEventActionCompressErrors(t *testing.T) {
  5493. a1 := dataprovider.BaseEventAction{
  5494. Name: "action1",
  5495. Type: dataprovider.ActionTypeFilesystem,
  5496. Options: dataprovider.BaseEventActionOptions{
  5497. FsConfig: dataprovider.EventActionFilesystemConfig{
  5498. Type: dataprovider.FilesystemActionCompress,
  5499. Compress: dataprovider.EventActionFsCompress{
  5500. Name: "/{{VirtualPath}}.zip",
  5501. Paths: []string{"/{{VirtualPath}}.zip"}, // cannot compress itself
  5502. },
  5503. },
  5504. },
  5505. }
  5506. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  5507. assert.NoError(t, err)
  5508. r1 := dataprovider.EventRule{
  5509. Name: "test compress",
  5510. Status: 1,
  5511. Trigger: dataprovider.EventTriggerFsEvent,
  5512. Conditions: dataprovider.EventConditions{
  5513. FsEvents: []string{"upload"},
  5514. },
  5515. Actions: []dataprovider.EventAction{
  5516. {
  5517. BaseEventAction: dataprovider.BaseEventAction{
  5518. Name: action1.Name,
  5519. },
  5520. Order: 1,
  5521. Options: dataprovider.EventActionOptions{
  5522. ExecuteSync: true,
  5523. },
  5524. },
  5525. },
  5526. }
  5527. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  5528. assert.NoError(t, err)
  5529. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  5530. assert.NoError(t, err)
  5531. conn, client, err := getSftpClient(user)
  5532. if assert.NoError(t, err) {
  5533. defer conn.Close()
  5534. defer client.Close()
  5535. f, err := client.Create(testFileName)
  5536. assert.NoError(t, err)
  5537. _, err = f.Write(testFileContent)
  5538. assert.NoError(t, err)
  5539. err = f.Close()
  5540. assert.Error(t, err)
  5541. }
  5542. // try to compress a missing file
  5543. action1.Options.FsConfig.Compress.Paths = []string{"/missing file"}
  5544. _, _, err = httpdtest.UpdateEventAction(action1, http.StatusOK)
  5545. assert.NoError(t, err)
  5546. conn, client, err = getSftpClient(user)
  5547. if assert.NoError(t, err) {
  5548. defer conn.Close()
  5549. defer client.Close()
  5550. f, err := client.Create(testFileName)
  5551. assert.NoError(t, err)
  5552. _, err = f.Write(testFileContent)
  5553. assert.NoError(t, err)
  5554. err = f.Close()
  5555. assert.Error(t, err)
  5556. }
  5557. // try to overwrite a directory
  5558. testDir := "/adir"
  5559. action1.Options.FsConfig.Compress.Name = testDir
  5560. action1.Options.FsConfig.Compress.Paths = []string{"/{{VirtualPath}}"}
  5561. _, _, err = httpdtest.UpdateEventAction(action1, http.StatusOK)
  5562. assert.NoError(t, err)
  5563. conn, client, err = getSftpClient(user)
  5564. if assert.NoError(t, err) {
  5565. defer conn.Close()
  5566. defer client.Close()
  5567. err = client.Mkdir(testDir)
  5568. assert.NoError(t, err)
  5569. f, err := client.Create(testFileName)
  5570. assert.NoError(t, err)
  5571. _, err = f.Write(testFileContent)
  5572. assert.NoError(t, err)
  5573. err = f.Close()
  5574. assert.Error(t, err)
  5575. }
  5576. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  5577. assert.NoError(t, err)
  5578. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  5579. assert.NoError(t, err)
  5580. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  5581. assert.NoError(t, err)
  5582. err = os.RemoveAll(user.GetHomeDir())
  5583. assert.NoError(t, err)
  5584. }
  5585. func TestEventActionEmailAttachments(t *testing.T) {
  5586. smtpCfg := smtp.Config{
  5587. Host: "127.0.0.1",
  5588. Port: 2525,
  5589. From: "notify@example.com",
  5590. TemplatesPath: "templates",
  5591. }
  5592. err := smtpCfg.Initialize(configDir, true)
  5593. require.NoError(t, err)
  5594. a1 := dataprovider.BaseEventAction{
  5595. Name: "action1",
  5596. Type: dataprovider.ActionTypeFilesystem,
  5597. Options: dataprovider.BaseEventActionOptions{
  5598. FsConfig: dataprovider.EventActionFilesystemConfig{
  5599. Type: dataprovider.FilesystemActionCompress,
  5600. Compress: dataprovider.EventActionFsCompress{
  5601. Name: "/archive/{{VirtualPath}}.zip",
  5602. Paths: []string{"/{{VirtualPath}}"},
  5603. },
  5604. },
  5605. },
  5606. }
  5607. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  5608. assert.NoError(t, err)
  5609. a2 := dataprovider.BaseEventAction{
  5610. Name: "action2",
  5611. Type: dataprovider.ActionTypeEmail,
  5612. Options: dataprovider.BaseEventActionOptions{
  5613. EmailConfig: dataprovider.EventActionEmailConfig{
  5614. Recipients: []string{"test@example.com"},
  5615. Subject: `"{{Event}}" from "{{Name}}"`,
  5616. Body: "Fs path {{FsPath}}, size: {{FileSize}}, protocol: {{Protocol}}, IP: {{IP}}",
  5617. Attachments: []string{"/archive/{{VirtualPath}}.zip"},
  5618. },
  5619. },
  5620. }
  5621. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  5622. assert.NoError(t, err)
  5623. r1 := dataprovider.EventRule{
  5624. Name: "test email with attachment",
  5625. Status: 1,
  5626. Trigger: dataprovider.EventTriggerFsEvent,
  5627. Conditions: dataprovider.EventConditions{
  5628. FsEvents: []string{"upload"},
  5629. },
  5630. Actions: []dataprovider.EventAction{
  5631. {
  5632. BaseEventAction: dataprovider.BaseEventAction{
  5633. Name: action1.Name,
  5634. },
  5635. Order: 1,
  5636. },
  5637. {
  5638. BaseEventAction: dataprovider.BaseEventAction{
  5639. Name: action2.Name,
  5640. },
  5641. Order: 2,
  5642. },
  5643. },
  5644. }
  5645. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  5646. assert.NoError(t, err)
  5647. localUser, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  5648. assert.NoError(t, err)
  5649. u := getTestSFTPUser()
  5650. u.FsConfig.SFTPConfig.BufferSize = 1
  5651. sftpUser, _, err := httpdtest.AddUser(u, http.StatusCreated)
  5652. assert.NoError(t, err)
  5653. cryptFsUser, _, err := httpdtest.AddUser(getCryptFsUser(), http.StatusCreated)
  5654. assert.NoError(t, err)
  5655. for _, user := range []dataprovider.User{localUser, sftpUser, cryptFsUser} {
  5656. conn, client, err := getSftpClient(user)
  5657. if assert.NoError(t, err) {
  5658. defer conn.Close()
  5659. defer client.Close()
  5660. lastReceivedEmail.reset()
  5661. f, err := client.Create(testFileName)
  5662. assert.NoError(t, err)
  5663. _, err = f.Write(testFileContent)
  5664. assert.NoError(t, err)
  5665. err = f.Close()
  5666. assert.NoError(t, err)
  5667. assert.Eventually(t, func() bool {
  5668. return lastReceivedEmail.get().From != ""
  5669. }, 1500*time.Millisecond, 100*time.Millisecond)
  5670. email := lastReceivedEmail.get()
  5671. assert.Len(t, email.To, 1)
  5672. assert.True(t, util.Contains(email.To, "test@example.com"))
  5673. assert.Contains(t, email.Data, `Subject: "upload" from`)
  5674. assert.Contains(t, email.Data, "Content-Disposition: attachment")
  5675. }
  5676. }
  5677. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  5678. assert.NoError(t, err)
  5679. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  5680. assert.NoError(t, err)
  5681. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  5682. assert.NoError(t, err)
  5683. _, err = httpdtest.RemoveUser(sftpUser, http.StatusOK)
  5684. assert.NoError(t, err)
  5685. _, err = httpdtest.RemoveUser(localUser, http.StatusOK)
  5686. assert.NoError(t, err)
  5687. err = os.RemoveAll(localUser.GetHomeDir())
  5688. assert.NoError(t, err)
  5689. _, err = httpdtest.RemoveUser(cryptFsUser, http.StatusOK)
  5690. assert.NoError(t, err)
  5691. err = os.RemoveAll(cryptFsUser.GetHomeDir())
  5692. assert.NoError(t, err)
  5693. smtpCfg = smtp.Config{}
  5694. err = smtpCfg.Initialize(configDir, true)
  5695. require.NoError(t, err)
  5696. }
  5697. func TestEventActionsRetentionReports(t *testing.T) {
  5698. smtpCfg := smtp.Config{
  5699. Host: "127.0.0.1",
  5700. Port: 2525,
  5701. From: "notify@example.com",
  5702. TemplatesPath: "templates",
  5703. }
  5704. err := smtpCfg.Initialize(configDir, true)
  5705. require.NoError(t, err)
  5706. testDir := "/d"
  5707. a1 := dataprovider.BaseEventAction{
  5708. Name: "action1",
  5709. Type: dataprovider.ActionTypeDataRetentionCheck,
  5710. Options: dataprovider.BaseEventActionOptions{
  5711. RetentionConfig: dataprovider.EventActionDataRetentionConfig{
  5712. Folders: []dataprovider.FolderRetention{
  5713. {
  5714. Path: testDir,
  5715. Retention: 1,
  5716. DeleteEmptyDirs: true,
  5717. IgnoreUserPermissions: true,
  5718. },
  5719. },
  5720. },
  5721. },
  5722. }
  5723. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  5724. assert.NoError(t, err)
  5725. a2 := dataprovider.BaseEventAction{
  5726. Name: "action2",
  5727. Type: dataprovider.ActionTypeEmail,
  5728. Options: dataprovider.BaseEventActionOptions{
  5729. EmailConfig: dataprovider.EventActionEmailConfig{
  5730. Recipients: []string{"test@example.com"},
  5731. Subject: `"{{Event}}" from "{{Name}}"`,
  5732. Body: "Fs path {{FsPath}}, size: {{FileSize}}, protocol: {{Protocol}}, IP: {{IP}}",
  5733. Attachments: []string{dataprovider.RetentionReportPlaceHolder},
  5734. },
  5735. },
  5736. }
  5737. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  5738. assert.NoError(t, err)
  5739. a3 := dataprovider.BaseEventAction{
  5740. Name: "action3",
  5741. Type: dataprovider.ActionTypeHTTP,
  5742. Options: dataprovider.BaseEventActionOptions{
  5743. HTTPConfig: dataprovider.EventActionHTTPConfig{
  5744. Endpoint: fmt.Sprintf("http://%s/", httpAddr),
  5745. Timeout: 20,
  5746. Method: http.MethodPost,
  5747. Body: dataprovider.RetentionReportPlaceHolder,
  5748. },
  5749. },
  5750. }
  5751. action3, _, err := httpdtest.AddEventAction(a3, http.StatusCreated)
  5752. assert.NoError(t, err)
  5753. a4 := dataprovider.BaseEventAction{
  5754. Name: "action4",
  5755. Type: dataprovider.ActionTypeHTTP,
  5756. Options: dataprovider.BaseEventActionOptions{
  5757. HTTPConfig: dataprovider.EventActionHTTPConfig{
  5758. Endpoint: fmt.Sprintf("http://%s/multipart", httpAddr),
  5759. Timeout: 20,
  5760. Method: http.MethodPost,
  5761. Parts: []dataprovider.HTTPPart{
  5762. {
  5763. Name: "reports.zip",
  5764. Filepath: dataprovider.RetentionReportPlaceHolder,
  5765. },
  5766. },
  5767. },
  5768. },
  5769. }
  5770. action4, _, err := httpdtest.AddEventAction(a4, http.StatusCreated)
  5771. assert.NoError(t, err)
  5772. r1 := dataprovider.EventRule{
  5773. Name: "test rule1",
  5774. Status: 1,
  5775. Trigger: dataprovider.EventTriggerFsEvent,
  5776. Conditions: dataprovider.EventConditions{
  5777. FsEvents: []string{"upload"},
  5778. },
  5779. Actions: []dataprovider.EventAction{
  5780. {
  5781. BaseEventAction: dataprovider.BaseEventAction{
  5782. Name: action1.Name,
  5783. },
  5784. Order: 1,
  5785. Options: dataprovider.EventActionOptions{
  5786. ExecuteSync: true,
  5787. StopOnFailure: true,
  5788. },
  5789. },
  5790. {
  5791. BaseEventAction: dataprovider.BaseEventAction{
  5792. Name: action2.Name,
  5793. },
  5794. Order: 2,
  5795. Options: dataprovider.EventActionOptions{
  5796. ExecuteSync: true,
  5797. StopOnFailure: true,
  5798. },
  5799. },
  5800. {
  5801. BaseEventAction: dataprovider.BaseEventAction{
  5802. Name: action3.Name,
  5803. },
  5804. Order: 3,
  5805. Options: dataprovider.EventActionOptions{
  5806. ExecuteSync: true,
  5807. StopOnFailure: true,
  5808. },
  5809. },
  5810. {
  5811. BaseEventAction: dataprovider.BaseEventAction{
  5812. Name: action4.Name,
  5813. },
  5814. Order: 4,
  5815. Options: dataprovider.EventActionOptions{
  5816. ExecuteSync: true,
  5817. StopOnFailure: true,
  5818. },
  5819. },
  5820. },
  5821. }
  5822. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  5823. assert.NoError(t, err)
  5824. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  5825. assert.NoError(t, err)
  5826. conn, client, err := getSftpClient(user)
  5827. if assert.NoError(t, err) {
  5828. defer conn.Close()
  5829. defer client.Close()
  5830. subdir := path.Join(testDir, "sub")
  5831. err = client.MkdirAll(subdir)
  5832. assert.NoError(t, err)
  5833. lastReceivedEmail.reset()
  5834. f, err := client.Create(testFileName)
  5835. assert.NoError(t, err)
  5836. _, err = f.Write(testFileContent)
  5837. assert.NoError(t, err)
  5838. err = f.Close()
  5839. assert.NoError(t, err)
  5840. email := lastReceivedEmail.get()
  5841. assert.Len(t, email.To, 1)
  5842. assert.True(t, util.Contains(email.To, "test@example.com"))
  5843. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "upload" from "%s"`, user.Username))
  5844. assert.Contains(t, email.Data, "Content-Disposition: attachment")
  5845. _, err = client.Stat(testDir)
  5846. assert.NoError(t, err)
  5847. _, err = client.Stat(subdir)
  5848. assert.ErrorIs(t, err, os.ErrNotExist)
  5849. err = client.Mkdir(subdir)
  5850. assert.NoError(t, err)
  5851. newName := path.Join(testDir, testFileName)
  5852. err = client.Rename(testFileName, newName)
  5853. assert.NoError(t, err)
  5854. err = client.Chtimes(newName, time.Now().Add(-24*time.Hour), time.Now().Add(-24*time.Hour))
  5855. assert.NoError(t, err)
  5856. lastReceivedEmail.reset()
  5857. f, err = client.Create(testFileName)
  5858. assert.NoError(t, err)
  5859. _, err = f.Write(testFileContent)
  5860. assert.NoError(t, err)
  5861. err = f.Close()
  5862. assert.NoError(t, err)
  5863. email = lastReceivedEmail.get()
  5864. assert.Len(t, email.To, 1)
  5865. _, err = client.Stat(subdir)
  5866. assert.ErrorIs(t, err, os.ErrNotExist)
  5867. _, err = client.Stat(subdir)
  5868. assert.ErrorIs(t, err, os.ErrNotExist)
  5869. }
  5870. // now remove the retention check to test errors
  5871. rule1.Actions = []dataprovider.EventAction{
  5872. {
  5873. BaseEventAction: dataprovider.BaseEventAction{
  5874. Name: action2.Name,
  5875. },
  5876. Order: 2,
  5877. Options: dataprovider.EventActionOptions{
  5878. ExecuteSync: true,
  5879. StopOnFailure: false,
  5880. },
  5881. },
  5882. {
  5883. BaseEventAction: dataprovider.BaseEventAction{
  5884. Name: action3.Name,
  5885. },
  5886. Order: 3,
  5887. Options: dataprovider.EventActionOptions{
  5888. ExecuteSync: true,
  5889. StopOnFailure: false,
  5890. },
  5891. },
  5892. {
  5893. BaseEventAction: dataprovider.BaseEventAction{
  5894. Name: action4.Name,
  5895. },
  5896. Order: 4,
  5897. Options: dataprovider.EventActionOptions{
  5898. ExecuteSync: true,
  5899. StopOnFailure: false,
  5900. },
  5901. },
  5902. }
  5903. _, _, err = httpdtest.UpdateEventRule(rule1, http.StatusOK)
  5904. assert.NoError(t, err)
  5905. conn, client, err = getSftpClient(user)
  5906. if assert.NoError(t, err) {
  5907. defer conn.Close()
  5908. defer client.Close()
  5909. f, err := client.Create(testFileName)
  5910. assert.NoError(t, err)
  5911. _, err = f.Write(testFileContent)
  5912. assert.NoError(t, err)
  5913. err = f.Close()
  5914. assert.Error(t, err)
  5915. }
  5916. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  5917. assert.NoError(t, err)
  5918. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  5919. assert.NoError(t, err)
  5920. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  5921. assert.NoError(t, err)
  5922. _, err = httpdtest.RemoveEventAction(action3, http.StatusOK)
  5923. assert.NoError(t, err)
  5924. _, err = httpdtest.RemoveEventAction(action4, http.StatusOK)
  5925. assert.NoError(t, err)
  5926. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  5927. assert.NoError(t, err)
  5928. err = os.RemoveAll(user.GetHomeDir())
  5929. assert.NoError(t, err)
  5930. smtpCfg = smtp.Config{}
  5931. err = smtpCfg.Initialize(configDir, true)
  5932. require.NoError(t, err)
  5933. }
  5934. func TestEventRuleFirstUploadDownloadActions(t *testing.T) {
  5935. smtpCfg := smtp.Config{
  5936. Host: "127.0.0.1",
  5937. Port: 2525,
  5938. From: "notify@example.com",
  5939. TemplatesPath: "templates",
  5940. }
  5941. err := smtpCfg.Initialize(configDir, true)
  5942. require.NoError(t, err)
  5943. a1 := dataprovider.BaseEventAction{
  5944. Name: "action1",
  5945. Type: dataprovider.ActionTypeEmail,
  5946. Options: dataprovider.BaseEventActionOptions{
  5947. EmailConfig: dataprovider.EventActionEmailConfig{
  5948. Recipients: []string{"test@example.com"},
  5949. Subject: `"{{Event}}" from "{{Name}}"`,
  5950. Body: "Fs path {{FsPath}}, size: {{FileSize}}, protocol: {{Protocol}}, IP: {{IP}}",
  5951. },
  5952. },
  5953. }
  5954. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  5955. assert.NoError(t, err)
  5956. r1 := dataprovider.EventRule{
  5957. Name: "test first upload rule",
  5958. Status: 1,
  5959. Trigger: dataprovider.EventTriggerFsEvent,
  5960. Conditions: dataprovider.EventConditions{
  5961. FsEvents: []string{"first-upload"},
  5962. },
  5963. Actions: []dataprovider.EventAction{
  5964. {
  5965. BaseEventAction: dataprovider.BaseEventAction{
  5966. Name: action1.Name,
  5967. },
  5968. Order: 1,
  5969. },
  5970. },
  5971. }
  5972. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  5973. assert.NoError(t, err)
  5974. r2 := dataprovider.EventRule{
  5975. Name: "test first download rule",
  5976. Status: 1,
  5977. Trigger: dataprovider.EventTriggerFsEvent,
  5978. Conditions: dataprovider.EventConditions{
  5979. FsEvents: []string{"first-download"},
  5980. },
  5981. Actions: []dataprovider.EventAction{
  5982. {
  5983. BaseEventAction: dataprovider.BaseEventAction{
  5984. Name: action1.Name,
  5985. },
  5986. Order: 1,
  5987. },
  5988. },
  5989. }
  5990. rule2, _, err := httpdtest.AddEventRule(r2, http.StatusCreated)
  5991. assert.NoError(t, err)
  5992. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  5993. assert.NoError(t, err)
  5994. conn, client, err := getSftpClient(user)
  5995. if assert.NoError(t, err) {
  5996. defer conn.Close()
  5997. defer client.Close()
  5998. testFileSize := int64(32768)
  5999. lastReceivedEmail.reset()
  6000. err = writeSFTPFileNoCheck(testFileName, testFileSize, client)
  6001. assert.NoError(t, err)
  6002. assert.Eventually(t, func() bool {
  6003. return lastReceivedEmail.get().From != ""
  6004. }, 1500*time.Millisecond, 100*time.Millisecond)
  6005. email := lastReceivedEmail.get()
  6006. assert.Len(t, email.To, 1)
  6007. assert.True(t, util.Contains(email.To, "test@example.com"))
  6008. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "first-upload" from "%s"`, user.Username))
  6009. lastReceivedEmail.reset()
  6010. // a new upload will not produce a new notification
  6011. err = writeSFTPFileNoCheck(testFileName+"_1", 32768, client)
  6012. assert.NoError(t, err)
  6013. assert.Never(t, func() bool {
  6014. return lastReceivedEmail.get().From != ""
  6015. }, 1000*time.Millisecond, 100*time.Millisecond)
  6016. // the same for download
  6017. f, err := client.Open(testFileName)
  6018. assert.NoError(t, err)
  6019. contents := make([]byte, testFileSize)
  6020. n, err := io.ReadFull(f, contents)
  6021. assert.NoError(t, err)
  6022. assert.Equal(t, int(testFileSize), n)
  6023. err = f.Close()
  6024. assert.NoError(t, err)
  6025. assert.Eventually(t, func() bool {
  6026. return lastReceivedEmail.get().From != ""
  6027. }, 1500*time.Millisecond, 100*time.Millisecond)
  6028. email = lastReceivedEmail.get()
  6029. assert.Len(t, email.To, 1)
  6030. assert.True(t, util.Contains(email.To, "test@example.com"))
  6031. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "first-download" from "%s"`, user.Username))
  6032. // download again
  6033. lastReceivedEmail.reset()
  6034. f, err = client.Open(testFileName)
  6035. assert.NoError(t, err)
  6036. contents = make([]byte, testFileSize)
  6037. n, err = io.ReadFull(f, contents)
  6038. assert.NoError(t, err)
  6039. assert.Equal(t, int(testFileSize), n)
  6040. err = f.Close()
  6041. assert.NoError(t, err)
  6042. assert.Never(t, func() bool {
  6043. return lastReceivedEmail.get().From != ""
  6044. }, 1000*time.Millisecond, 100*time.Millisecond)
  6045. }
  6046. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  6047. assert.NoError(t, err)
  6048. _, err = httpdtest.RemoveEventRule(rule2, http.StatusOK)
  6049. assert.NoError(t, err)
  6050. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  6051. assert.NoError(t, err)
  6052. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  6053. assert.NoError(t, err)
  6054. err = os.RemoveAll(user.GetHomeDir())
  6055. assert.NoError(t, err)
  6056. smtpCfg = smtp.Config{}
  6057. err = smtpCfg.Initialize(configDir, true)
  6058. require.NoError(t, err)
  6059. }
  6060. func TestEventRuleRenameEvent(t *testing.T) {
  6061. smtpCfg := smtp.Config{
  6062. Host: "127.0.0.1",
  6063. Port: 2525,
  6064. From: "notify@example.com",
  6065. TemplatesPath: "templates",
  6066. }
  6067. err := smtpCfg.Initialize(configDir, true)
  6068. require.NoError(t, err)
  6069. a1 := dataprovider.BaseEventAction{
  6070. Name: "action1",
  6071. Type: dataprovider.ActionTypeEmail,
  6072. Options: dataprovider.BaseEventActionOptions{
  6073. EmailConfig: dataprovider.EventActionEmailConfig{
  6074. Recipients: []string{"test@example.com"},
  6075. Subject: `"{{Event}}" from "{{Name}}"`,
  6076. ContentType: 1,
  6077. Body: `<p>Fs path {{FsPath}}, Target path "{{VirtualTargetDirPath}}/{{TargetName}}", size: {{FileSize}}</p>`,
  6078. },
  6079. },
  6080. }
  6081. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  6082. assert.NoError(t, err)
  6083. r1 := dataprovider.EventRule{
  6084. Name: "test rename rule",
  6085. Status: 1,
  6086. Trigger: dataprovider.EventTriggerFsEvent,
  6087. Conditions: dataprovider.EventConditions{
  6088. FsEvents: []string{"rename"},
  6089. },
  6090. Actions: []dataprovider.EventAction{
  6091. {
  6092. BaseEventAction: dataprovider.BaseEventAction{
  6093. Name: action1.Name,
  6094. },
  6095. Order: 1,
  6096. },
  6097. },
  6098. }
  6099. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  6100. assert.NoError(t, err)
  6101. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  6102. assert.NoError(t, err)
  6103. conn, client, err := getSftpClient(user)
  6104. if assert.NoError(t, err) {
  6105. defer conn.Close()
  6106. defer client.Close()
  6107. testFileSize := int64(32768)
  6108. lastReceivedEmail.reset()
  6109. err = writeSFTPFileNoCheck(testFileName, testFileSize, client)
  6110. assert.NoError(t, err)
  6111. err = client.Mkdir("subdir")
  6112. assert.NoError(t, err)
  6113. err = client.Rename(testFileName, path.Join("/subdir", testFileName))
  6114. assert.NoError(t, err)
  6115. assert.Eventually(t, func() bool {
  6116. return lastReceivedEmail.get().From != ""
  6117. }, 1500*time.Millisecond, 100*time.Millisecond)
  6118. email := lastReceivedEmail.get()
  6119. assert.Len(t, email.To, 1)
  6120. assert.True(t, util.Contains(email.To, "test@example.com"))
  6121. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "rename" from "%s"`, user.Username))
  6122. assert.Contains(t, email.Data, "Content-Type: text/html")
  6123. assert.Contains(t, email.Data, fmt.Sprintf("Target path %q", path.Join("/subdir", testFileName)))
  6124. }
  6125. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  6126. assert.NoError(t, err)
  6127. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  6128. assert.NoError(t, err)
  6129. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  6130. assert.NoError(t, err)
  6131. err = os.RemoveAll(user.GetHomeDir())
  6132. assert.NoError(t, err)
  6133. smtpCfg = smtp.Config{}
  6134. err = smtpCfg.Initialize(configDir, true)
  6135. require.NoError(t, err)
  6136. }
  6137. func TestEventRuleIDPLogin(t *testing.T) {
  6138. smtpCfg := smtp.Config{
  6139. Host: "127.0.0.1",
  6140. Port: 2525,
  6141. From: "notify@example.com",
  6142. TemplatesPath: "templates",
  6143. }
  6144. err := smtpCfg.Initialize(configDir, true)
  6145. require.NoError(t, err)
  6146. lastReceivedEmail.reset()
  6147. username := `test_"idp_"login`
  6148. custom1 := `cust"oa"1`
  6149. u := map[string]any{
  6150. "username": "{{Name}}",
  6151. "status": 1,
  6152. "home_dir": filepath.Join(os.TempDir(), "{{IDPFieldcustom1}}"),
  6153. "permissions": map[string][]string{
  6154. "/": {dataprovider.PermAny},
  6155. },
  6156. }
  6157. userTmpl, err := json.Marshal(u)
  6158. require.NoError(t, err)
  6159. a := map[string]any{
  6160. "username": "{{Name}}",
  6161. "status": 1,
  6162. "permissions": []string{dataprovider.PermAdminAny},
  6163. }
  6164. adminTmpl, err := json.Marshal(a)
  6165. require.NoError(t, err)
  6166. a1 := dataprovider.BaseEventAction{
  6167. Name: "a1",
  6168. Type: dataprovider.ActionTypeIDPAccountCheck,
  6169. Options: dataprovider.BaseEventActionOptions{
  6170. IDPConfig: dataprovider.EventActionIDPAccountCheck{
  6171. Mode: 1, // create if not exists
  6172. TemplateUser: string(userTmpl),
  6173. TemplateAdmin: string(adminTmpl),
  6174. },
  6175. },
  6176. }
  6177. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  6178. assert.NoError(t, err)
  6179. a2 := dataprovider.BaseEventAction{
  6180. Name: "a2",
  6181. Type: dataprovider.ActionTypeEmail,
  6182. Options: dataprovider.BaseEventActionOptions{
  6183. EmailConfig: dataprovider.EventActionEmailConfig{
  6184. Recipients: []string{"test@example.com"},
  6185. Subject: `"{{Event}} {{StatusString}}"`,
  6186. Body: "{{Name}} Custom field: {{IDPFieldcustom1}}",
  6187. },
  6188. },
  6189. }
  6190. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  6191. assert.NoError(t, err)
  6192. r1 := dataprovider.EventRule{
  6193. Name: "test rule IDP login",
  6194. Status: 1,
  6195. Trigger: dataprovider.EventTriggerIDPLogin,
  6196. Conditions: dataprovider.EventConditions{
  6197. IDPLoginEvent: dataprovider.IDPLoginUser,
  6198. },
  6199. Actions: []dataprovider.EventAction{
  6200. {
  6201. BaseEventAction: dataprovider.BaseEventAction{
  6202. Name: action1.Name, // the rule is not sync and will be skipped
  6203. },
  6204. Order: 1,
  6205. },
  6206. {
  6207. BaseEventAction: dataprovider.BaseEventAction{
  6208. Name: action2.Name,
  6209. },
  6210. Order: 2,
  6211. },
  6212. },
  6213. }
  6214. rule1, resp, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  6215. assert.NoError(t, err, string(resp))
  6216. customFields := map[string]any{
  6217. "custom1": custom1,
  6218. }
  6219. user, admin, err := common.HandleIDPLoginEvent(common.EventParams{
  6220. Name: username,
  6221. Event: common.IDPLoginUser,
  6222. Status: 1,
  6223. }, &customFields)
  6224. assert.Nil(t, user)
  6225. assert.Nil(t, admin)
  6226. assert.NoError(t, err)
  6227. rule1.Actions[0].Options.ExecuteSync = true
  6228. rule1, resp, err = httpdtest.UpdateEventRule(rule1, http.StatusOK)
  6229. assert.NoError(t, err, string(resp))
  6230. user, admin, err = common.HandleIDPLoginEvent(common.EventParams{
  6231. Name: username,
  6232. Event: common.IDPLoginUser,
  6233. Status: 1,
  6234. }, &customFields)
  6235. if assert.NotNil(t, user) {
  6236. assert.Equal(t, filepath.Join(os.TempDir(), custom1), user.GetHomeDir())
  6237. _, err = httpdtest.RemoveUser(*user, http.StatusOK)
  6238. assert.NoError(t, err)
  6239. }
  6240. assert.Nil(t, admin)
  6241. assert.NoError(t, err)
  6242. assert.Eventually(t, func() bool {
  6243. return lastReceivedEmail.get().From != ""
  6244. }, 3000*time.Millisecond, 100*time.Millisecond)
  6245. email := lastReceivedEmail.get()
  6246. assert.Len(t, email.To, 1)
  6247. assert.True(t, util.Contains(email.To, "test@example.com"))
  6248. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "%s OK"`, common.IDPLoginUser))
  6249. assert.Contains(t, email.Data, username)
  6250. assert.Contains(t, email.Data, custom1)
  6251. user, admin, err = common.HandleIDPLoginEvent(common.EventParams{
  6252. Name: username,
  6253. Event: common.IDPLoginAdmin,
  6254. Status: 1,
  6255. }, &customFields)
  6256. assert.Nil(t, user)
  6257. assert.Nil(t, admin)
  6258. assert.NoError(t, err)
  6259. rule1.Conditions.IDPLoginEvent = dataprovider.IDPLoginAny
  6260. rule1.Actions = []dataprovider.EventAction{
  6261. {
  6262. BaseEventAction: dataprovider.BaseEventAction{
  6263. Name: action1.Name,
  6264. },
  6265. Options: dataprovider.EventActionOptions{
  6266. ExecuteSync: true,
  6267. },
  6268. Order: 1,
  6269. },
  6270. }
  6271. rule1, _, err = httpdtest.UpdateEventRule(rule1, http.StatusOK)
  6272. assert.NoError(t, err)
  6273. r2 := dataprovider.EventRule{
  6274. Name: "test email on IDP login",
  6275. Status: 1,
  6276. Trigger: dataprovider.EventTriggerIDPLogin,
  6277. Conditions: dataprovider.EventConditions{
  6278. IDPLoginEvent: dataprovider.IDPLoginAdmin,
  6279. },
  6280. Actions: []dataprovider.EventAction{
  6281. {
  6282. BaseEventAction: dataprovider.BaseEventAction{
  6283. Name: action2.Name,
  6284. },
  6285. Order: 1,
  6286. },
  6287. },
  6288. }
  6289. rule2, resp, err := httpdtest.AddEventRule(r2, http.StatusCreated)
  6290. assert.NoError(t, err, string(resp))
  6291. lastReceivedEmail.reset()
  6292. user, admin, err = common.HandleIDPLoginEvent(common.EventParams{
  6293. Name: username,
  6294. Event: common.IDPLoginAdmin,
  6295. Status: 1,
  6296. }, &customFields)
  6297. assert.Nil(t, user)
  6298. if assert.NotNil(t, admin) {
  6299. assert.Equal(t, 1, admin.Status)
  6300. }
  6301. assert.NoError(t, err)
  6302. assert.Eventually(t, func() bool {
  6303. return lastReceivedEmail.get().From != ""
  6304. }, 3000*time.Millisecond, 100*time.Millisecond)
  6305. email = lastReceivedEmail.get()
  6306. assert.Len(t, email.To, 1)
  6307. assert.True(t, util.Contains(email.To, "test@example.com"))
  6308. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "%s OK"`, common.IDPLoginAdmin))
  6309. assert.Contains(t, email.Data, username)
  6310. assert.Contains(t, email.Data, custom1)
  6311. admin.Status = 0
  6312. _, _, err = httpdtest.UpdateAdmin(*admin, http.StatusOK)
  6313. assert.NoError(t, err)
  6314. user, admin, err = common.HandleIDPLoginEvent(common.EventParams{
  6315. Name: username,
  6316. Event: common.IDPLoginAdmin,
  6317. Status: 1,
  6318. }, &customFields)
  6319. assert.Nil(t, user)
  6320. if assert.NotNil(t, admin) {
  6321. assert.Equal(t, 0, admin.Status)
  6322. }
  6323. assert.NoError(t, err)
  6324. action1.Options.IDPConfig.Mode = 0
  6325. action1, _, err = httpdtest.UpdateEventAction(action1, http.StatusOK)
  6326. assert.NoError(t, err)
  6327. user, admin, err = common.HandleIDPLoginEvent(common.EventParams{
  6328. Name: username,
  6329. Event: common.IDPLoginAdmin,
  6330. Status: 1,
  6331. }, &customFields)
  6332. assert.Nil(t, user)
  6333. if assert.NotNil(t, admin) {
  6334. assert.Equal(t, 1, admin.Status)
  6335. }
  6336. assert.NoError(t, err)
  6337. _, err = httpdtest.RemoveAdmin(*admin, http.StatusOK)
  6338. assert.NoError(t, err)
  6339. r3 := dataprovider.EventRule{
  6340. Name: "test rule2 IDP login",
  6341. Status: 1,
  6342. Trigger: dataprovider.EventTriggerIDPLogin,
  6343. Conditions: dataprovider.EventConditions{
  6344. IDPLoginEvent: dataprovider.IDPLoginAny,
  6345. },
  6346. Actions: []dataprovider.EventAction{
  6347. {
  6348. BaseEventAction: dataprovider.BaseEventAction{
  6349. Name: action1.Name,
  6350. },
  6351. Order: 1,
  6352. Options: dataprovider.EventActionOptions{
  6353. ExecuteSync: true,
  6354. },
  6355. },
  6356. },
  6357. }
  6358. rule3, resp, err := httpdtest.AddEventRule(r3, http.StatusCreated)
  6359. assert.NoError(t, err, string(resp))
  6360. user, admin, err = common.HandleIDPLoginEvent(common.EventParams{
  6361. Name: username,
  6362. Event: common.IDPLoginAdmin,
  6363. Status: 1,
  6364. }, &customFields)
  6365. assert.Nil(t, user)
  6366. assert.Nil(t, admin)
  6367. if assert.Error(t, err) {
  6368. assert.Contains(t, err.Error(), "more than one account check action rules matches")
  6369. }
  6370. _, err = httpdtest.RemoveEventRule(rule3, http.StatusOK)
  6371. assert.NoError(t, err)
  6372. action1.Options.IDPConfig.TemplateAdmin = `{}`
  6373. action1, _, err = httpdtest.UpdateEventAction(action1, http.StatusOK)
  6374. assert.NoError(t, err)
  6375. _, _, err = common.HandleIDPLoginEvent(common.EventParams{
  6376. Name: username,
  6377. Event: common.IDPLoginAdmin,
  6378. Status: 1,
  6379. }, &customFields)
  6380. assert.ErrorIs(t, err, util.ErrValidation)
  6381. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  6382. assert.NoError(t, err)
  6383. user, admin, err = common.HandleIDPLoginEvent(common.EventParams{
  6384. Name: username,
  6385. Event: common.IDPLoginAdmin,
  6386. Status: 1,
  6387. }, &customFields)
  6388. assert.Nil(t, user)
  6389. assert.Nil(t, admin)
  6390. assert.NoError(t, err)
  6391. _, err = httpdtest.RemoveEventRule(rule2, http.StatusOK)
  6392. assert.NoError(t, err)
  6393. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  6394. assert.NoError(t, err)
  6395. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  6396. assert.NoError(t, err)
  6397. smtpCfg = smtp.Config{}
  6398. err = smtpCfg.Initialize(configDir, true)
  6399. require.NoError(t, err)
  6400. }
  6401. func TestEventRuleEmailField(t *testing.T) {
  6402. smtpCfg := smtp.Config{
  6403. Host: "127.0.0.1",
  6404. Port: 2525,
  6405. From: "notify@example.com",
  6406. TemplatesPath: "templates",
  6407. }
  6408. err := smtpCfg.Initialize(configDir, true)
  6409. require.NoError(t, err)
  6410. lastReceivedEmail.reset()
  6411. a1 := dataprovider.BaseEventAction{
  6412. Name: "action1",
  6413. Type: dataprovider.ActionTypeEmail,
  6414. Options: dataprovider.BaseEventActionOptions{
  6415. EmailConfig: dataprovider.EventActionEmailConfig{
  6416. Recipients: []string{"{{Email}}"},
  6417. Subject: `"{{Event}}" from "{{Name}}"`,
  6418. Body: "Sample email body",
  6419. },
  6420. },
  6421. }
  6422. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  6423. assert.NoError(t, err)
  6424. a2 := dataprovider.BaseEventAction{
  6425. Name: "action2",
  6426. Type: dataprovider.ActionTypeEmail,
  6427. Options: dataprovider.BaseEventActionOptions{
  6428. EmailConfig: dataprovider.EventActionEmailConfig{
  6429. Recipients: []string{"failure@example.com"},
  6430. Subject: `"Failure`,
  6431. Body: "{{ErrorString}}",
  6432. },
  6433. },
  6434. }
  6435. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  6436. assert.NoError(t, err)
  6437. r1 := dataprovider.EventRule{
  6438. Name: "r1",
  6439. Status: 1,
  6440. Trigger: dataprovider.EventTriggerFsEvent,
  6441. Conditions: dataprovider.EventConditions{
  6442. FsEvents: []string{"mkdir"},
  6443. },
  6444. Actions: []dataprovider.EventAction{
  6445. {
  6446. BaseEventAction: dataprovider.BaseEventAction{
  6447. Name: action1.Name,
  6448. },
  6449. },
  6450. },
  6451. }
  6452. r2 := dataprovider.EventRule{
  6453. Name: "test rule2",
  6454. Status: 1,
  6455. Trigger: dataprovider.EventTriggerProviderEvent,
  6456. Conditions: dataprovider.EventConditions{
  6457. ProviderEvents: []string{"add"},
  6458. },
  6459. Actions: []dataprovider.EventAction{
  6460. {
  6461. BaseEventAction: dataprovider.BaseEventAction{
  6462. Name: action1.Name,
  6463. },
  6464. Order: 1,
  6465. },
  6466. {
  6467. BaseEventAction: dataprovider.BaseEventAction{
  6468. Name: action2.Name,
  6469. },
  6470. Options: dataprovider.EventActionOptions{
  6471. IsFailureAction: true,
  6472. },
  6473. },
  6474. },
  6475. }
  6476. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  6477. assert.NoError(t, err)
  6478. rule2, _, err := httpdtest.AddEventRule(r2, http.StatusCreated)
  6479. assert.NoError(t, err)
  6480. u := getTestUser()
  6481. u.Email = "user@example.com"
  6482. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  6483. assert.NoError(t, err)
  6484. assert.Eventually(t, func() bool {
  6485. return lastReceivedEmail.get().From != ""
  6486. }, 3000*time.Millisecond, 100*time.Millisecond)
  6487. email := lastReceivedEmail.get()
  6488. assert.Len(t, email.To, 1)
  6489. assert.True(t, util.Contains(email.To, user.Email))
  6490. assert.Contains(t, email.Data, `Subject: "add" from "admin"`)
  6491. // if we add a user without email the notification will fail
  6492. lastReceivedEmail.reset()
  6493. u1 := getTestUser()
  6494. u1.Username += "_1"
  6495. user1, _, err := httpdtest.AddUser(u1, http.StatusCreated)
  6496. assert.NoError(t, err)
  6497. assert.Eventually(t, func() bool {
  6498. return lastReceivedEmail.get().From != ""
  6499. }, 3000*time.Millisecond, 100*time.Millisecond)
  6500. email = lastReceivedEmail.get()
  6501. assert.Len(t, email.To, 1)
  6502. assert.True(t, util.Contains(email.To, "failure@example.com"))
  6503. assert.Contains(t, email.Data, `no recipient addresses set`)
  6504. conn, client, err := getSftpClient(user)
  6505. if assert.NoError(t, err) {
  6506. defer conn.Close()
  6507. defer client.Close()
  6508. lastReceivedEmail.reset()
  6509. err = client.Mkdir(testFileName)
  6510. assert.NoError(t, err)
  6511. assert.Eventually(t, func() bool {
  6512. return lastReceivedEmail.get().From != ""
  6513. }, 3000*time.Millisecond, 100*time.Millisecond)
  6514. email := lastReceivedEmail.get()
  6515. assert.Len(t, email.To, 1)
  6516. assert.True(t, util.Contains(email.To, user.Email))
  6517. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "mkdir" from "%s"`, user.Username))
  6518. }
  6519. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  6520. assert.NoError(t, err)
  6521. _, err = httpdtest.RemoveEventRule(rule2, http.StatusOK)
  6522. assert.NoError(t, err)
  6523. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  6524. assert.NoError(t, err)
  6525. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  6526. assert.NoError(t, err)
  6527. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  6528. assert.NoError(t, err)
  6529. err = os.RemoveAll(user.GetHomeDir())
  6530. assert.NoError(t, err)
  6531. _, err = httpdtest.RemoveUser(user1, http.StatusOK)
  6532. assert.NoError(t, err)
  6533. smtpCfg = smtp.Config{}
  6534. err = smtpCfg.Initialize(configDir, true)
  6535. require.NoError(t, err)
  6536. }
  6537. func TestEventRuleCertificate(t *testing.T) {
  6538. smtpCfg := smtp.Config{
  6539. Host: "127.0.0.1",
  6540. Port: 2525,
  6541. From: "notify@example.com",
  6542. TemplatesPath: "templates",
  6543. }
  6544. err := smtpCfg.Initialize(configDir, true)
  6545. require.NoError(t, err)
  6546. lastReceivedEmail.reset()
  6547. a1 := dataprovider.BaseEventAction{
  6548. Name: "action1",
  6549. Type: dataprovider.ActionTypeEmail,
  6550. Options: dataprovider.BaseEventActionOptions{
  6551. EmailConfig: dataprovider.EventActionEmailConfig{
  6552. Recipients: []string{"test@example.com"},
  6553. Subject: `"{{Event}} {{StatusString}}"`,
  6554. ContentType: 0,
  6555. Body: "Domain: {{Name}} Timestamp: {{Timestamp}} {{ErrorString}}",
  6556. },
  6557. },
  6558. }
  6559. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  6560. assert.NoError(t, err)
  6561. a2 := dataprovider.BaseEventAction{
  6562. Name: "action2",
  6563. Type: dataprovider.ActionTypeFolderQuotaReset,
  6564. }
  6565. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  6566. assert.NoError(t, err)
  6567. r1 := dataprovider.EventRule{
  6568. Name: "test rule certificate",
  6569. Status: 1,
  6570. Trigger: dataprovider.EventTriggerCertificate,
  6571. Actions: []dataprovider.EventAction{
  6572. {
  6573. BaseEventAction: dataprovider.BaseEventAction{
  6574. Name: action1.Name,
  6575. },
  6576. Order: 1,
  6577. },
  6578. },
  6579. }
  6580. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  6581. assert.NoError(t, err)
  6582. r2 := dataprovider.EventRule{
  6583. Name: "test rule 2",
  6584. Status: 1,
  6585. Trigger: dataprovider.EventTriggerCertificate,
  6586. Actions: []dataprovider.EventAction{
  6587. {
  6588. BaseEventAction: dataprovider.BaseEventAction{
  6589. Name: action1.Name,
  6590. },
  6591. Order: 1,
  6592. },
  6593. {
  6594. BaseEventAction: dataprovider.BaseEventAction{
  6595. Name: action2.Name,
  6596. },
  6597. Order: 2,
  6598. },
  6599. },
  6600. }
  6601. rule2, _, err := httpdtest.AddEventRule(r2, http.StatusCreated)
  6602. assert.NoError(t, err)
  6603. renewalEvent := "Certificate renewal"
  6604. common.HandleCertificateEvent(common.EventParams{
  6605. Name: "example.com",
  6606. Timestamp: time.Now().UnixNano(),
  6607. Status: 1,
  6608. Event: renewalEvent,
  6609. })
  6610. assert.Eventually(t, func() bool {
  6611. return lastReceivedEmail.get().From != ""
  6612. }, 3000*time.Millisecond, 100*time.Millisecond)
  6613. email := lastReceivedEmail.get()
  6614. assert.Len(t, email.To, 1)
  6615. assert.True(t, util.Contains(email.To, "test@example.com"))
  6616. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "%s OK"`, renewalEvent))
  6617. assert.Contains(t, email.Data, "Content-Type: text/plain")
  6618. assert.Contains(t, email.Data, `Domain: example.com Timestamp`)
  6619. lastReceivedEmail.reset()
  6620. params := common.EventParams{
  6621. Name: "example.com",
  6622. Timestamp: time.Now().UnixNano(),
  6623. Status: 2,
  6624. Event: renewalEvent,
  6625. }
  6626. errRenew := errors.New("generic renew error")
  6627. params.AddError(errRenew)
  6628. common.HandleCertificateEvent(params)
  6629. assert.Eventually(t, func() bool {
  6630. return lastReceivedEmail.get().From != ""
  6631. }, 3000*time.Millisecond, 100*time.Millisecond)
  6632. email = lastReceivedEmail.get()
  6633. assert.Len(t, email.To, 1)
  6634. assert.True(t, util.Contains(email.To, "test@example.com"))
  6635. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "%s KO"`, renewalEvent))
  6636. assert.Contains(t, email.Data, `Domain: example.com Timestamp`)
  6637. assert.Contains(t, email.Data, errRenew.Error())
  6638. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  6639. assert.NoError(t, err)
  6640. _, err = httpdtest.RemoveEventRule(rule2, http.StatusOK)
  6641. assert.NoError(t, err)
  6642. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  6643. assert.NoError(t, err)
  6644. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  6645. assert.NoError(t, err)
  6646. // ignored no more certificate rules
  6647. common.HandleCertificateEvent(common.EventParams{
  6648. Name: "example.com",
  6649. Timestamp: time.Now().UnixNano(),
  6650. Status: 1,
  6651. Event: renewalEvent,
  6652. })
  6653. smtpCfg = smtp.Config{}
  6654. err = smtpCfg.Initialize(configDir, true)
  6655. require.NoError(t, err)
  6656. }
  6657. func TestEventRuleIPBlocked(t *testing.T) {
  6658. oldConfig := config.GetCommonConfig()
  6659. cfg := config.GetCommonConfig()
  6660. cfg.DefenderConfig.Enabled = true
  6661. cfg.DefenderConfig.Threshold = 3
  6662. cfg.DefenderConfig.ScoreLimitExceeded = 2
  6663. err := common.Initialize(cfg, 0)
  6664. assert.NoError(t, err)
  6665. smtpCfg := smtp.Config{
  6666. Host: "127.0.0.1",
  6667. Port: 2525,
  6668. From: "notification@example.com",
  6669. TemplatesPath: "templates",
  6670. }
  6671. err = smtpCfg.Initialize(configDir, true)
  6672. require.NoError(t, err)
  6673. a1 := dataprovider.BaseEventAction{
  6674. Name: "action1",
  6675. Type: dataprovider.ActionTypeEmail,
  6676. Options: dataprovider.BaseEventActionOptions{
  6677. EmailConfig: dataprovider.EventActionEmailConfig{
  6678. Recipients: []string{"test3@example.com", "test4@example.com"},
  6679. Subject: `New "{{Event}}"`,
  6680. Body: "IP: {{IP}} Timestamp: {{Timestamp}}",
  6681. },
  6682. },
  6683. }
  6684. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  6685. assert.NoError(t, err)
  6686. a2 := dataprovider.BaseEventAction{
  6687. Name: "action2",
  6688. Type: dataprovider.ActionTypeFolderQuotaReset,
  6689. }
  6690. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  6691. assert.NoError(t, err)
  6692. r1 := dataprovider.EventRule{
  6693. Name: "test rule ip blocked",
  6694. Status: 1,
  6695. Trigger: dataprovider.EventTriggerIPBlocked,
  6696. Actions: []dataprovider.EventAction{
  6697. {
  6698. BaseEventAction: dataprovider.BaseEventAction{
  6699. Name: action1.Name,
  6700. },
  6701. Order: 1,
  6702. },
  6703. },
  6704. }
  6705. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  6706. assert.NoError(t, err)
  6707. r2 := dataprovider.EventRule{
  6708. Name: "test rule 2",
  6709. Status: 1,
  6710. Trigger: dataprovider.EventTriggerIPBlocked,
  6711. Actions: []dataprovider.EventAction{
  6712. {
  6713. BaseEventAction: dataprovider.BaseEventAction{
  6714. Name: action1.Name,
  6715. },
  6716. Order: 1,
  6717. },
  6718. {
  6719. BaseEventAction: dataprovider.BaseEventAction{
  6720. Name: action2.Name,
  6721. },
  6722. Order: 2,
  6723. },
  6724. },
  6725. }
  6726. rule2, _, err := httpdtest.AddEventRule(r2, http.StatusCreated)
  6727. assert.NoError(t, err)
  6728. u := getTestUser()
  6729. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  6730. assert.NoError(t, err)
  6731. lastReceivedEmail.reset()
  6732. time.Sleep(300 * time.Millisecond)
  6733. assert.Empty(t, lastReceivedEmail.get().From, lastReceivedEmail.get().Data)
  6734. for i := 0; i < 3; i++ {
  6735. user.Password = "wrong_pwd"
  6736. _, _, err = getSftpClient(user)
  6737. assert.Error(t, err)
  6738. }
  6739. // the client is now banned
  6740. user.Password = defaultPassword
  6741. _, _, err = getSftpClient(user)
  6742. assert.Error(t, err)
  6743. // check the email notification
  6744. assert.Eventually(t, func() bool {
  6745. return lastReceivedEmail.get().From != ""
  6746. }, 3000*time.Millisecond, 100*time.Millisecond)
  6747. email := lastReceivedEmail.get()
  6748. assert.Len(t, email.To, 2)
  6749. assert.True(t, util.Contains(email.To, "test3@example.com"))
  6750. assert.True(t, util.Contains(email.To, "test4@example.com"))
  6751. assert.Contains(t, email.Data, `Subject: New "IP Blocked"`)
  6752. err = dataprovider.DeleteEventRule(rule1.Name, "", "", "")
  6753. assert.NoError(t, err)
  6754. err = dataprovider.DeleteEventRule(rule2.Name, "", "", "")
  6755. assert.NoError(t, err)
  6756. err = dataprovider.DeleteEventAction(action1.Name, "", "", "")
  6757. assert.NoError(t, err)
  6758. err = dataprovider.DeleteEventAction(action2.Name, "", "", "")
  6759. assert.NoError(t, err)
  6760. err = dataprovider.DeleteUser(user.Username, "", "", "")
  6761. assert.NoError(t, err)
  6762. err = os.RemoveAll(user.GetHomeDir())
  6763. assert.NoError(t, err)
  6764. smtpCfg = smtp.Config{}
  6765. err = smtpCfg.Initialize(configDir, true)
  6766. require.NoError(t, err)
  6767. err = common.Initialize(oldConfig, 0)
  6768. assert.NoError(t, err)
  6769. }
  6770. func TestEventRulePasswordExpiration(t *testing.T) {
  6771. smtpCfg := smtp.Config{
  6772. Host: "127.0.0.1",
  6773. Port: 2525,
  6774. From: "notification@example.com",
  6775. TemplatesPath: "templates",
  6776. }
  6777. err := smtpCfg.Initialize(configDir, true)
  6778. require.NoError(t, err)
  6779. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  6780. assert.NoError(t, err)
  6781. a1 := dataprovider.BaseEventAction{
  6782. Name: "a1",
  6783. Type: dataprovider.ActionTypeEmail,
  6784. Options: dataprovider.BaseEventActionOptions{
  6785. EmailConfig: dataprovider.EventActionEmailConfig{
  6786. Recipients: []string{"failure@example.net"},
  6787. Subject: `Failure`,
  6788. Body: "Failure action",
  6789. },
  6790. },
  6791. }
  6792. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  6793. assert.NoError(t, err)
  6794. a2 := dataprovider.BaseEventAction{
  6795. Name: "a2",
  6796. Type: dataprovider.ActionTypePasswordExpirationCheck,
  6797. Options: dataprovider.BaseEventActionOptions{
  6798. PwdExpirationConfig: dataprovider.EventActionPasswordExpiration{
  6799. Threshold: 10,
  6800. },
  6801. },
  6802. }
  6803. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  6804. assert.NoError(t, err)
  6805. a3 := dataprovider.BaseEventAction{
  6806. Name: "a3",
  6807. Type: dataprovider.ActionTypeEmail,
  6808. Options: dataprovider.BaseEventActionOptions{
  6809. EmailConfig: dataprovider.EventActionEmailConfig{
  6810. Recipients: []string{"success@example.net"},
  6811. Subject: `OK`,
  6812. Body: "OK action",
  6813. },
  6814. },
  6815. }
  6816. action3, _, err := httpdtest.AddEventAction(a3, http.StatusCreated)
  6817. assert.NoError(t, err)
  6818. r1 := dataprovider.EventRule{
  6819. Name: "rule1",
  6820. Status: 1,
  6821. Trigger: dataprovider.EventTriggerFsEvent,
  6822. Conditions: dataprovider.EventConditions{
  6823. FsEvents: []string{"mkdir"},
  6824. },
  6825. Actions: []dataprovider.EventAction{
  6826. {
  6827. BaseEventAction: dataprovider.BaseEventAction{
  6828. Name: action2.Name,
  6829. },
  6830. Order: 1,
  6831. },
  6832. {
  6833. BaseEventAction: dataprovider.BaseEventAction{
  6834. Name: action3.Name,
  6835. },
  6836. Order: 2,
  6837. },
  6838. {
  6839. BaseEventAction: dataprovider.BaseEventAction{
  6840. Name: action1.Name,
  6841. },
  6842. Options: dataprovider.EventActionOptions{
  6843. IsFailureAction: true,
  6844. },
  6845. },
  6846. },
  6847. }
  6848. rule1, resp, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  6849. assert.NoError(t, err, string(resp))
  6850. dirName := "aTestDir"
  6851. conn, client, err := getSftpClient(user)
  6852. if assert.NoError(t, err) {
  6853. defer conn.Close()
  6854. defer client.Close()
  6855. lastReceivedEmail.reset()
  6856. err := client.Mkdir(dirName)
  6857. assert.NoError(t, err)
  6858. // the user has no password expiration, the check will be skipped and the ok action executed
  6859. assert.Eventually(t, func() bool {
  6860. return lastReceivedEmail.get().From != ""
  6861. }, 1500*time.Millisecond, 100*time.Millisecond)
  6862. email := lastReceivedEmail.get()
  6863. assert.Len(t, email.To, 1)
  6864. assert.Contains(t, email.To, "success@example.net")
  6865. err = client.RemoveDirectory(dirName)
  6866. assert.NoError(t, err)
  6867. }
  6868. user.Filters.PasswordExpiration = 20
  6869. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  6870. assert.NoError(t, err)
  6871. conn, client, err = getSftpClient(user)
  6872. if assert.NoError(t, err) {
  6873. defer conn.Close()
  6874. defer client.Close()
  6875. lastReceivedEmail.reset()
  6876. err := client.Mkdir(dirName)
  6877. assert.NoError(t, err)
  6878. // the passowrd is not about to expire, the check will be skipped and the ok action executed
  6879. assert.Eventually(t, func() bool {
  6880. return lastReceivedEmail.get().From != ""
  6881. }, 1500*time.Millisecond, 100*time.Millisecond)
  6882. email := lastReceivedEmail.get()
  6883. assert.Len(t, email.To, 1)
  6884. assert.Contains(t, email.To, "success@example.net")
  6885. err = client.RemoveDirectory(dirName)
  6886. assert.NoError(t, err)
  6887. }
  6888. user.Filters.PasswordExpiration = 5
  6889. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  6890. assert.NoError(t, err)
  6891. conn, client, err = getSftpClient(user)
  6892. if assert.NoError(t, err) {
  6893. defer conn.Close()
  6894. defer client.Close()
  6895. lastReceivedEmail.reset()
  6896. err := client.Mkdir(dirName)
  6897. assert.NoError(t, err)
  6898. // the passowrd is about to expire, the user has no email, the failure action will be executed
  6899. assert.Eventually(t, func() bool {
  6900. return lastReceivedEmail.get().From != ""
  6901. }, 1500*time.Millisecond, 100*time.Millisecond)
  6902. email := lastReceivedEmail.get()
  6903. assert.Len(t, email.To, 1)
  6904. assert.Contains(t, email.To, "failure@example.net")
  6905. err = client.RemoveDirectory(dirName)
  6906. assert.NoError(t, err)
  6907. }
  6908. // remove the success action
  6909. rule1.Actions = []dataprovider.EventAction{
  6910. {
  6911. BaseEventAction: dataprovider.BaseEventAction{
  6912. Name: action2.Name,
  6913. },
  6914. Order: 1,
  6915. },
  6916. {
  6917. BaseEventAction: dataprovider.BaseEventAction{
  6918. Name: action1.Name,
  6919. },
  6920. Options: dataprovider.EventActionOptions{
  6921. IsFailureAction: true,
  6922. },
  6923. },
  6924. }
  6925. _, _, err = httpdtest.UpdateEventRule(rule1, http.StatusOK)
  6926. assert.NoError(t, err)
  6927. user.Email = "user@example.net"
  6928. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  6929. assert.NoError(t, err)
  6930. conn, client, err = getSftpClient(user)
  6931. if assert.NoError(t, err) {
  6932. defer conn.Close()
  6933. defer client.Close()
  6934. lastReceivedEmail.reset()
  6935. err := client.Mkdir(dirName)
  6936. assert.NoError(t, err)
  6937. // the passowrd expiration will be notified
  6938. assert.Eventually(t, func() bool {
  6939. return lastReceivedEmail.get().From != ""
  6940. }, 1500*time.Millisecond, 100*time.Millisecond)
  6941. email := lastReceivedEmail.get()
  6942. assert.Len(t, email.To, 1)
  6943. assert.Contains(t, email.To, user.Email)
  6944. assert.Contains(t, email.Data, "your SFTPGo password expires in 5 days")
  6945. err = client.RemoveDirectory(dirName)
  6946. assert.NoError(t, err)
  6947. }
  6948. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  6949. assert.NoError(t, err)
  6950. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  6951. assert.NoError(t, err)
  6952. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  6953. assert.NoError(t, err)
  6954. _, err = httpdtest.RemoveEventAction(action3, http.StatusOK)
  6955. assert.NoError(t, err)
  6956. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  6957. assert.NoError(t, err)
  6958. err = os.RemoveAll(user.GetHomeDir())
  6959. assert.NoError(t, err)
  6960. smtpCfg = smtp.Config{}
  6961. err = smtpCfg.Initialize(configDir, true)
  6962. require.NoError(t, err)
  6963. }
  6964. func TestSyncUploadAction(t *testing.T) {
  6965. if runtime.GOOS == osWindows {
  6966. t.Skip("this test is not available on Windows")
  6967. }
  6968. uploadScriptPath := filepath.Join(os.TempDir(), "upload.sh")
  6969. common.Config.Actions.ExecuteOn = []string{"upload"}
  6970. common.Config.Actions.ExecuteSync = []string{"upload"}
  6971. common.Config.Actions.Hook = uploadScriptPath
  6972. u := getTestUser()
  6973. u.QuotaFiles = 1000
  6974. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  6975. assert.NoError(t, err)
  6976. movedFileName := "moved.dat"
  6977. movedPath := filepath.Join(user.HomeDir, movedFileName)
  6978. err = os.WriteFile(uploadScriptPath, getUploadScriptContent(movedPath, "", 0), 0755)
  6979. assert.NoError(t, err)
  6980. conn, client, err := getSftpClient(user)
  6981. if assert.NoError(t, err) {
  6982. defer conn.Close()
  6983. defer client.Close()
  6984. size := int64(32768)
  6985. err = writeSFTPFileNoCheck(testFileName, size, client)
  6986. assert.NoError(t, err)
  6987. _, err = client.Stat(testFileName)
  6988. assert.Error(t, err)
  6989. info, err := client.Stat(movedFileName)
  6990. if assert.NoError(t, err) {
  6991. assert.Equal(t, size, info.Size())
  6992. }
  6993. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  6994. assert.NoError(t, err)
  6995. assert.Equal(t, 1, user.UsedQuotaFiles)
  6996. assert.Equal(t, size, user.UsedQuotaSize)
  6997. // test some hook failure
  6998. // the uploaded file is moved and the hook fails, it will be not removed from the quota
  6999. err = os.WriteFile(uploadScriptPath, getUploadScriptContent(movedPath, "", 1), 0755)
  7000. assert.NoError(t, err)
  7001. err = writeSFTPFileNoCheck(testFileName+"_1", size, client)
  7002. assert.Error(t, err)
  7003. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  7004. assert.NoError(t, err)
  7005. assert.Equal(t, 2, user.UsedQuotaFiles)
  7006. assert.Equal(t, size*2, user.UsedQuotaSize)
  7007. // the uploaded file is not moved and the hook fails, the uploaded file will be deleted
  7008. // and removed from the quota
  7009. movedPath = filepath.Join(user.HomeDir, "missing dir", movedFileName)
  7010. err = os.WriteFile(uploadScriptPath, getUploadScriptContent(movedPath, "", 1), 0755)
  7011. assert.NoError(t, err)
  7012. err = writeSFTPFileNoCheck(testFileName+"_2", size, client)
  7013. assert.Error(t, err)
  7014. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  7015. assert.NoError(t, err)
  7016. assert.Equal(t, 2, user.UsedQuotaFiles)
  7017. assert.Equal(t, size*2, user.UsedQuotaSize)
  7018. // overwrite an existing file
  7019. _, err = client.Stat(movedFileName)
  7020. assert.NoError(t, err)
  7021. err = writeSFTPFileNoCheck(movedFileName, size, client)
  7022. assert.Error(t, err)
  7023. _, err = client.Stat(movedFileName)
  7024. assert.Error(t, err)
  7025. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  7026. assert.NoError(t, err)
  7027. assert.Equal(t, 1, user.UsedQuotaFiles)
  7028. assert.Equal(t, size, user.UsedQuotaSize)
  7029. }
  7030. err = os.Remove(uploadScriptPath)
  7031. assert.NoError(t, err)
  7032. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7033. assert.NoError(t, err)
  7034. err = os.RemoveAll(user.GetHomeDir())
  7035. assert.NoError(t, err)
  7036. common.Config.Actions.ExecuteOn = nil
  7037. common.Config.Actions.ExecuteSync = nil
  7038. common.Config.Actions.Hook = uploadScriptPath
  7039. }
  7040. func TestQuotaTrackDisabled(t *testing.T) {
  7041. err := dataprovider.Close()
  7042. assert.NoError(t, err)
  7043. err = config.LoadConfig(configDir, "")
  7044. assert.NoError(t, err)
  7045. providerConf := config.GetProviderConf()
  7046. providerConf.TrackQuota = 0
  7047. err = dataprovider.Initialize(providerConf, configDir, true)
  7048. assert.NoError(t, err)
  7049. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  7050. assert.NoError(t, err)
  7051. conn, client, err := getSftpClient(user)
  7052. if assert.NoError(t, err) {
  7053. defer conn.Close()
  7054. defer client.Close()
  7055. err = writeSFTPFile(testFileName, 32, client)
  7056. assert.NoError(t, err)
  7057. err = client.Rename(testFileName, testFileName+"1")
  7058. assert.NoError(t, err)
  7059. }
  7060. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7061. assert.NoError(t, err)
  7062. err = os.RemoveAll(user.GetHomeDir())
  7063. assert.NoError(t, err)
  7064. err = dataprovider.Close()
  7065. assert.NoError(t, err)
  7066. err = config.LoadConfig(configDir, "")
  7067. assert.NoError(t, err)
  7068. providerConf = config.GetProviderConf()
  7069. err = dataprovider.Initialize(providerConf, configDir, true)
  7070. assert.NoError(t, err)
  7071. }
  7072. func TestGetQuotaError(t *testing.T) {
  7073. if dataprovider.GetProviderStatus().Driver == "memory" {
  7074. t.Skip("this test is not available with the memory provider")
  7075. }
  7076. u := getTestUser()
  7077. u.TotalDataTransfer = 2000
  7078. mappedPath := filepath.Join(os.TempDir(), "vdir")
  7079. folderName := filepath.Base(mappedPath)
  7080. vdirPath := "/vpath"
  7081. f := vfs.BaseVirtualFolder{
  7082. Name: folderName,
  7083. MappedPath: mappedPath,
  7084. }
  7085. _, _, err := httpdtest.AddFolder(f, http.StatusCreated)
  7086. assert.NoError(t, err)
  7087. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  7088. BaseVirtualFolder: vfs.BaseVirtualFolder{
  7089. Name: folderName,
  7090. },
  7091. VirtualPath: vdirPath,
  7092. QuotaSize: 0,
  7093. QuotaFiles: 10,
  7094. })
  7095. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  7096. assert.NoError(t, err)
  7097. conn, client, err := getSftpClient(user)
  7098. if assert.NoError(t, err) {
  7099. defer conn.Close()
  7100. defer client.Close()
  7101. err = writeSFTPFile(testFileName, 32, client)
  7102. assert.NoError(t, err)
  7103. err = dataprovider.Close()
  7104. assert.NoError(t, err)
  7105. err = client.Rename(testFileName, path.Join(vdirPath, testFileName))
  7106. assert.Error(t, err)
  7107. err = config.LoadConfig(configDir, "")
  7108. assert.NoError(t, err)
  7109. providerConf := config.GetProviderConf()
  7110. err = dataprovider.Initialize(providerConf, configDir, true)
  7111. assert.NoError(t, err)
  7112. }
  7113. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7114. assert.NoError(t, err)
  7115. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName}, http.StatusOK)
  7116. assert.NoError(t, err)
  7117. err = os.RemoveAll(user.GetHomeDir())
  7118. assert.NoError(t, err)
  7119. err = os.RemoveAll(mappedPath)
  7120. assert.NoError(t, err)
  7121. }
  7122. func TestRetentionAPI(t *testing.T) {
  7123. u := getTestUser()
  7124. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  7125. assert.NoError(t, err)
  7126. uploadPath := path.Join(testDir, testFileName)
  7127. conn, client, err := getSftpClient(user)
  7128. if assert.NoError(t, err) {
  7129. defer conn.Close()
  7130. defer client.Close()
  7131. err = client.Mkdir(testDir)
  7132. assert.NoError(t, err)
  7133. err = writeSFTPFile(uploadPath, 32, client)
  7134. assert.NoError(t, err)
  7135. folderRetention := []dataprovider.FolderRetention{
  7136. {
  7137. Path: "/",
  7138. Retention: 24,
  7139. DeleteEmptyDirs: true,
  7140. },
  7141. }
  7142. _, err = httpdtest.StartRetentionCheck(user.Username, folderRetention, http.StatusAccepted)
  7143. assert.NoError(t, err)
  7144. assert.Eventually(t, func() bool {
  7145. return len(common.RetentionChecks.Get("")) == 0
  7146. }, 1000*time.Millisecond, 50*time.Millisecond)
  7147. _, err = client.Stat(uploadPath)
  7148. assert.NoError(t, err)
  7149. err = client.Chtimes(uploadPath, time.Now().Add(-48*time.Hour), time.Now().Add(-48*time.Hour))
  7150. assert.NoError(t, err)
  7151. _, err = httpdtest.StartRetentionCheck(user.Username, folderRetention, http.StatusAccepted)
  7152. assert.NoError(t, err)
  7153. assert.Eventually(t, func() bool {
  7154. return len(common.RetentionChecks.Get("")) == 0
  7155. }, 1000*time.Millisecond, 50*time.Millisecond)
  7156. _, err = client.Stat(uploadPath)
  7157. assert.ErrorIs(t, err, os.ErrNotExist)
  7158. _, err = client.Stat(testDir)
  7159. assert.ErrorIs(t, err, os.ErrNotExist)
  7160. err = client.Mkdir(testDir)
  7161. assert.NoError(t, err)
  7162. err = writeSFTPFile(uploadPath, 32, client)
  7163. assert.NoError(t, err)
  7164. folderRetention[0].DeleteEmptyDirs = false
  7165. err = client.Chtimes(uploadPath, time.Now().Add(-48*time.Hour), time.Now().Add(-48*time.Hour))
  7166. assert.NoError(t, err)
  7167. _, err = httpdtest.StartRetentionCheck(user.Username, folderRetention, http.StatusAccepted)
  7168. assert.NoError(t, err)
  7169. assert.Eventually(t, func() bool {
  7170. return len(common.RetentionChecks.Get("")) == 0
  7171. }, 1000*time.Millisecond, 50*time.Millisecond)
  7172. _, err = client.Stat(uploadPath)
  7173. assert.ErrorIs(t, err, os.ErrNotExist)
  7174. _, err = client.Stat(testDir)
  7175. assert.NoError(t, err)
  7176. err = writeSFTPFile(uploadPath, 32, client)
  7177. assert.NoError(t, err)
  7178. err = client.Chtimes(uploadPath, time.Now().Add(-48*time.Hour), time.Now().Add(-48*time.Hour))
  7179. assert.NoError(t, err)
  7180. }
  7181. // remove delete permissions to the user
  7182. user.Permissions["/"+testDir] = []string{dataprovider.PermListItems, dataprovider.PermUpload,
  7183. dataprovider.PermCreateDirs, dataprovider.PermChtimes}
  7184. user, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  7185. assert.NoError(t, err)
  7186. conn, client, err = getSftpClient(user)
  7187. if assert.NoError(t, err) {
  7188. defer conn.Close()
  7189. defer client.Close()
  7190. innerUploadFilePath := path.Join("/"+testDir, testDir, testFileName)
  7191. err = client.Mkdir(path.Join(testDir, testDir))
  7192. assert.NoError(t, err)
  7193. err = writeSFTPFile(innerUploadFilePath, 32, client)
  7194. assert.NoError(t, err)
  7195. err = client.Chtimes(innerUploadFilePath, time.Now().Add(-48*time.Hour), time.Now().Add(-48*time.Hour))
  7196. assert.NoError(t, err)
  7197. folderRetention := []dataprovider.FolderRetention{
  7198. {
  7199. Path: "/missing",
  7200. Retention: 24,
  7201. },
  7202. {
  7203. Path: "/" + testDir,
  7204. Retention: 24,
  7205. DeleteEmptyDirs: true,
  7206. },
  7207. {
  7208. Path: path.Dir(innerUploadFilePath),
  7209. Retention: 0,
  7210. IgnoreUserPermissions: true,
  7211. },
  7212. }
  7213. _, err = httpdtest.StartRetentionCheck(user.Username, folderRetention, http.StatusAccepted)
  7214. assert.NoError(t, err)
  7215. assert.Eventually(t, func() bool {
  7216. return len(common.RetentionChecks.Get("")) == 0
  7217. }, 1000*time.Millisecond, 50*time.Millisecond)
  7218. _, err = client.Stat(uploadPath)
  7219. assert.NoError(t, err)
  7220. _, err = client.Stat(innerUploadFilePath)
  7221. assert.NoError(t, err)
  7222. folderRetention[1].IgnoreUserPermissions = true
  7223. _, err = httpdtest.StartRetentionCheck(user.Username, folderRetention, http.StatusAccepted)
  7224. assert.NoError(t, err)
  7225. assert.Eventually(t, func() bool {
  7226. return len(common.RetentionChecks.Get("")) == 0
  7227. }, 1000*time.Millisecond, 50*time.Millisecond)
  7228. _, err = client.Stat(uploadPath)
  7229. assert.ErrorIs(t, err, os.ErrNotExist)
  7230. _, err = client.Stat(innerUploadFilePath)
  7231. assert.NoError(t, err)
  7232. folderRetention = []dataprovider.FolderRetention{
  7233. {
  7234. Path: "/" + testDir,
  7235. Retention: 24,
  7236. DeleteEmptyDirs: true,
  7237. IgnoreUserPermissions: true,
  7238. },
  7239. }
  7240. _, err = httpdtest.StartRetentionCheck(user.Username, folderRetention, http.StatusAccepted)
  7241. assert.NoError(t, err)
  7242. assert.Eventually(t, func() bool {
  7243. return len(common.RetentionChecks.Get("")) == 0
  7244. }, 1000*time.Millisecond, 50*time.Millisecond)
  7245. _, err = client.Stat(innerUploadFilePath)
  7246. assert.ErrorIs(t, err, os.ErrNotExist)
  7247. }
  7248. // finally test some errors removing files or folders
  7249. if runtime.GOOS != osWindows {
  7250. dirPath := filepath.Join(user.HomeDir, "adir", "sub")
  7251. err := os.MkdirAll(dirPath, os.ModePerm)
  7252. assert.NoError(t, err)
  7253. filePath := filepath.Join(dirPath, "f.dat")
  7254. err = os.WriteFile(filePath, nil, os.ModePerm)
  7255. assert.NoError(t, err)
  7256. err = os.Chtimes(filePath, time.Now().Add(-72*time.Hour), time.Now().Add(-72*time.Hour))
  7257. assert.NoError(t, err)
  7258. err = os.Chmod(dirPath, 0001)
  7259. assert.NoError(t, err)
  7260. folderRetention := []dataprovider.FolderRetention{
  7261. {
  7262. Path: "/adir",
  7263. Retention: 24,
  7264. DeleteEmptyDirs: true,
  7265. IgnoreUserPermissions: true,
  7266. },
  7267. }
  7268. _, err = httpdtest.StartRetentionCheck(user.Username, folderRetention, http.StatusAccepted)
  7269. assert.NoError(t, err)
  7270. assert.Eventually(t, func() bool {
  7271. return len(common.RetentionChecks.Get("")) == 0
  7272. }, 1000*time.Millisecond, 50*time.Millisecond)
  7273. err = os.Chmod(dirPath, 0555)
  7274. assert.NoError(t, err)
  7275. _, err = httpdtest.StartRetentionCheck(user.Username, folderRetention, http.StatusAccepted)
  7276. assert.NoError(t, err)
  7277. assert.Eventually(t, func() bool {
  7278. return len(common.RetentionChecks.Get("")) == 0
  7279. }, 1000*time.Millisecond, 50*time.Millisecond)
  7280. err = os.Chmod(dirPath, os.ModePerm)
  7281. assert.NoError(t, err)
  7282. _, err = httpdtest.StartRetentionCheck(user.Username, folderRetention, http.StatusAccepted)
  7283. assert.NoError(t, err)
  7284. assert.Eventually(t, func() bool {
  7285. return len(common.RetentionChecks.Get("")) == 0
  7286. }, 1000*time.Millisecond, 50*time.Millisecond)
  7287. assert.NoDirExists(t, dirPath)
  7288. }
  7289. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7290. assert.NoError(t, err)
  7291. err = os.RemoveAll(user.GetHomeDir())
  7292. assert.NoError(t, err)
  7293. }
  7294. func TestRenameDir(t *testing.T) {
  7295. u := getTestUser()
  7296. testDir := "/dir-to-rename"
  7297. u.Permissions[testDir] = []string{dataprovider.PermListItems, dataprovider.PermUpload}
  7298. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  7299. assert.NoError(t, err)
  7300. conn, client, err := getSftpClient(user)
  7301. if assert.NoError(t, err) {
  7302. defer conn.Close()
  7303. defer client.Close()
  7304. err = client.Mkdir(testDir)
  7305. assert.NoError(t, err)
  7306. err = writeSFTPFile(path.Join(testDir, testFileName), 32, client)
  7307. assert.NoError(t, err)
  7308. err = client.Rename(testDir, testDir+"_rename")
  7309. assert.ErrorIs(t, err, os.ErrPermission)
  7310. }
  7311. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7312. assert.NoError(t, err)
  7313. err = os.RemoveAll(user.GetHomeDir())
  7314. assert.NoError(t, err)
  7315. }
  7316. func TestBuiltinKeyboardInteractiveAuthentication(t *testing.T) {
  7317. u := getTestUser()
  7318. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  7319. assert.NoError(t, err)
  7320. authMethods := []ssh.AuthMethod{
  7321. ssh.KeyboardInteractive(func(user, instruction string, questions []string, echos []bool) ([]string, error) {
  7322. return []string{defaultPassword}, nil
  7323. }),
  7324. }
  7325. conn, client, err := getCustomAuthSftpClient(user, authMethods)
  7326. if assert.NoError(t, err) {
  7327. defer conn.Close()
  7328. defer client.Close()
  7329. assert.NoError(t, checkBasicSFTP(client))
  7330. err = writeSFTPFile(testFileName, 4096, client)
  7331. assert.NoError(t, err)
  7332. }
  7333. // add multi-factor authentication
  7334. configName, _, secret, _, err := mfa.GenerateTOTPSecret(mfa.GetAvailableTOTPConfigNames()[0], user.Username)
  7335. assert.NoError(t, err)
  7336. user.Password = defaultPassword
  7337. user.Filters.TOTPConfig = dataprovider.UserTOTPConfig{
  7338. Enabled: true,
  7339. ConfigName: configName,
  7340. Secret: kms.NewPlainSecret(secret),
  7341. Protocols: []string{common.ProtocolSSH},
  7342. }
  7343. err = dataprovider.UpdateUser(&user, "", "", "")
  7344. assert.NoError(t, err)
  7345. passcode, err := generateTOTPPasscode(secret, otp.AlgorithmSHA1)
  7346. assert.NoError(t, err)
  7347. passwordAsked := false
  7348. passcodeAsked := false
  7349. authMethods = []ssh.AuthMethod{
  7350. ssh.KeyboardInteractive(func(user, instruction string, questions []string, echos []bool) ([]string, error) {
  7351. var answers []string
  7352. if strings.HasPrefix(questions[0], "Password") {
  7353. answers = append(answers, defaultPassword)
  7354. passwordAsked = true
  7355. } else {
  7356. answers = append(answers, passcode)
  7357. passcodeAsked = true
  7358. }
  7359. return answers, nil
  7360. }),
  7361. }
  7362. conn, client, err = getCustomAuthSftpClient(user, authMethods)
  7363. if assert.NoError(t, err) {
  7364. defer conn.Close()
  7365. defer client.Close()
  7366. assert.NoError(t, checkBasicSFTP(client))
  7367. err = writeSFTPFile(testFileName, 4096, client)
  7368. assert.NoError(t, err)
  7369. }
  7370. assert.True(t, passwordAsked)
  7371. assert.True(t, passcodeAsked)
  7372. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7373. assert.NoError(t, err)
  7374. err = os.RemoveAll(user.GetHomeDir())
  7375. assert.NoError(t, err)
  7376. }
  7377. func TestRenameSymlink(t *testing.T) {
  7378. u := getTestUser()
  7379. testDir := "/dir-no-create-links"
  7380. otherDir := "otherdir"
  7381. u.Permissions[testDir] = []string{dataprovider.PermListItems, dataprovider.PermUpload, dataprovider.PermDelete,
  7382. dataprovider.PermCreateDirs}
  7383. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  7384. assert.NoError(t, err)
  7385. conn, client, err := getSftpClient(user)
  7386. if assert.NoError(t, err) {
  7387. defer conn.Close()
  7388. defer client.Close()
  7389. err = client.Mkdir(otherDir)
  7390. assert.NoError(t, err)
  7391. err = client.Symlink(otherDir, otherDir+".link")
  7392. assert.NoError(t, err)
  7393. err = client.Rename(otherDir+".link", path.Join(testDir, "symlink"))
  7394. assert.ErrorIs(t, err, os.ErrPermission)
  7395. err = client.Rename(otherDir+".link", "allowed_link")
  7396. assert.NoError(t, err)
  7397. }
  7398. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7399. assert.NoError(t, err)
  7400. err = os.RemoveAll(user.GetHomeDir())
  7401. assert.NoError(t, err)
  7402. }
  7403. func TestSplittedDeletePerms(t *testing.T) {
  7404. u := getTestUser()
  7405. u.Permissions["/"] = []string{dataprovider.PermListItems, dataprovider.PermUpload, dataprovider.PermDeleteDirs,
  7406. dataprovider.PermCreateDirs}
  7407. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  7408. assert.NoError(t, err)
  7409. conn, client, err := getSftpClient(user)
  7410. if assert.NoError(t, err) {
  7411. defer conn.Close()
  7412. defer client.Close()
  7413. err = writeSFTPFile(testFileName, 4096, client)
  7414. assert.NoError(t, err)
  7415. err = client.Remove(testFileName)
  7416. assert.Error(t, err)
  7417. err = client.Mkdir(testDir)
  7418. assert.NoError(t, err)
  7419. err = client.RemoveDirectory(testDir)
  7420. assert.NoError(t, err)
  7421. }
  7422. u.Permissions["/"] = []string{dataprovider.PermListItems, dataprovider.PermUpload, dataprovider.PermDeleteFiles,
  7423. dataprovider.PermCreateDirs, dataprovider.PermOverwrite}
  7424. _, _, err = httpdtest.UpdateUser(u, http.StatusOK, "")
  7425. assert.NoError(t, err)
  7426. conn, client, err = getSftpClient(user)
  7427. if assert.NoError(t, err) {
  7428. defer conn.Close()
  7429. defer client.Close()
  7430. err = writeSFTPFile(testFileName, 4096, client)
  7431. assert.NoError(t, err)
  7432. err = client.Remove(testFileName)
  7433. assert.NoError(t, err)
  7434. err = client.Mkdir(testDir)
  7435. assert.NoError(t, err)
  7436. err = client.RemoveDirectory(testDir)
  7437. assert.Error(t, err)
  7438. }
  7439. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7440. assert.NoError(t, err)
  7441. err = os.RemoveAll(user.GetHomeDir())
  7442. assert.NoError(t, err)
  7443. }
  7444. func TestSplittedRenamePerms(t *testing.T) {
  7445. u := getTestUser()
  7446. u.Permissions["/"] = []string{dataprovider.PermListItems, dataprovider.PermUpload, dataprovider.PermRenameDirs,
  7447. dataprovider.PermCreateDirs}
  7448. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  7449. assert.NoError(t, err)
  7450. conn, client, err := getSftpClient(user)
  7451. if assert.NoError(t, err) {
  7452. defer conn.Close()
  7453. defer client.Close()
  7454. err = writeSFTPFile(testFileName, 4096, client)
  7455. assert.NoError(t, err)
  7456. err = client.Mkdir(testDir)
  7457. assert.NoError(t, err)
  7458. err = client.Rename(testFileName, testFileName+"_renamed")
  7459. assert.Error(t, err)
  7460. err = client.Rename(testDir, testDir+"_renamed")
  7461. assert.NoError(t, err)
  7462. }
  7463. u.Permissions["/"] = []string{dataprovider.PermListItems, dataprovider.PermUpload, dataprovider.PermRenameFiles,
  7464. dataprovider.PermCreateDirs, dataprovider.PermOverwrite}
  7465. _, _, err = httpdtest.UpdateUser(u, http.StatusOK, "")
  7466. assert.NoError(t, err)
  7467. conn, client, err = getSftpClient(user)
  7468. if assert.NoError(t, err) {
  7469. defer conn.Close()
  7470. defer client.Close()
  7471. err = writeSFTPFile(testFileName, 4096, client)
  7472. assert.NoError(t, err)
  7473. err = client.Mkdir(testDir)
  7474. assert.NoError(t, err)
  7475. err = client.Rename(testFileName, testFileName+"_renamed")
  7476. assert.NoError(t, err)
  7477. err = client.Rename(testDir, testDir+"_renamed")
  7478. assert.Error(t, err)
  7479. }
  7480. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7481. assert.NoError(t, err)
  7482. err = os.RemoveAll(user.GetHomeDir())
  7483. assert.NoError(t, err)
  7484. }
  7485. func TestSFTPLoopError(t *testing.T) {
  7486. smtpCfg := smtp.Config{
  7487. Host: "127.0.0.1",
  7488. Port: 2525,
  7489. From: "notification@example.com",
  7490. TemplatesPath: "templates",
  7491. }
  7492. err := smtpCfg.Initialize(configDir, true)
  7493. require.NoError(t, err)
  7494. user1 := getTestUser()
  7495. user2 := getTestUser()
  7496. user1.Username += "1"
  7497. user2.Username += "2"
  7498. // user1 is a local account with a virtual SFTP folder to user2
  7499. // user2 has user1 as SFTP fs
  7500. f := vfs.BaseVirtualFolder{
  7501. Name: "sftp",
  7502. FsConfig: vfs.Filesystem{
  7503. Provider: sdk.SFTPFilesystemProvider,
  7504. SFTPConfig: vfs.SFTPFsConfig{
  7505. BaseSFTPFsConfig: sdk.BaseSFTPFsConfig{
  7506. Endpoint: sftpServerAddr,
  7507. Username: user2.Username,
  7508. },
  7509. Password: kms.NewPlainSecret(defaultPassword),
  7510. },
  7511. },
  7512. }
  7513. folder, _, err := httpdtest.AddFolder(f, http.StatusCreated)
  7514. assert.NoError(t, err)
  7515. user1.VirtualFolders = append(user1.VirtualFolders, vfs.VirtualFolder{
  7516. BaseVirtualFolder: vfs.BaseVirtualFolder{
  7517. Name: folder.Name,
  7518. },
  7519. VirtualPath: "/vdir",
  7520. })
  7521. user2.FsConfig.Provider = sdk.SFTPFilesystemProvider
  7522. user2.FsConfig.SFTPConfig = vfs.SFTPFsConfig{
  7523. BaseSFTPFsConfig: sdk.BaseSFTPFsConfig{
  7524. Endpoint: sftpServerAddr,
  7525. Username: user1.Username,
  7526. },
  7527. Password: kms.NewPlainSecret(defaultPassword),
  7528. }
  7529. user1, resp, err := httpdtest.AddUser(user1, http.StatusCreated)
  7530. assert.NoError(t, err, string(resp))
  7531. user2, resp, err = httpdtest.AddUser(user2, http.StatusCreated)
  7532. assert.NoError(t, err, string(resp))
  7533. // test metadata check event error
  7534. a1 := dataprovider.BaseEventAction{
  7535. Name: "a1",
  7536. Type: dataprovider.ActionTypeMetadataCheck,
  7537. }
  7538. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  7539. assert.NoError(t, err)
  7540. a2 := dataprovider.BaseEventAction{
  7541. Name: "a2",
  7542. Type: dataprovider.ActionTypeEmail,
  7543. Options: dataprovider.BaseEventActionOptions{
  7544. EmailConfig: dataprovider.EventActionEmailConfig{
  7545. Recipients: []string{"failure@example.com"},
  7546. Subject: `Failed action"`,
  7547. Body: "Test body",
  7548. },
  7549. },
  7550. }
  7551. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  7552. assert.NoError(t, err)
  7553. r1 := dataprovider.EventRule{
  7554. Name: "rule1",
  7555. Status: 1,
  7556. Trigger: dataprovider.EventTriggerProviderEvent,
  7557. Conditions: dataprovider.EventConditions{
  7558. ProviderEvents: []string{"update"},
  7559. },
  7560. Actions: []dataprovider.EventAction{
  7561. {
  7562. BaseEventAction: dataprovider.BaseEventAction{
  7563. Name: action1.Name,
  7564. },
  7565. Order: 1,
  7566. },
  7567. {
  7568. BaseEventAction: dataprovider.BaseEventAction{
  7569. Name: action2.Name,
  7570. },
  7571. Order: 2,
  7572. Options: dataprovider.EventActionOptions{
  7573. IsFailureAction: true,
  7574. },
  7575. },
  7576. },
  7577. }
  7578. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  7579. assert.NoError(t, err)
  7580. lastReceivedEmail.reset()
  7581. _, _, err = httpdtest.UpdateUser(user2, http.StatusOK, "")
  7582. assert.NoError(t, err)
  7583. assert.Eventually(t, func() bool {
  7584. return lastReceivedEmail.get().From != ""
  7585. }, 3000*time.Millisecond, 100*time.Millisecond)
  7586. email := lastReceivedEmail.get()
  7587. assert.Len(t, email.To, 1)
  7588. assert.True(t, util.Contains(email.To, "failure@example.com"))
  7589. assert.Contains(t, email.Data, `Subject: Failed action`)
  7590. user1.VirtualFolders[0].FsConfig.SFTPConfig.Password = kms.NewPlainSecret(defaultPassword)
  7591. user2.FsConfig.SFTPConfig.Password = kms.NewPlainSecret(defaultPassword)
  7592. conn := common.NewBaseConnection("", common.ProtocolWebDAV, "", "", user1)
  7593. _, _, err = conn.GetFsAndResolvedPath(user1.VirtualFolders[0].VirtualPath)
  7594. assert.ErrorIs(t, err, os.ErrPermission)
  7595. conn = common.NewBaseConnection("", common.ProtocolSFTP, "", "", user1)
  7596. _, _, err = conn.GetFsAndResolvedPath(user1.VirtualFolders[0].VirtualPath)
  7597. assert.Error(t, err)
  7598. conn = common.NewBaseConnection("", common.ProtocolFTP, "", "", user1)
  7599. _, _, err = conn.GetFsAndResolvedPath(user1.VirtualFolders[0].VirtualPath)
  7600. assert.Error(t, err)
  7601. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  7602. assert.NoError(t, err)
  7603. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  7604. assert.NoError(t, err)
  7605. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  7606. assert.NoError(t, err)
  7607. _, err = httpdtest.RemoveUser(user1, http.StatusOK)
  7608. assert.NoError(t, err)
  7609. err = os.RemoveAll(user1.GetHomeDir())
  7610. assert.NoError(t, err)
  7611. _, err = httpdtest.RemoveUser(user2, http.StatusOK)
  7612. assert.NoError(t, err)
  7613. err = os.RemoveAll(user2.GetHomeDir())
  7614. assert.NoError(t, err)
  7615. _, err = httpdtest.RemoveFolder(folder, http.StatusOK)
  7616. assert.NoError(t, err)
  7617. smtpCfg = smtp.Config{}
  7618. err = smtpCfg.Initialize(configDir, true)
  7619. require.NoError(t, err)
  7620. }
  7621. func TestNonLocalCrossRename(t *testing.T) {
  7622. baseUser, resp, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  7623. assert.NoError(t, err, string(resp))
  7624. u := getTestUser()
  7625. u.HomeDir += "_folders"
  7626. u.Username += "_folders"
  7627. mappedPathSFTP := filepath.Join(os.TempDir(), "sftp")
  7628. folderNameSFTP := filepath.Base(mappedPathSFTP)
  7629. vdirSFTPPath := "/vdir/sftp"
  7630. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  7631. BaseVirtualFolder: vfs.BaseVirtualFolder{
  7632. Name: folderNameSFTP,
  7633. },
  7634. VirtualPath: vdirSFTPPath,
  7635. })
  7636. mappedPathCrypt := filepath.Join(os.TempDir(), "crypt")
  7637. folderNameCrypt := filepath.Base(mappedPathCrypt)
  7638. vdirCryptPath := "/vdir/crypt"
  7639. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  7640. BaseVirtualFolder: vfs.BaseVirtualFolder{
  7641. Name: folderNameCrypt,
  7642. },
  7643. VirtualPath: vdirCryptPath,
  7644. })
  7645. f1 := vfs.BaseVirtualFolder{
  7646. Name: folderNameSFTP,
  7647. FsConfig: vfs.Filesystem{
  7648. Provider: sdk.SFTPFilesystemProvider,
  7649. SFTPConfig: vfs.SFTPFsConfig{
  7650. BaseSFTPFsConfig: sdk.BaseSFTPFsConfig{
  7651. Endpoint: sftpServerAddr,
  7652. Username: baseUser.Username,
  7653. },
  7654. Password: kms.NewPlainSecret(defaultPassword),
  7655. },
  7656. },
  7657. }
  7658. _, _, err = httpdtest.AddFolder(f1, http.StatusCreated)
  7659. assert.NoError(t, err)
  7660. f2 := vfs.BaseVirtualFolder{
  7661. Name: folderNameCrypt,
  7662. FsConfig: vfs.Filesystem{
  7663. Provider: sdk.CryptedFilesystemProvider,
  7664. CryptConfig: vfs.CryptFsConfig{
  7665. Passphrase: kms.NewPlainSecret(defaultPassword),
  7666. },
  7667. },
  7668. MappedPath: mappedPathCrypt,
  7669. }
  7670. _, _, err = httpdtest.AddFolder(f2, http.StatusCreated)
  7671. assert.NoError(t, err)
  7672. user, resp, err := httpdtest.AddUser(u, http.StatusCreated)
  7673. assert.NoError(t, err, string(resp))
  7674. conn, client, err := getSftpClient(user)
  7675. if assert.NoError(t, err) {
  7676. defer conn.Close()
  7677. defer client.Close()
  7678. assert.NoError(t, checkBasicSFTP(client))
  7679. err = writeSFTPFile(testFileName, 4096, client)
  7680. assert.NoError(t, err)
  7681. err = writeSFTPFile(path.Join(vdirSFTPPath, testFileName), 8192, client)
  7682. assert.NoError(t, err)
  7683. err = writeSFTPFile(path.Join(vdirCryptPath, testFileName), 16384, client)
  7684. assert.NoError(t, err)
  7685. err = client.Rename(path.Join(vdirSFTPPath, testFileName), path.Join(vdirCryptPath, testFileName+".rename"))
  7686. assert.ErrorIs(t, err, os.ErrPermission)
  7687. err = client.Rename(path.Join(vdirCryptPath, testFileName), path.Join(vdirSFTPPath, testFileName+".rename"))
  7688. assert.ErrorIs(t, err, os.ErrPermission)
  7689. err = client.Rename(testFileName, path.Join(vdirCryptPath, testFileName+".rename"))
  7690. assert.ErrorIs(t, err, os.ErrPermission)
  7691. err = client.Rename(testFileName, path.Join(vdirSFTPPath, testFileName+".rename"))
  7692. assert.ErrorIs(t, err, os.ErrPermission)
  7693. err = client.Rename(path.Join(vdirSFTPPath, testFileName), testFileName+".rename")
  7694. assert.ErrorIs(t, err, os.ErrPermission)
  7695. err = client.Rename(path.Join(vdirCryptPath, testFileName), testFileName+".rename")
  7696. assert.ErrorIs(t, err, os.ErrPermission)
  7697. // rename on local fs or on the same folder must work
  7698. err = client.Rename(testFileName, testFileName+".rename")
  7699. assert.NoError(t, err)
  7700. err = client.Rename(path.Join(vdirSFTPPath, testFileName), path.Join(vdirSFTPPath, testFileName+"_rename"))
  7701. assert.NoError(t, err)
  7702. err = client.Rename(path.Join(vdirCryptPath, testFileName), path.Join(vdirCryptPath, testFileName+"_rename"))
  7703. assert.NoError(t, err)
  7704. // renaming a virtual folder is not allowed
  7705. err = client.Rename(vdirSFTPPath, vdirSFTPPath+"_rename")
  7706. assert.ErrorIs(t, err, os.ErrPermission)
  7707. err = client.Rename(vdirCryptPath, vdirCryptPath+"_rename")
  7708. assert.ErrorIs(t, err, os.ErrPermission)
  7709. err = client.Rename(vdirCryptPath, path.Join(vdirCryptPath, "rename"))
  7710. assert.ErrorIs(t, err, os.ErrPermission)
  7711. err = client.Mkdir(path.Join(vdirCryptPath, "subcryptdir"))
  7712. assert.NoError(t, err)
  7713. err = client.Rename(path.Join(vdirCryptPath, "subcryptdir"), vdirCryptPath)
  7714. assert.ErrorIs(t, err, os.ErrPermission)
  7715. // renaming root folder is not allowed
  7716. err = client.Rename("/", "new_name")
  7717. assert.ErrorIs(t, err, os.ErrPermission)
  7718. // renaming a path to a virtual folder is not allowed
  7719. err = client.Rename("/vdir", "new_vdir")
  7720. if assert.Error(t, err) {
  7721. assert.Contains(t, err.Error(), "SSH_FX_OP_UNSUPPORTED")
  7722. }
  7723. }
  7724. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7725. assert.NoError(t, err)
  7726. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderNameCrypt}, http.StatusOK)
  7727. assert.NoError(t, err)
  7728. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderNameSFTP}, http.StatusOK)
  7729. assert.NoError(t, err)
  7730. _, err = httpdtest.RemoveUser(baseUser, http.StatusOK)
  7731. assert.NoError(t, err)
  7732. err = os.RemoveAll(user.GetHomeDir())
  7733. assert.NoError(t, err)
  7734. err = os.RemoveAll(baseUser.GetHomeDir())
  7735. assert.NoError(t, err)
  7736. err = os.RemoveAll(mappedPathCrypt)
  7737. assert.NoError(t, err)
  7738. err = os.RemoveAll(mappedPathSFTP)
  7739. assert.NoError(t, err)
  7740. }
  7741. func TestNonLocalCrossRenameNonLocalBaseUser(t *testing.T) {
  7742. baseUser, resp, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  7743. assert.NoError(t, err, string(resp))
  7744. u := getTestSFTPUser()
  7745. mappedPathLocal := filepath.Join(os.TempDir(), "local")
  7746. folderNameLocal := filepath.Base(mappedPathLocal)
  7747. vdirLocalPath := "/vdir/local"
  7748. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  7749. BaseVirtualFolder: vfs.BaseVirtualFolder{
  7750. Name: folderNameLocal,
  7751. },
  7752. VirtualPath: vdirLocalPath,
  7753. })
  7754. mappedPathCrypt := filepath.Join(os.TempDir(), "crypt")
  7755. folderNameCrypt := filepath.Base(mappedPathCrypt)
  7756. vdirCryptPath := "/vdir/crypt"
  7757. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  7758. BaseVirtualFolder: vfs.BaseVirtualFolder{
  7759. Name: folderNameCrypt,
  7760. },
  7761. VirtualPath: vdirCryptPath,
  7762. })
  7763. f1 := vfs.BaseVirtualFolder{
  7764. Name: folderNameLocal,
  7765. MappedPath: mappedPathLocal,
  7766. }
  7767. _, _, err = httpdtest.AddFolder(f1, http.StatusCreated)
  7768. assert.NoError(t, err)
  7769. f2 := vfs.BaseVirtualFolder{
  7770. Name: folderNameCrypt,
  7771. FsConfig: vfs.Filesystem{
  7772. Provider: sdk.CryptedFilesystemProvider,
  7773. CryptConfig: vfs.CryptFsConfig{
  7774. Passphrase: kms.NewPlainSecret(defaultPassword),
  7775. },
  7776. },
  7777. MappedPath: mappedPathCrypt,
  7778. }
  7779. _, _, err = httpdtest.AddFolder(f2, http.StatusCreated)
  7780. assert.NoError(t, err)
  7781. user, resp, err := httpdtest.AddUser(u, http.StatusCreated)
  7782. assert.NoError(t, err, string(resp))
  7783. conn, client, err := getSftpClient(user)
  7784. if assert.NoError(t, err) {
  7785. defer conn.Close()
  7786. defer client.Close()
  7787. assert.NoError(t, checkBasicSFTP(client))
  7788. err = writeSFTPFile(testFileName, 4096, client)
  7789. assert.NoError(t, err)
  7790. err = writeSFTPFile(path.Join(vdirLocalPath, testFileName), 8192, client)
  7791. assert.NoError(t, err)
  7792. err = writeSFTPFile(path.Join(vdirCryptPath, testFileName), 16384, client)
  7793. assert.NoError(t, err)
  7794. err = client.Rename(path.Join(vdirLocalPath, testFileName), path.Join(vdirCryptPath, testFileName+".rename"))
  7795. assert.ErrorIs(t, err, os.ErrPermission)
  7796. err = client.Rename(path.Join(vdirCryptPath, testFileName), path.Join(vdirLocalPath, testFileName+".rename"))
  7797. assert.ErrorIs(t, err, os.ErrPermission)
  7798. err = client.Rename(testFileName, path.Join(vdirCryptPath, testFileName+".rename"))
  7799. assert.ErrorIs(t, err, os.ErrPermission)
  7800. err = client.Rename(testFileName, path.Join(vdirLocalPath, testFileName+".rename"))
  7801. assert.ErrorIs(t, err, os.ErrPermission)
  7802. err = client.Rename(path.Join(vdirLocalPath, testFileName), testFileName+".rename")
  7803. assert.ErrorIs(t, err, os.ErrPermission)
  7804. err = client.Rename(path.Join(vdirCryptPath, testFileName), testFileName+".rename")
  7805. assert.ErrorIs(t, err, os.ErrPermission)
  7806. // rename on local fs or on the same folder must work
  7807. err = client.Rename(testFileName, testFileName+".rename")
  7808. assert.NoError(t, err)
  7809. err = client.Rename(path.Join(vdirLocalPath, testFileName), path.Join(vdirLocalPath, testFileName+"_rename"))
  7810. assert.NoError(t, err)
  7811. err = client.Rename(path.Join(vdirCryptPath, testFileName), path.Join(vdirCryptPath, testFileName+"_rename"))
  7812. assert.NoError(t, err)
  7813. // renaming a virtual folder is not allowed
  7814. err = client.Rename(vdirLocalPath, vdirLocalPath+"_rename")
  7815. assert.ErrorIs(t, err, os.ErrPermission)
  7816. err = client.Rename(vdirCryptPath, vdirCryptPath+"_rename")
  7817. assert.ErrorIs(t, err, os.ErrPermission)
  7818. // renaming root folder is not allowed
  7819. err = client.Rename("/", "new_name")
  7820. assert.ErrorIs(t, err, os.ErrPermission)
  7821. // renaming a path to a virtual folder is not allowed
  7822. err = client.Rename("/vdir", "new_vdir")
  7823. if assert.Error(t, err) {
  7824. assert.Contains(t, err.Error(), "SSH_FX_OP_UNSUPPORTED")
  7825. }
  7826. }
  7827. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7828. assert.NoError(t, err)
  7829. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderNameCrypt}, http.StatusOK)
  7830. assert.NoError(t, err)
  7831. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderNameLocal}, http.StatusOK)
  7832. assert.NoError(t, err)
  7833. _, err = httpdtest.RemoveUser(baseUser, http.StatusOK)
  7834. assert.NoError(t, err)
  7835. err = os.RemoveAll(user.GetHomeDir())
  7836. assert.NoError(t, err)
  7837. err = os.RemoveAll(baseUser.GetHomeDir())
  7838. assert.NoError(t, err)
  7839. err = os.RemoveAll(mappedPathCrypt)
  7840. assert.NoError(t, err)
  7841. err = os.RemoveAll(mappedPathLocal)
  7842. assert.NoError(t, err)
  7843. }
  7844. func TestCopyAndRemoveSSHCommands(t *testing.T) {
  7845. u := getTestUser()
  7846. u.QuotaFiles = 1000
  7847. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  7848. assert.NoError(t, err)
  7849. conn, client, err := getSftpClient(user)
  7850. if assert.NoError(t, err) {
  7851. defer conn.Close()
  7852. defer client.Close()
  7853. fileSize := int64(32)
  7854. err = writeSFTPFile(testFileName, fileSize, client)
  7855. assert.NoError(t, err)
  7856. testFileNameCopy := testFileName + "_copy"
  7857. out, err := runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", testFileName, testFileNameCopy), user)
  7858. assert.NoError(t, err, string(out))
  7859. // the resolved destination path match the source path
  7860. out, err = runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", testFileName, path.Dir(testFileName)), user)
  7861. assert.Error(t, err, string(out))
  7862. info, err := client.Stat(testFileNameCopy)
  7863. if assert.NoError(t, err) {
  7864. assert.Equal(t, fileSize, info.Size())
  7865. }
  7866. testDir := "test dir"
  7867. err = client.Mkdir(testDir)
  7868. assert.NoError(t, err)
  7869. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s '%s'`, testFileName, testDir), user)
  7870. assert.NoError(t, err, string(out))
  7871. info, err = client.Stat(path.Join(testDir, testFileName))
  7872. if assert.NoError(t, err) {
  7873. assert.Equal(t, fileSize, info.Size())
  7874. }
  7875. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  7876. assert.NoError(t, err)
  7877. assert.Equal(t, 3*fileSize, user.UsedQuotaSize)
  7878. assert.Equal(t, 3, user.UsedQuotaFiles)
  7879. out, err = runSSHCommand(fmt.Sprintf("sftpgo-remove %s", testFileNameCopy), user)
  7880. assert.NoError(t, err, string(out))
  7881. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-remove '%s'`, testDir), user)
  7882. assert.NoError(t, err, string(out))
  7883. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  7884. assert.NoError(t, err)
  7885. assert.Equal(t, fileSize, user.UsedQuotaSize)
  7886. assert.Equal(t, 1, user.UsedQuotaFiles)
  7887. _, err = client.Stat(testFileNameCopy)
  7888. assert.ErrorIs(t, err, os.ErrNotExist)
  7889. // create a dir tree
  7890. dir1 := "dir1"
  7891. dir2 := "dir 2"
  7892. err = client.MkdirAll(path.Join(dir1, dir2))
  7893. assert.NoError(t, err)
  7894. toCreate := []string{
  7895. path.Join(dir1, testFileName),
  7896. path.Join(dir1, dir2, testFileName),
  7897. }
  7898. for _, p := range toCreate {
  7899. err = writeSFTPFile(p, fileSize, client)
  7900. assert.NoError(t, err)
  7901. }
  7902. // create a symlink, copying a symlink is not supported
  7903. err = client.Symlink(path.Join("/", dir1, testFileName), path.Join("/", dir1, testFileName+"_link"))
  7904. assert.NoError(t, err)
  7905. out, err = runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", path.Join("/", dir1, testFileName+"_link"),
  7906. path.Join("/", testFileName+"_link")), user)
  7907. assert.Error(t, err, string(out))
  7908. // copying a dir inside itself should fail
  7909. out, err = runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", path.Join("/", dir1),
  7910. path.Join("/", dir1, "sub")), user)
  7911. assert.Error(t, err, string(out))
  7912. // copy source and dest must differ
  7913. out, err = runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", path.Join("/", dir1),
  7914. path.Join("/", dir1)), user)
  7915. assert.Error(t, err, string(out))
  7916. // copy a missing file/dir should fail
  7917. out, err = runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", path.Join("/", "missing_entry"),
  7918. path.Join("/", dir1)), user)
  7919. assert.Error(t, err, string(out))
  7920. // try to overwrite a file with a dir
  7921. out, err = runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", path.Join("/", dir1), testFileName), user)
  7922. assert.Error(t, err, string(out))
  7923. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s "%s"`, dir1, dir2), user)
  7924. assert.NoError(t, err, string(out))
  7925. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  7926. assert.NoError(t, err)
  7927. assert.Equal(t, 5*fileSize, user.UsedQuotaSize)
  7928. assert.Equal(t, 5, user.UsedQuotaFiles)
  7929. // copy again, quota must remain unchanged
  7930. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s/ "%s"`, dir1, dir2), user)
  7931. assert.NoError(t, err, string(out))
  7932. _, err = client.Stat(dir2)
  7933. assert.NoError(t, err)
  7934. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  7935. assert.NoError(t, err)
  7936. assert.Equal(t, 5*fileSize, user.UsedQuotaSize)
  7937. assert.Equal(t, 5, user.UsedQuotaFiles)
  7938. // now copy inside target
  7939. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s "%s"`, dir1, dir2), user)
  7940. assert.NoError(t, err, string(out))
  7941. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  7942. assert.NoError(t, err)
  7943. assert.Equal(t, 7*fileSize, user.UsedQuotaSize)
  7944. assert.Equal(t, 7, user.UsedQuotaFiles)
  7945. for _, p := range []string{dir1, dir2} {
  7946. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-remove "%s"`, p), user)
  7947. assert.NoError(t, err, string(out))
  7948. _, err = client.Stat(p)
  7949. assert.ErrorIs(t, err, os.ErrNotExist)
  7950. }
  7951. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  7952. assert.NoError(t, err)
  7953. assert.Equal(t, fileSize, user.UsedQuotaSize)
  7954. assert.Equal(t, 1, user.UsedQuotaFiles)
  7955. // test quota errors
  7956. user.QuotaFiles = 1
  7957. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  7958. assert.NoError(t, err)
  7959. // quota files exceeded
  7960. out, err = runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", testFileName, testFileNameCopy), user)
  7961. assert.Error(t, err, string(out))
  7962. user.QuotaFiles = 1000
  7963. user.QuotaSize = fileSize + 1
  7964. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  7965. assert.NoError(t, err)
  7966. // quota size exceeded after the copy
  7967. out, err = runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", testFileName, testFileNameCopy), user)
  7968. assert.Error(t, err, string(out))
  7969. user.QuotaSize = fileSize - 1
  7970. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  7971. assert.NoError(t, err)
  7972. // quota size exceeded
  7973. out, err = runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", testFileName, testFileNameCopy), user)
  7974. assert.Error(t, err, string(out))
  7975. }
  7976. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7977. assert.NoError(t, err)
  7978. err = os.RemoveAll(user.GetHomeDir())
  7979. assert.NoError(t, err)
  7980. }
  7981. func TestCopyAndRemovePermissions(t *testing.T) {
  7982. u := getTestUser()
  7983. restrictedPath := "/dir/path"
  7984. patternFilterPath := "/patterns"
  7985. u.Filters.FilePatterns = []sdk.PatternsFilter{
  7986. {
  7987. Path: patternFilterPath,
  7988. DeniedPatterns: []string{"*.dat"},
  7989. },
  7990. }
  7991. u.Permissions[restrictedPath] = []string{}
  7992. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  7993. assert.NoError(t, err)
  7994. conn, client, err := getSftpClient(user)
  7995. if assert.NoError(t, err) {
  7996. defer conn.Close()
  7997. defer client.Close()
  7998. err = client.MkdirAll(restrictedPath)
  7999. assert.NoError(t, err)
  8000. err = client.MkdirAll(patternFilterPath)
  8001. assert.NoError(t, err)
  8002. err = writeSFTPFile(testFileName, 100, client)
  8003. assert.NoError(t, err)
  8004. // getting file writer will fail
  8005. out, err := runSSHCommand(fmt.Sprintf(`sftpgo-copy %s %s`, testFileName, restrictedPath), user)
  8006. assert.Error(t, err, string(out))
  8007. // file pattern not allowed
  8008. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s %s`, testFileName, patternFilterPath), user)
  8009. assert.Error(t, err, string(out))
  8010. testDir := path.Join("/", path.Base(restrictedPath))
  8011. err = client.Mkdir(testDir)
  8012. assert.NoError(t, err)
  8013. err = writeSFTPFile(path.Join(testDir, testFileName), 100, client)
  8014. assert.NoError(t, err)
  8015. // creating target dir will fail
  8016. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s %s/`, testDir, restrictedPath), user)
  8017. assert.Error(t, err, string(out))
  8018. // get dir contents will fail
  8019. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s /`, restrictedPath), user)
  8020. assert.Error(t, err, string(out))
  8021. // get dir contents will fail
  8022. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-remove %s`, restrictedPath), user)
  8023. assert.Error(t, err, string(out))
  8024. // give list dir permissions and retry, now delete will fail
  8025. user.Permissions[restrictedPath] = []string{dataprovider.PermListItems, dataprovider.PermUpload}
  8026. user.Permissions[testDir] = []string{dataprovider.PermListItems}
  8027. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  8028. assert.NoError(t, err)
  8029. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s %s`, testFileName, restrictedPath), user)
  8030. assert.NoError(t, err, string(out))
  8031. // overwrite will fail, no permission
  8032. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s %s`, testFileName, restrictedPath), user)
  8033. assert.Error(t, err, string(out))
  8034. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-remove %s`, restrictedPath), user)
  8035. assert.Error(t, err, string(out))
  8036. // try to copy a file from testDir, we have only list permissions so getFileReader will fail
  8037. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s %s`, path.Join(testDir, testFileName), testFileName+".copy"), user)
  8038. assert.Error(t, err, string(out))
  8039. }
  8040. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  8041. assert.NoError(t, err)
  8042. err = os.RemoveAll(user.GetHomeDir())
  8043. assert.NoError(t, err)
  8044. }
  8045. func TestCrossFoldersCopy(t *testing.T) {
  8046. baseUser, resp, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  8047. assert.NoError(t, err, string(resp))
  8048. u := getTestUser()
  8049. u.Username += "_1"
  8050. u.HomeDir = filepath.Join(os.TempDir(), u.Username)
  8051. u.QuotaFiles = 1000
  8052. mappedPath1 := filepath.Join(os.TempDir(), "mapped1")
  8053. folderName1 := filepath.Base(mappedPath1)
  8054. vpath1 := "/vdirs/vdir1"
  8055. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  8056. BaseVirtualFolder: vfs.BaseVirtualFolder{
  8057. Name: folderName1,
  8058. },
  8059. VirtualPath: vpath1,
  8060. QuotaSize: -1,
  8061. QuotaFiles: -1,
  8062. })
  8063. mappedPath2 := filepath.Join(os.TempDir(), "mapped1", "dir", "mapped2")
  8064. folderName2 := filepath.Base(mappedPath2)
  8065. vpath2 := "/vdirs/vdir2"
  8066. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  8067. BaseVirtualFolder: vfs.BaseVirtualFolder{
  8068. Name: folderName2,
  8069. },
  8070. VirtualPath: vpath2,
  8071. QuotaSize: -1,
  8072. QuotaFiles: -1,
  8073. })
  8074. mappedPath3 := filepath.Join(os.TempDir(), "mapped3")
  8075. folderName3 := filepath.Base(mappedPath3)
  8076. vpath3 := "/vdirs/vdir3"
  8077. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  8078. BaseVirtualFolder: vfs.BaseVirtualFolder{
  8079. Name: folderName3,
  8080. },
  8081. VirtualPath: vpath3,
  8082. QuotaSize: -1,
  8083. QuotaFiles: -1,
  8084. })
  8085. mappedPath4 := filepath.Join(os.TempDir(), "mapped4")
  8086. folderName4 := filepath.Base(mappedPath4)
  8087. vpath4 := "/vdirs/vdir4"
  8088. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  8089. BaseVirtualFolder: vfs.BaseVirtualFolder{
  8090. Name: folderName4,
  8091. },
  8092. VirtualPath: vpath4,
  8093. QuotaSize: -1,
  8094. QuotaFiles: -1,
  8095. })
  8096. f1 := vfs.BaseVirtualFolder{
  8097. Name: folderName1,
  8098. MappedPath: mappedPath1,
  8099. }
  8100. _, _, err = httpdtest.AddFolder(f1, http.StatusCreated)
  8101. assert.NoError(t, err)
  8102. f2 := vfs.BaseVirtualFolder{
  8103. Name: folderName2,
  8104. MappedPath: mappedPath2,
  8105. }
  8106. _, _, err = httpdtest.AddFolder(f2, http.StatusCreated)
  8107. assert.NoError(t, err)
  8108. f3 := vfs.BaseVirtualFolder{
  8109. Name: folderName3,
  8110. MappedPath: mappedPath3,
  8111. FsConfig: vfs.Filesystem{
  8112. Provider: sdk.CryptedFilesystemProvider,
  8113. CryptConfig: vfs.CryptFsConfig{
  8114. Passphrase: kms.NewPlainSecret(defaultPassword),
  8115. },
  8116. },
  8117. }
  8118. _, _, err = httpdtest.AddFolder(f3, http.StatusCreated)
  8119. assert.NoError(t, err)
  8120. f4 := vfs.BaseVirtualFolder{
  8121. Name: folderName4,
  8122. MappedPath: mappedPath4,
  8123. FsConfig: vfs.Filesystem{
  8124. Provider: sdk.SFTPFilesystemProvider,
  8125. SFTPConfig: vfs.SFTPFsConfig{
  8126. BaseSFTPFsConfig: sdk.BaseSFTPFsConfig{
  8127. Endpoint: sftpServerAddr,
  8128. Username: baseUser.Username,
  8129. },
  8130. Password: kms.NewPlainSecret(defaultPassword),
  8131. },
  8132. },
  8133. }
  8134. _, _, err = httpdtest.AddFolder(f4, http.StatusCreated)
  8135. assert.NoError(t, err)
  8136. user, resp, err := httpdtest.AddUser(u, http.StatusCreated)
  8137. assert.NoError(t, err, string(resp))
  8138. conn, client, err := getSftpClient(user)
  8139. if assert.NoError(t, err) {
  8140. defer conn.Close()
  8141. defer client.Close()
  8142. baseFileSize := int64(100)
  8143. err = writeSFTPFile(path.Join(vpath1, testFileName), baseFileSize+1, client)
  8144. assert.NoError(t, err)
  8145. err = writeSFTPFile(path.Join(vpath2, testFileName), baseFileSize+2, client)
  8146. assert.NoError(t, err)
  8147. err = writeSFTPFile(path.Join(vpath3, testFileName), baseFileSize+3, client)
  8148. assert.NoError(t, err)
  8149. err = writeSFTPFile(path.Join(vpath4, testFileName), baseFileSize+4, client)
  8150. assert.NoError(t, err)
  8151. // cannot remove a directory with virtual folders inside
  8152. out, err := runSSHCommand(fmt.Sprintf(`sftpgo-remove %s`, path.Dir(vpath1)), user)
  8153. assert.Error(t, err, string(out))
  8154. // copy across virtual folders
  8155. copyDir := "/copy"
  8156. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s %s/`, path.Dir(vpath1), copyDir), user)
  8157. assert.NoError(t, err, string(out))
  8158. // check the copy
  8159. info, err := client.Stat(path.Join(copyDir, vpath1, testFileName))
  8160. if assert.NoError(t, err) {
  8161. assert.Equal(t, baseFileSize+1, info.Size())
  8162. }
  8163. info, err = client.Stat(path.Join(copyDir, vpath2, testFileName))
  8164. if assert.NoError(t, err) {
  8165. assert.Equal(t, baseFileSize+2, info.Size())
  8166. }
  8167. info, err = client.Stat(path.Join(copyDir, vpath3, testFileName))
  8168. if assert.NoError(t, err) {
  8169. assert.Equal(t, baseFileSize+3, info.Size())
  8170. }
  8171. info, err = client.Stat(path.Join(copyDir, vpath4, testFileName))
  8172. if assert.NoError(t, err) {
  8173. assert.Equal(t, baseFileSize+4, info.Size())
  8174. }
  8175. // nested fs paths
  8176. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s %s`, vpath1, vpath2), user)
  8177. assert.Error(t, err, string(out))
  8178. }
  8179. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  8180. assert.NoError(t, err)
  8181. err = os.RemoveAll(user.GetHomeDir())
  8182. assert.NoError(t, err)
  8183. _, err = httpdtest.RemoveUser(baseUser, http.StatusOK)
  8184. assert.NoError(t, err)
  8185. err = os.RemoveAll(baseUser.GetHomeDir())
  8186. assert.NoError(t, err)
  8187. for _, folderName := range []string{folderName1, folderName2, folderName3, folderName4} {
  8188. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName}, http.StatusOK)
  8189. assert.NoError(t, err)
  8190. err = os.RemoveAll(filepath.Join(os.TempDir(), folderName))
  8191. assert.NoError(t, err)
  8192. }
  8193. }
  8194. func TestHTTPFs(t *testing.T) {
  8195. u := getTestUserWithHTTPFs()
  8196. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  8197. assert.NoError(t, err)
  8198. err = os.MkdirAll(user.GetHomeDir(), os.ModePerm)
  8199. assert.NoError(t, err)
  8200. conn := common.NewBaseConnection(xid.New().String(), common.ProtocolFTP, "", "", user)
  8201. err = conn.CreateDir(httpFsWellKnowDir, false)
  8202. assert.NoError(t, err)
  8203. err = os.WriteFile(filepath.Join(os.TempDir(), "httpfs", defaultHTTPFsUsername, httpFsWellKnowDir, "file.txt"), []byte("data"), 0666)
  8204. assert.NoError(t, err)
  8205. err = conn.Copy(httpFsWellKnowDir, httpFsWellKnowDir+"_copy")
  8206. assert.NoError(t, err)
  8207. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  8208. assert.NoError(t, err)
  8209. err = os.RemoveAll(user.GetHomeDir())
  8210. assert.NoError(t, err)
  8211. }
  8212. func TestProxyProtocol(t *testing.T) {
  8213. resp, err := httpclient.Get(fmt.Sprintf("http://%v", httpProxyAddr))
  8214. if assert.NoError(t, err) {
  8215. defer resp.Body.Close()
  8216. assert.Equal(t, http.StatusBadRequest, resp.StatusCode)
  8217. }
  8218. }
  8219. func TestSetProtocol(t *testing.T) {
  8220. conn := common.NewBaseConnection("id", "sshd_exec", "", "", dataprovider.User{BaseUser: sdk.BaseUser{HomeDir: os.TempDir()}})
  8221. conn.SetProtocol(common.ProtocolSCP)
  8222. require.Equal(t, "SCP_id", conn.GetID())
  8223. }
  8224. func TestGetFsError(t *testing.T) {
  8225. u := getTestUser()
  8226. u.FsConfig.Provider = sdk.GCSFilesystemProvider
  8227. u.FsConfig.GCSConfig.Bucket = "test"
  8228. u.FsConfig.GCSConfig.Credentials = kms.NewPlainSecret("invalid JSON for credentials")
  8229. conn := common.NewBaseConnection("", common.ProtocolFTP, "", "", u)
  8230. _, _, err := conn.GetFsAndResolvedPath("/vpath")
  8231. assert.Error(t, err)
  8232. }
  8233. func waitTCPListening(address string) {
  8234. for {
  8235. conn, err := net.Dial("tcp", address)
  8236. if err != nil {
  8237. logger.WarnToConsole("tcp server %v not listening: %v", address, err)
  8238. time.Sleep(100 * time.Millisecond)
  8239. continue
  8240. }
  8241. logger.InfoToConsole("tcp server %v now listening", address)
  8242. conn.Close()
  8243. break
  8244. }
  8245. }
  8246. func checkBasicSFTP(client *sftp.Client) error {
  8247. _, err := client.Getwd()
  8248. if err != nil {
  8249. return err
  8250. }
  8251. _, err = client.ReadDir(".")
  8252. return err
  8253. }
  8254. func getCustomAuthSftpClient(user dataprovider.User, authMethods []ssh.AuthMethod) (*ssh.Client, *sftp.Client, error) {
  8255. var sftpClient *sftp.Client
  8256. config := &ssh.ClientConfig{
  8257. User: user.Username,
  8258. HostKeyCallback: func(hostname string, remote net.Addr, key ssh.PublicKey) error {
  8259. return nil
  8260. },
  8261. Auth: authMethods,
  8262. Timeout: 5 * time.Second,
  8263. }
  8264. conn, err := ssh.Dial("tcp", sftpServerAddr, config)
  8265. if err != nil {
  8266. return conn, sftpClient, err
  8267. }
  8268. sftpClient, err = sftp.NewClient(conn)
  8269. if err != nil {
  8270. conn.Close()
  8271. }
  8272. return conn, sftpClient, err
  8273. }
  8274. func getSftpClient(user dataprovider.User) (*ssh.Client, *sftp.Client, error) {
  8275. var sftpClient *sftp.Client
  8276. config := &ssh.ClientConfig{
  8277. User: user.Username,
  8278. HostKeyCallback: func(hostname string, remote net.Addr, key ssh.PublicKey) error {
  8279. return nil
  8280. },
  8281. Timeout: 5 * time.Second,
  8282. }
  8283. if user.Password != "" {
  8284. config.Auth = []ssh.AuthMethod{ssh.Password(user.Password)}
  8285. } else {
  8286. config.Auth = []ssh.AuthMethod{ssh.Password(defaultPassword)}
  8287. }
  8288. conn, err := ssh.Dial("tcp", sftpServerAddr, config)
  8289. if err != nil {
  8290. return conn, sftpClient, err
  8291. }
  8292. sftpClient, err = sftp.NewClient(conn)
  8293. if err != nil {
  8294. conn.Close()
  8295. }
  8296. return conn, sftpClient, err
  8297. }
  8298. func runSSHCommand(command string, user dataprovider.User) ([]byte, error) {
  8299. var sshSession *ssh.Session
  8300. var output []byte
  8301. config := &ssh.ClientConfig{
  8302. User: user.Username,
  8303. HostKeyCallback: func(hostname string, remote net.Addr, key ssh.PublicKey) error {
  8304. return nil
  8305. },
  8306. Timeout: 5 * time.Second,
  8307. }
  8308. if user.Password != "" {
  8309. config.Auth = []ssh.AuthMethod{ssh.Password(user.Password)}
  8310. } else {
  8311. config.Auth = []ssh.AuthMethod{ssh.Password(defaultPassword)}
  8312. }
  8313. conn, err := ssh.Dial("tcp", sftpServerAddr, config)
  8314. if err != nil {
  8315. return output, err
  8316. }
  8317. defer conn.Close()
  8318. sshSession, err = conn.NewSession()
  8319. if err != nil {
  8320. return output, err
  8321. }
  8322. var stdout, stderr bytes.Buffer
  8323. sshSession.Stdout = &stdout
  8324. sshSession.Stderr = &stderr
  8325. err = sshSession.Run(command)
  8326. if err != nil {
  8327. return nil, fmt.Errorf("failed to run command %v: %v", command, stderr.Bytes())
  8328. }
  8329. return stdout.Bytes(), err
  8330. }
  8331. func getWebDavClient(user dataprovider.User) *gowebdav.Client {
  8332. rootPath := fmt.Sprintf("http://localhost:%d/", webDavServerPort)
  8333. pwd := defaultPassword
  8334. if user.Password != "" {
  8335. pwd = user.Password
  8336. }
  8337. client := gowebdav.NewClient(rootPath, user.Username, pwd)
  8338. client.SetTimeout(10 * time.Second)
  8339. return client
  8340. }
  8341. func getTestUser() dataprovider.User {
  8342. user := dataprovider.User{
  8343. BaseUser: sdk.BaseUser{
  8344. Username: defaultUsername,
  8345. Password: defaultPassword,
  8346. HomeDir: filepath.Join(homeBasePath, defaultUsername),
  8347. Status: 1,
  8348. ExpirationDate: 0,
  8349. },
  8350. }
  8351. user.Permissions = make(map[string][]string)
  8352. user.Permissions["/"] = allPerms
  8353. return user
  8354. }
  8355. func getTestSFTPUser() dataprovider.User {
  8356. u := getTestUser()
  8357. u.Username = defaultSFTPUsername
  8358. u.FsConfig.Provider = sdk.SFTPFilesystemProvider
  8359. u.FsConfig.SFTPConfig.Endpoint = sftpServerAddr
  8360. u.FsConfig.SFTPConfig.Username = defaultUsername
  8361. u.FsConfig.SFTPConfig.Password = kms.NewPlainSecret(defaultPassword)
  8362. return u
  8363. }
  8364. func getCryptFsUser() dataprovider.User {
  8365. u := getTestUser()
  8366. u.Username += "_crypt"
  8367. u.FsConfig.Provider = sdk.CryptedFilesystemProvider
  8368. u.FsConfig.CryptConfig.Passphrase = kms.NewPlainSecret(defaultPassword)
  8369. return u
  8370. }
  8371. func getTestUserWithHTTPFs() dataprovider.User {
  8372. u := getTestUser()
  8373. u.FsConfig.Provider = sdk.HTTPFilesystemProvider
  8374. u.FsConfig.HTTPConfig = vfs.HTTPFsConfig{
  8375. BaseHTTPFsConfig: sdk.BaseHTTPFsConfig{
  8376. Endpoint: fmt.Sprintf("http://127.0.0.1:%d/api/v1", httpFsPort),
  8377. Username: defaultHTTPFsUsername,
  8378. },
  8379. }
  8380. return u
  8381. }
  8382. func writeSFTPFile(name string, size int64, client *sftp.Client) error {
  8383. err := writeSFTPFileNoCheck(name, size, client)
  8384. if err != nil {
  8385. return err
  8386. }
  8387. info, err := client.Stat(name)
  8388. if err != nil {
  8389. return err
  8390. }
  8391. if info.Size() != size {
  8392. return fmt.Errorf("file size mismatch, wanted %v, actual %v", size, info.Size())
  8393. }
  8394. return nil
  8395. }
  8396. func writeSFTPFileNoCheck(name string, size int64, client *sftp.Client) error {
  8397. content := make([]byte, size)
  8398. _, err := rand.Read(content)
  8399. if err != nil {
  8400. return err
  8401. }
  8402. f, err := client.Create(name)
  8403. if err != nil {
  8404. return err
  8405. }
  8406. _, err = io.Copy(f, bytes.NewBuffer(content))
  8407. if err != nil {
  8408. f.Close()
  8409. return err
  8410. }
  8411. return f.Close()
  8412. }
  8413. func getUploadScriptEnvContent(envVar string) []byte {
  8414. content := []byte("#!/bin/sh\n\n")
  8415. content = append(content, []byte(fmt.Sprintf("if [ -z \"$%s\" ]\n", envVar))...)
  8416. content = append(content, []byte("then\n")...)
  8417. content = append(content, []byte(" exit 1\n")...)
  8418. content = append(content, []byte("else\n")...)
  8419. content = append(content, []byte(" exit 0\n")...)
  8420. content = append(content, []byte("fi\n")...)
  8421. return content
  8422. }
  8423. func getUploadScriptContent(movedPath, logFilePath string, exitStatus int) []byte {
  8424. content := []byte("#!/bin/sh\n\n")
  8425. content = append(content, []byte("sleep 1\n")...)
  8426. if logFilePath != "" {
  8427. content = append(content, []byte(fmt.Sprintf("echo $@ > %v\n", logFilePath))...)
  8428. }
  8429. content = append(content, []byte(fmt.Sprintf("mv ${SFTPGO_ACTION_PATH} %v\n", movedPath))...)
  8430. content = append(content, []byte(fmt.Sprintf("exit %d", exitStatus))...)
  8431. return content
  8432. }
  8433. func getSaveProviderObjectScriptContent(outFilePath string, exitStatus int) []byte {
  8434. content := []byte("#!/bin/sh\n\n")
  8435. content = append(content, []byte(fmt.Sprintf("echo ${SFTPGO_OBJECT_DATA} > %v\n", outFilePath))...)
  8436. content = append(content, []byte(fmt.Sprintf("exit %d", exitStatus))...)
  8437. return content
  8438. }
  8439. func generateTOTPPasscode(secret string, algo otp.Algorithm) (string, error) {
  8440. return totp.GenerateCodeCustom(secret, time.Now(), totp.ValidateOpts{
  8441. Period: 30,
  8442. Skew: 1,
  8443. Digits: otp.DigitsSix,
  8444. Algorithm: algo,
  8445. })
  8446. }
  8447. func isDbDefenderSupported() bool {
  8448. // SQLite shares the implementation with other SQL-based provider but it makes no sense
  8449. // to use it outside test cases
  8450. switch dataprovider.GetProviderStatus().Driver {
  8451. case dataprovider.MySQLDataProviderName, dataprovider.PGSQLDataProviderName,
  8452. dataprovider.CockroachDataProviderName, dataprovider.SQLiteDataProviderName:
  8453. return true
  8454. default:
  8455. return false
  8456. }
  8457. }
  8458. func getEncryptedFileSize(size int64) (int64, error) {
  8459. encSize, err := sio.EncryptedSize(uint64(size))
  8460. return int64(encSize) + 33, err
  8461. }
  8462. func printLatestLogs(maxNumberOfLines int) {
  8463. var lines []string
  8464. f, err := os.Open(logFilePath)
  8465. if err != nil {
  8466. return
  8467. }
  8468. defer f.Close()
  8469. scanner := bufio.NewScanner(f)
  8470. for scanner.Scan() {
  8471. lines = append(lines, scanner.Text()+"\r\n")
  8472. for len(lines) > maxNumberOfLines {
  8473. lines = lines[1:]
  8474. }
  8475. }
  8476. if scanner.Err() != nil {
  8477. logger.WarnToConsole("Unable to print latest logs: %v", scanner.Err())
  8478. return
  8479. }
  8480. for _, line := range lines {
  8481. logger.DebugToConsole(line)
  8482. }
  8483. }
  8484. type receivedEmail struct {
  8485. sync.RWMutex
  8486. From string
  8487. To []string
  8488. Data string
  8489. }
  8490. func (e *receivedEmail) set(from string, to []string, data []byte) {
  8491. e.Lock()
  8492. defer e.Unlock()
  8493. e.From = from
  8494. e.To = to
  8495. e.Data = strings.ReplaceAll(string(data), "=\r\n", "")
  8496. }
  8497. func (e *receivedEmail) reset() {
  8498. e.Lock()
  8499. defer e.Unlock()
  8500. e.From = ""
  8501. e.To = nil
  8502. e.Data = ""
  8503. }
  8504. func (e *receivedEmail) get() receivedEmail {
  8505. e.RLock()
  8506. defer e.RUnlock()
  8507. return receivedEmail{
  8508. From: e.From,
  8509. To: e.To,
  8510. Data: e.Data,
  8511. }
  8512. }
  8513. func startHTTPFs() {
  8514. go func() {
  8515. readdirCallback := func(name string) []os.FileInfo {
  8516. if name == httpFsWellKnowDir {
  8517. return []os.FileInfo{vfs.NewFileInfo("ghost.txt", false, 0, time.Unix(0, 0), false)}
  8518. }
  8519. return nil
  8520. }
  8521. callbacks := &httpdtest.HTTPFsCallbacks{
  8522. Readdir: readdirCallback,
  8523. }
  8524. if err := httpdtest.StartTestHTTPFs(httpFsPort, callbacks); err != nil {
  8525. logger.ErrorToConsole("could not start HTTPfs test server: %v", err)
  8526. os.Exit(1)
  8527. }
  8528. }()
  8529. waitTCPListening(fmt.Sprintf(":%d", httpFsPort))
  8530. }