protocol_test.go 289 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951
  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: "[email protected]",
  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{"[email protected]", "[email protected]"},
  3511. Bcc: []string{"[email protected]"},
  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{"[email protected]"},
  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, "[email protected]"))
  3702. assert.True(t, util.Contains(email.To, "[email protected]"))
  3703. assert.True(t, util.Contains(email.To, "[email protected]"))
  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, "[email protected]"))
  3723. assert.True(t, util.Contains(email.To, "[email protected]"))
  3724. assert.True(t, util.Contains(email.To, "[email protected]"))
  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, "[email protected]"))
  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, "[email protected]"))
  3759. assert.True(t, util.Contains(email.To, "[email protected]"))
  3760. assert.True(t, util.Contains(email.To, "[email protected]"))
  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, "[email protected]"))
  3798. assert.True(t, util.Contains(email.To, "[email protected]"))
  3799. assert.True(t, util.Contains(email.To, "[email protected]"))
  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: "[email protected]",
  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{"[email protected]"},
  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{"[email protected]"},
  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, "[email protected]"))
  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, "[email protected]"))
  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: "[email protected]",
  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{"[email protected]"},
  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 TestFsActionCopy(t *testing.T) {
  4631. a1 := dataprovider.BaseEventAction{
  4632. Name: "a1",
  4633. Type: dataprovider.ActionTypeFilesystem,
  4634. Options: dataprovider.BaseEventActionOptions{
  4635. FsConfig: dataprovider.EventActionFilesystemConfig{
  4636. Type: dataprovider.FilesystemActionCopy,
  4637. Copy: []dataprovider.KeyValue{
  4638. {
  4639. Key: "/{{VirtualPath}}/",
  4640. Value: "/dircopy/",
  4641. },
  4642. },
  4643. },
  4644. },
  4645. }
  4646. action1, resp, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  4647. assert.NoError(t, err, string(resp))
  4648. r1 := dataprovider.EventRule{
  4649. Name: "rule1",
  4650. Status: 1,
  4651. Trigger: dataprovider.EventTriggerFsEvent,
  4652. Conditions: dataprovider.EventConditions{
  4653. FsEvents: []string{"upload"},
  4654. },
  4655. Actions: []dataprovider.EventAction{
  4656. {
  4657. BaseEventAction: dataprovider.BaseEventAction{
  4658. Name: action1.Name,
  4659. },
  4660. Order: 1,
  4661. Options: dataprovider.EventActionOptions{
  4662. ExecuteSync: true,
  4663. },
  4664. },
  4665. },
  4666. }
  4667. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  4668. assert.NoError(t, err)
  4669. u := getTestUser()
  4670. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  4671. assert.NoError(t, err)
  4672. conn, client, err := getSftpClient(user)
  4673. if assert.NoError(t, err) {
  4674. defer conn.Close()
  4675. defer client.Close()
  4676. err = writeSFTPFile(testFileName, 100, client)
  4677. assert.NoError(t, err)
  4678. _, err = client.Stat(path.Join("dircopy", testFileName))
  4679. assert.NoError(t, err)
  4680. action1.Options.FsConfig.Copy = []dataprovider.KeyValue{
  4681. {
  4682. Key: "/missing path",
  4683. Value: "/copied path",
  4684. },
  4685. }
  4686. _, _, err = httpdtest.UpdateEventAction(action1, http.StatusOK)
  4687. assert.NoError(t, err)
  4688. // copy a missing path will fail
  4689. err = writeSFTPFile(testFileName, 100, client)
  4690. assert.Error(t, err)
  4691. }
  4692. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  4693. assert.NoError(t, err)
  4694. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  4695. assert.NoError(t, err)
  4696. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  4697. assert.NoError(t, err)
  4698. err = os.RemoveAll(user.GetHomeDir())
  4699. assert.NoError(t, err)
  4700. }
  4701. func TestEventFsActionsGroupFilters(t *testing.T) {
  4702. smtpCfg := smtp.Config{
  4703. Host: "127.0.0.1",
  4704. Port: 2525,
  4705. From: "[email protected]",
  4706. TemplatesPath: "templates",
  4707. }
  4708. err := smtpCfg.Initialize(configDir, true)
  4709. require.NoError(t, err)
  4710. a1 := dataprovider.BaseEventAction{
  4711. Name: "a1",
  4712. Type: dataprovider.ActionTypeEmail,
  4713. Options: dataprovider.BaseEventActionOptions{
  4714. EmailConfig: dataprovider.EventActionEmailConfig{
  4715. Recipients: []string{"[email protected]"},
  4716. Subject: `New "{{Event}}" from "{{Name}}" status {{StatusString}}`,
  4717. Body: "Fs path {{FsPath}}, size: {{FileSize}}, protocol: {{Protocol}}, IP: {{IP}} {{ErrorString}}",
  4718. },
  4719. },
  4720. }
  4721. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  4722. assert.NoError(t, err)
  4723. r1 := dataprovider.EventRule{
  4724. Name: "rule1",
  4725. Status: 1,
  4726. Trigger: dataprovider.EventTriggerFsEvent,
  4727. Conditions: dataprovider.EventConditions{
  4728. FsEvents: []string{"upload"},
  4729. Options: dataprovider.ConditionOptions{
  4730. GroupNames: []dataprovider.ConditionPattern{
  4731. {
  4732. Pattern: "group*",
  4733. },
  4734. },
  4735. },
  4736. },
  4737. Actions: []dataprovider.EventAction{
  4738. {
  4739. BaseEventAction: dataprovider.BaseEventAction{
  4740. Name: action1.Name,
  4741. },
  4742. Order: 1,
  4743. Options: dataprovider.EventActionOptions{
  4744. ExecuteSync: true,
  4745. },
  4746. },
  4747. },
  4748. }
  4749. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  4750. assert.NoError(t, err)
  4751. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  4752. assert.NoError(t, err)
  4753. conn, client, err := getSftpClient(user)
  4754. if assert.NoError(t, err) {
  4755. defer conn.Close()
  4756. defer client.Close()
  4757. // the user has no group, so the rule does not match
  4758. lastReceivedEmail.reset()
  4759. err = writeSFTPFile(testFileName, 32, client)
  4760. assert.NoError(t, err)
  4761. assert.Empty(t, lastReceivedEmail.get().From)
  4762. }
  4763. g1 := dataprovider.Group{
  4764. BaseGroup: sdk.BaseGroup{
  4765. Name: "agroup1",
  4766. },
  4767. }
  4768. group1, _, err := httpdtest.AddGroup(g1, http.StatusCreated)
  4769. assert.NoError(t, err)
  4770. g2 := dataprovider.Group{
  4771. BaseGroup: sdk.BaseGroup{
  4772. Name: "group2",
  4773. },
  4774. }
  4775. group2, _, err := httpdtest.AddGroup(g2, http.StatusCreated)
  4776. assert.NoError(t, err)
  4777. user.Groups = []sdk.GroupMapping{
  4778. {
  4779. Name: group1.Name,
  4780. Type: sdk.GroupTypePrimary,
  4781. },
  4782. }
  4783. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  4784. assert.NoError(t, err)
  4785. conn, client, err = getSftpClient(user)
  4786. if assert.NoError(t, err) {
  4787. defer conn.Close()
  4788. defer client.Close()
  4789. // the group does not match
  4790. lastReceivedEmail.reset()
  4791. err = writeSFTPFile(testFileName, 32, client)
  4792. assert.NoError(t, err)
  4793. assert.Empty(t, lastReceivedEmail.get().From)
  4794. }
  4795. user.Groups = append(user.Groups, sdk.GroupMapping{
  4796. Name: group2.Name,
  4797. Type: sdk.GroupTypeSecondary,
  4798. })
  4799. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  4800. assert.NoError(t, err)
  4801. conn, client, err = getSftpClient(user)
  4802. if assert.NoError(t, err) {
  4803. defer conn.Close()
  4804. defer client.Close()
  4805. // the group matches
  4806. lastReceivedEmail.reset()
  4807. err = writeSFTPFile(testFileName, 32, client)
  4808. assert.NoError(t, err)
  4809. assert.NotEmpty(t, lastReceivedEmail.get().From)
  4810. }
  4811. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  4812. assert.NoError(t, err)
  4813. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  4814. assert.NoError(t, err)
  4815. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  4816. assert.NoError(t, err)
  4817. err = os.RemoveAll(user.GetHomeDir())
  4818. assert.NoError(t, err)
  4819. _, err = httpdtest.RemoveGroup(group1, http.StatusOK)
  4820. assert.NoError(t, err)
  4821. _, err = httpdtest.RemoveGroup(group2, http.StatusOK)
  4822. assert.NoError(t, err)
  4823. smtpCfg = smtp.Config{}
  4824. err = smtpCfg.Initialize(configDir, true)
  4825. require.NoError(t, err)
  4826. }
  4827. func TestBackupAsAttachment(t *testing.T) {
  4828. smtpCfg := smtp.Config{
  4829. Host: "127.0.0.1",
  4830. Port: 2525,
  4831. From: "[email protected]",
  4832. TemplatesPath: "templates",
  4833. }
  4834. err := smtpCfg.Initialize(configDir, true)
  4835. require.NoError(t, err)
  4836. a1 := dataprovider.BaseEventAction{
  4837. Name: "a1",
  4838. Type: dataprovider.ActionTypeBackup,
  4839. }
  4840. a2 := dataprovider.BaseEventAction{
  4841. Name: "a2",
  4842. Type: dataprovider.ActionTypeEmail,
  4843. Options: dataprovider.BaseEventActionOptions{
  4844. EmailConfig: dataprovider.EventActionEmailConfig{
  4845. Recipients: []string{"[email protected]"},
  4846. Subject: `"{{Event}} {{StatusString}}"`,
  4847. Body: "Domain: {{Name}}",
  4848. Attachments: []string{"/{{VirtualPath}}"},
  4849. },
  4850. },
  4851. }
  4852. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  4853. assert.NoError(t, err)
  4854. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  4855. assert.NoError(t, err)
  4856. r1 := dataprovider.EventRule{
  4857. Name: "test rule certificate",
  4858. Status: 1,
  4859. Trigger: dataprovider.EventTriggerCertificate,
  4860. Actions: []dataprovider.EventAction{
  4861. {
  4862. BaseEventAction: dataprovider.BaseEventAction{
  4863. Name: action1.Name,
  4864. },
  4865. Order: 1,
  4866. },
  4867. {
  4868. BaseEventAction: dataprovider.BaseEventAction{
  4869. Name: action2.Name,
  4870. },
  4871. Order: 2,
  4872. },
  4873. },
  4874. }
  4875. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  4876. assert.NoError(t, err)
  4877. lastReceivedEmail.reset()
  4878. renewalEvent := "Certificate renewal"
  4879. common.HandleCertificateEvent(common.EventParams{
  4880. Name: "example.com",
  4881. Timestamp: time.Now().UnixNano(),
  4882. Status: 1,
  4883. Event: renewalEvent,
  4884. })
  4885. assert.Eventually(t, func() bool {
  4886. return lastReceivedEmail.get().From != ""
  4887. }, 3000*time.Millisecond, 100*time.Millisecond)
  4888. email := lastReceivedEmail.get()
  4889. assert.Len(t, email.To, 1)
  4890. assert.True(t, util.Contains(email.To, "[email protected]"))
  4891. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "%s OK"`, renewalEvent))
  4892. assert.Contains(t, email.Data, `Domain: example.com`)
  4893. assert.Contains(t, email.Data, "Content-Type: application/json")
  4894. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  4895. assert.NoError(t, err)
  4896. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  4897. assert.NoError(t, err)
  4898. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  4899. assert.NoError(t, err)
  4900. smtpCfg = smtp.Config{}
  4901. err = smtpCfg.Initialize(configDir, true)
  4902. require.NoError(t, err)
  4903. }
  4904. func TestEventActionHTTPMultipart(t *testing.T) {
  4905. a1 := dataprovider.BaseEventAction{
  4906. Name: "action1",
  4907. Type: dataprovider.ActionTypeHTTP,
  4908. Options: dataprovider.BaseEventActionOptions{
  4909. HTTPConfig: dataprovider.EventActionHTTPConfig{
  4910. Endpoint: fmt.Sprintf("http://%s/multipart", httpAddr),
  4911. Method: http.MethodPut,
  4912. Parts: []dataprovider.HTTPPart{
  4913. {
  4914. Name: "part1",
  4915. Headers: []dataprovider.KeyValue{
  4916. {
  4917. Key: "Content-Type",
  4918. Value: "application/json",
  4919. },
  4920. },
  4921. Body: `{"FilePath": "{{VirtualPath}}"}`,
  4922. },
  4923. {
  4924. Name: "file",
  4925. Filepath: "/{{VirtualPath}}",
  4926. },
  4927. },
  4928. },
  4929. },
  4930. }
  4931. action1, resp, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  4932. assert.NoError(t, err, string(resp))
  4933. r1 := dataprovider.EventRule{
  4934. Name: "test http multipart",
  4935. Status: 1,
  4936. Trigger: dataprovider.EventTriggerFsEvent,
  4937. Conditions: dataprovider.EventConditions{
  4938. FsEvents: []string{"upload"},
  4939. },
  4940. Actions: []dataprovider.EventAction{
  4941. {
  4942. BaseEventAction: dataprovider.BaseEventAction{
  4943. Name: action1.Name,
  4944. },
  4945. Options: dataprovider.EventActionOptions{
  4946. ExecuteSync: true,
  4947. },
  4948. Order: 1,
  4949. },
  4950. },
  4951. }
  4952. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  4953. assert.NoError(t, err)
  4954. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  4955. assert.NoError(t, err)
  4956. conn, client, err := getSftpClient(user)
  4957. if assert.NoError(t, err) {
  4958. defer conn.Close()
  4959. defer client.Close()
  4960. f, err := client.Create(testFileName)
  4961. assert.NoError(t, err)
  4962. _, err = f.Write(testFileContent)
  4963. assert.NoError(t, err)
  4964. err = f.Close()
  4965. assert.NoError(t, err)
  4966. // now add an missing file to the http multipart action
  4967. action1.Options.HTTPConfig.Parts = append(action1.Options.HTTPConfig.Parts, dataprovider.HTTPPart{
  4968. Name: "file1",
  4969. Filepath: "/missing",
  4970. })
  4971. _, resp, err = httpdtest.UpdateEventAction(action1, http.StatusOK)
  4972. assert.NoError(t, err, string(resp))
  4973. f, err = client.Create("testfile.txt")
  4974. assert.NoError(t, err)
  4975. _, err = f.Write(testFileContent)
  4976. assert.NoError(t, err)
  4977. err = f.Close()
  4978. assert.Error(t, err)
  4979. }
  4980. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  4981. assert.NoError(t, err)
  4982. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  4983. assert.NoError(t, err)
  4984. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  4985. assert.NoError(t, err)
  4986. err = os.RemoveAll(user.GetHomeDir())
  4987. assert.NoError(t, err)
  4988. }
  4989. func TestEventActionCompress(t *testing.T) {
  4990. a1 := dataprovider.BaseEventAction{
  4991. Name: "action1",
  4992. Type: dataprovider.ActionTypeFilesystem,
  4993. Options: dataprovider.BaseEventActionOptions{
  4994. FsConfig: dataprovider.EventActionFilesystemConfig{
  4995. Type: dataprovider.FilesystemActionCompress,
  4996. Compress: dataprovider.EventActionFsCompress{
  4997. Name: "/{{VirtualPath}}.zip",
  4998. Paths: []string{"/{{VirtualPath}}"},
  4999. },
  5000. },
  5001. },
  5002. }
  5003. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  5004. assert.NoError(t, err)
  5005. r1 := dataprovider.EventRule{
  5006. Name: "test compress",
  5007. Status: 1,
  5008. Trigger: dataprovider.EventTriggerFsEvent,
  5009. Conditions: dataprovider.EventConditions{
  5010. FsEvents: []string{"upload"},
  5011. },
  5012. Actions: []dataprovider.EventAction{
  5013. {
  5014. BaseEventAction: dataprovider.BaseEventAction{
  5015. Name: action1.Name,
  5016. },
  5017. Order: 1,
  5018. Options: dataprovider.EventActionOptions{
  5019. ExecuteSync: true,
  5020. },
  5021. },
  5022. },
  5023. }
  5024. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  5025. assert.NoError(t, err)
  5026. u := getTestUser()
  5027. u.QuotaFiles = 1000
  5028. localUser, _, err := httpdtest.AddUser(u, http.StatusCreated)
  5029. assert.NoError(t, err)
  5030. u = getTestSFTPUser()
  5031. u.FsConfig.SFTPConfig.BufferSize = 1
  5032. u.QuotaFiles = 1000
  5033. sftpUser, _, err := httpdtest.AddUser(u, http.StatusCreated)
  5034. assert.NoError(t, err)
  5035. u = getCryptFsUser()
  5036. u.QuotaFiles = 1000
  5037. cryptFsUser, _, err := httpdtest.AddUser(u, http.StatusCreated)
  5038. assert.NoError(t, err)
  5039. for _, user := range []dataprovider.User{localUser, sftpUser, cryptFsUser} {
  5040. // cleanup home dir
  5041. err = os.RemoveAll(user.GetHomeDir())
  5042. assert.NoError(t, err)
  5043. rule1.Conditions.Options.Names = []dataprovider.ConditionPattern{
  5044. {
  5045. Pattern: user.Username,
  5046. },
  5047. }
  5048. _, _, err = httpdtest.UpdateEventRule(rule1, http.StatusOK)
  5049. assert.NoError(t, err)
  5050. conn, client, err := getSftpClient(user)
  5051. if assert.NoError(t, err) {
  5052. defer conn.Close()
  5053. defer client.Close()
  5054. expectedQuotaSize := int64(len(testFileContent))
  5055. expectedQuotaFiles := 1
  5056. if user.Username == cryptFsUser.Username {
  5057. encryptedFileSize, err := getEncryptedFileSize(expectedQuotaSize)
  5058. assert.NoError(t, err)
  5059. expectedQuotaSize = encryptedFileSize
  5060. }
  5061. f, err := client.Create(testFileName)
  5062. assert.NoError(t, err)
  5063. _, err = f.Write(testFileContent)
  5064. assert.NoError(t, err)
  5065. err = f.Close()
  5066. assert.NoError(t, err)
  5067. info, err := client.Stat(testFileName + ".zip") //nolint:goconst
  5068. if assert.NoError(t, err) {
  5069. assert.Greater(t, info.Size(), int64(0))
  5070. // check quota
  5071. archiveSize := info.Size()
  5072. if user.Username == cryptFsUser.Username {
  5073. encryptedFileSize, err := getEncryptedFileSize(archiveSize)
  5074. assert.NoError(t, err)
  5075. archiveSize = encryptedFileSize
  5076. }
  5077. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  5078. assert.NoError(t, err)
  5079. assert.Equal(t, expectedQuotaFiles+1, user.UsedQuotaFiles,
  5080. "quota file does no match for user %q", user.Username)
  5081. assert.Equal(t, expectedQuotaSize+archiveSize, user.UsedQuotaSize,
  5082. "quota size does no match for user %q", user.Username)
  5083. }
  5084. // now overwrite the same file
  5085. f, err = client.Create(testFileName)
  5086. assert.NoError(t, err)
  5087. _, err = f.Write(testFileContent)
  5088. assert.NoError(t, err)
  5089. err = f.Close()
  5090. assert.NoError(t, err)
  5091. info, err = client.Stat(testFileName + ".zip")
  5092. if assert.NoError(t, err) {
  5093. assert.Greater(t, info.Size(), int64(0))
  5094. archiveSize := info.Size()
  5095. if user.Username == cryptFsUser.Username {
  5096. encryptedFileSize, err := getEncryptedFileSize(archiveSize)
  5097. assert.NoError(t, err)
  5098. archiveSize = encryptedFileSize
  5099. }
  5100. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  5101. assert.NoError(t, err)
  5102. assert.Equal(t, expectedQuotaFiles+1, user.UsedQuotaFiles,
  5103. "quota file after overwrite does no match for user %q", user.Username)
  5104. assert.Equal(t, expectedQuotaSize+archiveSize, user.UsedQuotaSize,
  5105. "quota size after overwrite does no match for user %q", user.Username)
  5106. }
  5107. }
  5108. if user.Username == localUser.Username {
  5109. err = os.RemoveAll(user.GetHomeDir())
  5110. assert.NoError(t, err)
  5111. }
  5112. }
  5113. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  5114. assert.NoError(t, err)
  5115. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  5116. assert.NoError(t, err)
  5117. _, err = httpdtest.RemoveUser(sftpUser, http.StatusOK)
  5118. assert.NoError(t, err)
  5119. _, err = httpdtest.RemoveUser(localUser, http.StatusOK)
  5120. assert.NoError(t, err)
  5121. err = os.RemoveAll(localUser.GetHomeDir())
  5122. assert.NoError(t, err)
  5123. _, err = httpdtest.RemoveUser(cryptFsUser, http.StatusOK)
  5124. assert.NoError(t, err)
  5125. err = os.RemoveAll(cryptFsUser.GetHomeDir())
  5126. assert.NoError(t, err)
  5127. }
  5128. func TestEventActionCompressQuotaErrors(t *testing.T) {
  5129. smtpCfg := smtp.Config{
  5130. Host: "127.0.0.1",
  5131. Port: 2525,
  5132. From: "[email protected]",
  5133. TemplatesPath: "templates",
  5134. }
  5135. err := smtpCfg.Initialize(configDir, true)
  5136. require.NoError(t, err)
  5137. testDir := "archiveDir"
  5138. zipPath := "/archive.zip"
  5139. a1 := dataprovider.BaseEventAction{
  5140. Name: "action1",
  5141. Type: dataprovider.ActionTypeFilesystem,
  5142. Options: dataprovider.BaseEventActionOptions{
  5143. FsConfig: dataprovider.EventActionFilesystemConfig{
  5144. Type: dataprovider.FilesystemActionCompress,
  5145. Compress: dataprovider.EventActionFsCompress{
  5146. Name: zipPath,
  5147. Paths: []string{"/" + testDir},
  5148. },
  5149. },
  5150. },
  5151. }
  5152. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  5153. assert.NoError(t, err)
  5154. a2 := dataprovider.BaseEventAction{
  5155. Name: "action2",
  5156. Type: dataprovider.ActionTypeEmail,
  5157. Options: dataprovider.BaseEventActionOptions{
  5158. EmailConfig: dataprovider.EventActionEmailConfig{
  5159. Recipients: []string{"[email protected]"},
  5160. Subject: `"Compress failed"`,
  5161. Body: "Error: {{ErrorString}}",
  5162. },
  5163. },
  5164. }
  5165. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  5166. assert.NoError(t, err)
  5167. r1 := dataprovider.EventRule{
  5168. Name: "test compress",
  5169. Status: 1,
  5170. Trigger: dataprovider.EventTriggerFsEvent,
  5171. Conditions: dataprovider.EventConditions{
  5172. FsEvents: []string{"rename"},
  5173. },
  5174. Actions: []dataprovider.EventAction{
  5175. {
  5176. BaseEventAction: dataprovider.BaseEventAction{
  5177. Name: action1.Name,
  5178. },
  5179. Order: 1,
  5180. },
  5181. {
  5182. BaseEventAction: dataprovider.BaseEventAction{
  5183. Name: action2.Name,
  5184. },
  5185. Options: dataprovider.EventActionOptions{
  5186. IsFailureAction: true,
  5187. },
  5188. Order: 2,
  5189. },
  5190. },
  5191. }
  5192. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  5193. assert.NoError(t, err)
  5194. fileSize := int64(100)
  5195. u := getTestUser()
  5196. u.QuotaSize = 10 * fileSize
  5197. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  5198. assert.NoError(t, err)
  5199. conn, client, err := getSftpClient(user)
  5200. if assert.NoError(t, err) {
  5201. defer conn.Close()
  5202. defer client.Close()
  5203. err = client.MkdirAll(path.Join(testDir, "1", "1"))
  5204. assert.NoError(t, err)
  5205. err = writeSFTPFile(path.Join(testDir, "1", testFileName), fileSize, client)
  5206. assert.NoError(t, err)
  5207. err = client.MkdirAll(path.Join(testDir, "2", "2"))
  5208. assert.NoError(t, err)
  5209. err = writeSFTPFile(path.Join(testDir, "2", testFileName), fileSize, client)
  5210. assert.NoError(t, err)
  5211. err = client.Symlink(path.Join(testDir, "2", testFileName), path.Join(testDir, "2", testFileName+"_link"))
  5212. assert.NoError(t, err)
  5213. // trigger the compress action
  5214. err = client.Mkdir("a")
  5215. assert.NoError(t, err)
  5216. err = client.Rename("a", "b")
  5217. assert.NoError(t, err)
  5218. assert.Eventually(t, func() bool {
  5219. _, err := client.Stat(zipPath)
  5220. return err == nil
  5221. }, 3*time.Second, 100*time.Millisecond)
  5222. err = client.Remove(zipPath)
  5223. assert.NoError(t, err)
  5224. // add other 6 file, the compress action should fail with a quota error
  5225. err = writeSFTPFile(path.Join(testDir, "1", "1", testFileName), fileSize, client)
  5226. assert.NoError(t, err)
  5227. err = writeSFTPFile(path.Join(testDir, "2", "2", testFileName), fileSize, client)
  5228. assert.NoError(t, err)
  5229. err = writeSFTPFile(path.Join(testDir, "1", "1", testFileName+"1"), fileSize, client)
  5230. assert.NoError(t, err)
  5231. err = writeSFTPFile(path.Join(testDir, "2", "2", testFileName+"2"), fileSize, client)
  5232. assert.NoError(t, err)
  5233. err = writeSFTPFile(path.Join(testDir, "1", testFileName+"1"), fileSize, client)
  5234. assert.NoError(t, err)
  5235. err = writeSFTPFile(path.Join(testDir, "2", testFileName+"2"), fileSize, client)
  5236. assert.NoError(t, err)
  5237. lastReceivedEmail.reset()
  5238. err = client.Rename("b", "a")
  5239. assert.NoError(t, err)
  5240. assert.Eventually(t, func() bool {
  5241. return lastReceivedEmail.get().From != ""
  5242. }, 3*time.Second, 100*time.Millisecond)
  5243. email := lastReceivedEmail.get()
  5244. assert.Len(t, email.To, 1)
  5245. assert.True(t, util.Contains(email.To, "[email protected]"))
  5246. assert.Contains(t, email.Data, `Subject: "Compress failed"`)
  5247. assert.Contains(t, email.Data, common.ErrQuotaExceeded.Error())
  5248. // update quota size so the user is already overquota
  5249. user.QuotaSize = 7 * fileSize
  5250. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  5251. assert.NoError(t, err)
  5252. lastReceivedEmail.reset()
  5253. err = client.Rename("a", "b")
  5254. assert.NoError(t, err)
  5255. assert.Eventually(t, func() bool {
  5256. return lastReceivedEmail.get().From != ""
  5257. }, 3*time.Second, 100*time.Millisecond)
  5258. email = lastReceivedEmail.get()
  5259. assert.Len(t, email.To, 1)
  5260. assert.True(t, util.Contains(email.To, "[email protected]"))
  5261. assert.Contains(t, email.Data, `Subject: "Compress failed"`)
  5262. assert.Contains(t, email.Data, common.ErrQuotaExceeded.Error())
  5263. // remove the path to compress to trigger an error for size estimation
  5264. out, err := runSSHCommand(fmt.Sprintf("sftpgo-remove %s", testDir), user)
  5265. assert.NoError(t, err, string(out))
  5266. lastReceivedEmail.reset()
  5267. err = client.Rename("b", "a")
  5268. assert.NoError(t, err)
  5269. assert.Eventually(t, func() bool {
  5270. return lastReceivedEmail.get().From != ""
  5271. }, 3*time.Second, 100*time.Millisecond)
  5272. email = lastReceivedEmail.get()
  5273. assert.Len(t, email.To, 1)
  5274. assert.True(t, util.Contains(email.To, "[email protected]"))
  5275. assert.Contains(t, email.Data, `Subject: "Compress failed"`)
  5276. assert.Contains(t, email.Data, "unable to estimate archive size")
  5277. }
  5278. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  5279. assert.NoError(t, err)
  5280. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  5281. assert.NoError(t, err)
  5282. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  5283. assert.NoError(t, err)
  5284. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  5285. assert.NoError(t, err)
  5286. err = os.RemoveAll(user.GetHomeDir())
  5287. assert.NoError(t, err)
  5288. smtpCfg = smtp.Config{}
  5289. err = smtpCfg.Initialize(configDir, true)
  5290. require.NoError(t, err)
  5291. }
  5292. func TestEventActionCompressQuotaFolder(t *testing.T) {
  5293. testDir := "/folder"
  5294. a1 := dataprovider.BaseEventAction{
  5295. Name: "action1",
  5296. Type: dataprovider.ActionTypeFilesystem,
  5297. Options: dataprovider.BaseEventActionOptions{
  5298. FsConfig: dataprovider.EventActionFilesystemConfig{
  5299. Type: dataprovider.FilesystemActionCompress,
  5300. Compress: dataprovider.EventActionFsCompress{
  5301. Name: "/{{VirtualPath}}.zip",
  5302. Paths: []string{"/{{VirtualPath}}", testDir},
  5303. },
  5304. },
  5305. },
  5306. }
  5307. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  5308. assert.NoError(t, err)
  5309. r1 := dataprovider.EventRule{
  5310. Name: "test compress",
  5311. Status: 1,
  5312. Trigger: dataprovider.EventTriggerFsEvent,
  5313. Conditions: dataprovider.EventConditions{
  5314. FsEvents: []string{"upload"},
  5315. },
  5316. Actions: []dataprovider.EventAction{
  5317. {
  5318. BaseEventAction: dataprovider.BaseEventAction{
  5319. Name: action1.Name,
  5320. },
  5321. Order: 1,
  5322. Options: dataprovider.EventActionOptions{
  5323. ExecuteSync: true,
  5324. },
  5325. },
  5326. },
  5327. }
  5328. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  5329. assert.NoError(t, err)
  5330. u := getTestUser()
  5331. u.QuotaFiles = 1000
  5332. mappedPath := filepath.Join(os.TempDir(), "virtualpath")
  5333. folderName := filepath.Base(mappedPath)
  5334. vdirPath := "/virtualpath"
  5335. f := vfs.BaseVirtualFolder{
  5336. Name: folderName,
  5337. MappedPath: mappedPath,
  5338. }
  5339. _, _, err = httpdtest.AddFolder(f, http.StatusCreated)
  5340. assert.NoError(t, err)
  5341. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  5342. BaseVirtualFolder: vfs.BaseVirtualFolder{
  5343. Name: folderName,
  5344. },
  5345. VirtualPath: vdirPath,
  5346. QuotaSize: -1,
  5347. QuotaFiles: -1,
  5348. })
  5349. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  5350. assert.NoError(t, err)
  5351. conn, client, err := getSftpClient(user)
  5352. if assert.NoError(t, err) {
  5353. defer conn.Close()
  5354. defer client.Close()
  5355. err = client.Mkdir(testDir)
  5356. assert.NoError(t, err)
  5357. expectedQuotaSize := int64(len(testFileContent))
  5358. expectedQuotaFiles := 1
  5359. err = client.Symlink(path.Join(testDir, testFileName), path.Join(testDir, testFileName+"_link"))
  5360. assert.NoError(t, err)
  5361. f, err := client.Create(path.Join(testDir, testFileName))
  5362. assert.NoError(t, err)
  5363. _, err = f.Write(testFileContent)
  5364. assert.NoError(t, err)
  5365. err = f.Close()
  5366. assert.NoError(t, err)
  5367. info, err := client.Stat(path.Join(testDir, testFileName) + ".zip")
  5368. if assert.NoError(t, err) {
  5369. assert.Greater(t, info.Size(), int64(0))
  5370. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  5371. assert.NoError(t, err)
  5372. expectedQuotaFiles++
  5373. expectedQuotaSize += info.Size()
  5374. assert.Equal(t, expectedQuotaFiles, user.UsedQuotaFiles)
  5375. assert.Equal(t, expectedQuotaSize, user.UsedQuotaSize)
  5376. }
  5377. vfolder, _, err := httpdtest.GetFolderByName(folderName, http.StatusOK)
  5378. assert.NoError(t, err)
  5379. assert.Equal(t, 0, vfolder.UsedQuotaFiles)
  5380. assert.Equal(t, int64(0), vfolder.UsedQuotaSize)
  5381. // upload in the virtual path
  5382. f, err = client.Create(path.Join(vdirPath, testFileName))
  5383. assert.NoError(t, err)
  5384. _, err = f.Write(testFileContent)
  5385. assert.NoError(t, err)
  5386. err = f.Close()
  5387. assert.NoError(t, err)
  5388. info, err = client.Stat(path.Join(vdirPath, testFileName) + ".zip")
  5389. if assert.NoError(t, err) {
  5390. assert.Greater(t, info.Size(), int64(0))
  5391. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  5392. assert.NoError(t, err)
  5393. expectedQuotaFiles += 2
  5394. expectedQuotaSize += info.Size() + int64(len(testFileContent))
  5395. assert.Equal(t, expectedQuotaFiles, user.UsedQuotaFiles)
  5396. assert.Equal(t, expectedQuotaSize, user.UsedQuotaSize)
  5397. vfolder, _, err := httpdtest.GetFolderByName(folderName, http.StatusOK)
  5398. assert.NoError(t, err)
  5399. assert.Equal(t, 2, vfolder.UsedQuotaFiles)
  5400. assert.Equal(t, info.Size()+int64(len(testFileContent)), vfolder.UsedQuotaSize)
  5401. }
  5402. }
  5403. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  5404. assert.NoError(t, err)
  5405. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  5406. assert.NoError(t, err)
  5407. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  5408. assert.NoError(t, err)
  5409. err = os.RemoveAll(user.GetHomeDir())
  5410. assert.NoError(t, err)
  5411. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName}, http.StatusOK)
  5412. assert.NoError(t, err)
  5413. err = os.RemoveAll(mappedPath)
  5414. assert.NoError(t, err)
  5415. }
  5416. func TestEventActionCompressErrors(t *testing.T) {
  5417. a1 := dataprovider.BaseEventAction{
  5418. Name: "action1",
  5419. Type: dataprovider.ActionTypeFilesystem,
  5420. Options: dataprovider.BaseEventActionOptions{
  5421. FsConfig: dataprovider.EventActionFilesystemConfig{
  5422. Type: dataprovider.FilesystemActionCompress,
  5423. Compress: dataprovider.EventActionFsCompress{
  5424. Name: "/{{VirtualPath}}.zip",
  5425. Paths: []string{"/{{VirtualPath}}.zip"}, // cannot compress itself
  5426. },
  5427. },
  5428. },
  5429. }
  5430. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  5431. assert.NoError(t, err)
  5432. r1 := dataprovider.EventRule{
  5433. Name: "test compress",
  5434. Status: 1,
  5435. Trigger: dataprovider.EventTriggerFsEvent,
  5436. Conditions: dataprovider.EventConditions{
  5437. FsEvents: []string{"upload"},
  5438. },
  5439. Actions: []dataprovider.EventAction{
  5440. {
  5441. BaseEventAction: dataprovider.BaseEventAction{
  5442. Name: action1.Name,
  5443. },
  5444. Order: 1,
  5445. Options: dataprovider.EventActionOptions{
  5446. ExecuteSync: true,
  5447. },
  5448. },
  5449. },
  5450. }
  5451. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  5452. assert.NoError(t, err)
  5453. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  5454. assert.NoError(t, err)
  5455. conn, client, err := getSftpClient(user)
  5456. if assert.NoError(t, err) {
  5457. defer conn.Close()
  5458. defer client.Close()
  5459. f, err := client.Create(testFileName)
  5460. assert.NoError(t, err)
  5461. _, err = f.Write(testFileContent)
  5462. assert.NoError(t, err)
  5463. err = f.Close()
  5464. assert.Error(t, err)
  5465. }
  5466. // try to compress a missing file
  5467. action1.Options.FsConfig.Compress.Paths = []string{"/missing file"}
  5468. _, _, err = httpdtest.UpdateEventAction(action1, http.StatusOK)
  5469. assert.NoError(t, err)
  5470. conn, client, err = getSftpClient(user)
  5471. if assert.NoError(t, err) {
  5472. defer conn.Close()
  5473. defer client.Close()
  5474. f, err := client.Create(testFileName)
  5475. assert.NoError(t, err)
  5476. _, err = f.Write(testFileContent)
  5477. assert.NoError(t, err)
  5478. err = f.Close()
  5479. assert.Error(t, err)
  5480. }
  5481. // try to overwrite a directory
  5482. testDir := "/adir"
  5483. action1.Options.FsConfig.Compress.Name = testDir
  5484. action1.Options.FsConfig.Compress.Paths = []string{"/{{VirtualPath}}"}
  5485. _, _, err = httpdtest.UpdateEventAction(action1, http.StatusOK)
  5486. assert.NoError(t, err)
  5487. conn, client, err = getSftpClient(user)
  5488. if assert.NoError(t, err) {
  5489. defer conn.Close()
  5490. defer client.Close()
  5491. err = client.Mkdir(testDir)
  5492. assert.NoError(t, err)
  5493. f, err := client.Create(testFileName)
  5494. assert.NoError(t, err)
  5495. _, err = f.Write(testFileContent)
  5496. assert.NoError(t, err)
  5497. err = f.Close()
  5498. assert.Error(t, err)
  5499. }
  5500. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  5501. assert.NoError(t, err)
  5502. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  5503. assert.NoError(t, err)
  5504. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  5505. assert.NoError(t, err)
  5506. err = os.RemoveAll(user.GetHomeDir())
  5507. assert.NoError(t, err)
  5508. }
  5509. func TestEventActionEmailAttachments(t *testing.T) {
  5510. smtpCfg := smtp.Config{
  5511. Host: "127.0.0.1",
  5512. Port: 2525,
  5513. From: "[email protected]",
  5514. TemplatesPath: "templates",
  5515. }
  5516. err := smtpCfg.Initialize(configDir, true)
  5517. require.NoError(t, err)
  5518. a1 := dataprovider.BaseEventAction{
  5519. Name: "action1",
  5520. Type: dataprovider.ActionTypeFilesystem,
  5521. Options: dataprovider.BaseEventActionOptions{
  5522. FsConfig: dataprovider.EventActionFilesystemConfig{
  5523. Type: dataprovider.FilesystemActionCompress,
  5524. Compress: dataprovider.EventActionFsCompress{
  5525. Name: "/archive/{{VirtualPath}}.zip",
  5526. Paths: []string{"/{{VirtualPath}}"},
  5527. },
  5528. },
  5529. },
  5530. }
  5531. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  5532. assert.NoError(t, err)
  5533. a2 := dataprovider.BaseEventAction{
  5534. Name: "action2",
  5535. Type: dataprovider.ActionTypeEmail,
  5536. Options: dataprovider.BaseEventActionOptions{
  5537. EmailConfig: dataprovider.EventActionEmailConfig{
  5538. Recipients: []string{"[email protected]"},
  5539. Subject: `"{{Event}}" from "{{Name}}"`,
  5540. Body: "Fs path {{FsPath}}, size: {{FileSize}}, protocol: {{Protocol}}, IP: {{IP}}",
  5541. Attachments: []string{"/archive/{{VirtualPath}}.zip"},
  5542. },
  5543. },
  5544. }
  5545. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  5546. assert.NoError(t, err)
  5547. r1 := dataprovider.EventRule{
  5548. Name: "test email with attachment",
  5549. Status: 1,
  5550. Trigger: dataprovider.EventTriggerFsEvent,
  5551. Conditions: dataprovider.EventConditions{
  5552. FsEvents: []string{"upload"},
  5553. },
  5554. Actions: []dataprovider.EventAction{
  5555. {
  5556. BaseEventAction: dataprovider.BaseEventAction{
  5557. Name: action1.Name,
  5558. },
  5559. Order: 1,
  5560. },
  5561. {
  5562. BaseEventAction: dataprovider.BaseEventAction{
  5563. Name: action2.Name,
  5564. },
  5565. Order: 2,
  5566. },
  5567. },
  5568. }
  5569. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  5570. assert.NoError(t, err)
  5571. localUser, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  5572. assert.NoError(t, err)
  5573. u := getTestSFTPUser()
  5574. u.FsConfig.SFTPConfig.BufferSize = 1
  5575. sftpUser, _, err := httpdtest.AddUser(u, http.StatusCreated)
  5576. assert.NoError(t, err)
  5577. cryptFsUser, _, err := httpdtest.AddUser(getCryptFsUser(), http.StatusCreated)
  5578. assert.NoError(t, err)
  5579. for _, user := range []dataprovider.User{localUser, sftpUser, cryptFsUser} {
  5580. conn, client, err := getSftpClient(user)
  5581. if assert.NoError(t, err) {
  5582. defer conn.Close()
  5583. defer client.Close()
  5584. lastReceivedEmail.reset()
  5585. f, err := client.Create(testFileName)
  5586. assert.NoError(t, err)
  5587. _, err = f.Write(testFileContent)
  5588. assert.NoError(t, err)
  5589. err = f.Close()
  5590. assert.NoError(t, err)
  5591. assert.Eventually(t, func() bool {
  5592. return lastReceivedEmail.get().From != ""
  5593. }, 1500*time.Millisecond, 100*time.Millisecond)
  5594. email := lastReceivedEmail.get()
  5595. assert.Len(t, email.To, 1)
  5596. assert.True(t, util.Contains(email.To, "[email protected]"))
  5597. assert.Contains(t, email.Data, `Subject: "upload" from`)
  5598. assert.Contains(t, email.Data, "Content-Disposition: attachment")
  5599. }
  5600. }
  5601. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  5602. assert.NoError(t, err)
  5603. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  5604. assert.NoError(t, err)
  5605. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  5606. assert.NoError(t, err)
  5607. _, err = httpdtest.RemoveUser(sftpUser, http.StatusOK)
  5608. assert.NoError(t, err)
  5609. _, err = httpdtest.RemoveUser(localUser, http.StatusOK)
  5610. assert.NoError(t, err)
  5611. err = os.RemoveAll(localUser.GetHomeDir())
  5612. assert.NoError(t, err)
  5613. _, err = httpdtest.RemoveUser(cryptFsUser, http.StatusOK)
  5614. assert.NoError(t, err)
  5615. err = os.RemoveAll(cryptFsUser.GetHomeDir())
  5616. assert.NoError(t, err)
  5617. smtpCfg = smtp.Config{}
  5618. err = smtpCfg.Initialize(configDir, true)
  5619. require.NoError(t, err)
  5620. }
  5621. func TestEventActionsRetentionReports(t *testing.T) {
  5622. smtpCfg := smtp.Config{
  5623. Host: "127.0.0.1",
  5624. Port: 2525,
  5625. From: "[email protected]",
  5626. TemplatesPath: "templates",
  5627. }
  5628. err := smtpCfg.Initialize(configDir, true)
  5629. require.NoError(t, err)
  5630. testDir := "/d"
  5631. a1 := dataprovider.BaseEventAction{
  5632. Name: "action1",
  5633. Type: dataprovider.ActionTypeDataRetentionCheck,
  5634. Options: dataprovider.BaseEventActionOptions{
  5635. RetentionConfig: dataprovider.EventActionDataRetentionConfig{
  5636. Folders: []dataprovider.FolderRetention{
  5637. {
  5638. Path: testDir,
  5639. Retention: 1,
  5640. DeleteEmptyDirs: true,
  5641. IgnoreUserPermissions: true,
  5642. },
  5643. },
  5644. },
  5645. },
  5646. }
  5647. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  5648. assert.NoError(t, err)
  5649. a2 := dataprovider.BaseEventAction{
  5650. Name: "action2",
  5651. Type: dataprovider.ActionTypeEmail,
  5652. Options: dataprovider.BaseEventActionOptions{
  5653. EmailConfig: dataprovider.EventActionEmailConfig{
  5654. Recipients: []string{"[email protected]"},
  5655. Subject: `"{{Event}}" from "{{Name}}"`,
  5656. Body: "Fs path {{FsPath}}, size: {{FileSize}}, protocol: {{Protocol}}, IP: {{IP}}",
  5657. Attachments: []string{dataprovider.RetentionReportPlaceHolder},
  5658. },
  5659. },
  5660. }
  5661. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  5662. assert.NoError(t, err)
  5663. a3 := dataprovider.BaseEventAction{
  5664. Name: "action3",
  5665. Type: dataprovider.ActionTypeHTTP,
  5666. Options: dataprovider.BaseEventActionOptions{
  5667. HTTPConfig: dataprovider.EventActionHTTPConfig{
  5668. Endpoint: fmt.Sprintf("http://%s/", httpAddr),
  5669. Timeout: 20,
  5670. Method: http.MethodPost,
  5671. Body: dataprovider.RetentionReportPlaceHolder,
  5672. },
  5673. },
  5674. }
  5675. action3, _, err := httpdtest.AddEventAction(a3, http.StatusCreated)
  5676. assert.NoError(t, err)
  5677. a4 := dataprovider.BaseEventAction{
  5678. Name: "action4",
  5679. Type: dataprovider.ActionTypeHTTP,
  5680. Options: dataprovider.BaseEventActionOptions{
  5681. HTTPConfig: dataprovider.EventActionHTTPConfig{
  5682. Endpoint: fmt.Sprintf("http://%s/multipart", httpAddr),
  5683. Timeout: 20,
  5684. Method: http.MethodPost,
  5685. Parts: []dataprovider.HTTPPart{
  5686. {
  5687. Name: "reports.zip",
  5688. Filepath: dataprovider.RetentionReportPlaceHolder,
  5689. },
  5690. },
  5691. },
  5692. },
  5693. }
  5694. action4, _, err := httpdtest.AddEventAction(a4, http.StatusCreated)
  5695. assert.NoError(t, err)
  5696. r1 := dataprovider.EventRule{
  5697. Name: "test rule1",
  5698. Status: 1,
  5699. Trigger: dataprovider.EventTriggerFsEvent,
  5700. Conditions: dataprovider.EventConditions{
  5701. FsEvents: []string{"upload"},
  5702. },
  5703. Actions: []dataprovider.EventAction{
  5704. {
  5705. BaseEventAction: dataprovider.BaseEventAction{
  5706. Name: action1.Name,
  5707. },
  5708. Order: 1,
  5709. Options: dataprovider.EventActionOptions{
  5710. ExecuteSync: true,
  5711. StopOnFailure: true,
  5712. },
  5713. },
  5714. {
  5715. BaseEventAction: dataprovider.BaseEventAction{
  5716. Name: action2.Name,
  5717. },
  5718. Order: 2,
  5719. Options: dataprovider.EventActionOptions{
  5720. ExecuteSync: true,
  5721. StopOnFailure: true,
  5722. },
  5723. },
  5724. {
  5725. BaseEventAction: dataprovider.BaseEventAction{
  5726. Name: action3.Name,
  5727. },
  5728. Order: 3,
  5729. Options: dataprovider.EventActionOptions{
  5730. ExecuteSync: true,
  5731. StopOnFailure: true,
  5732. },
  5733. },
  5734. {
  5735. BaseEventAction: dataprovider.BaseEventAction{
  5736. Name: action4.Name,
  5737. },
  5738. Order: 4,
  5739. Options: dataprovider.EventActionOptions{
  5740. ExecuteSync: true,
  5741. StopOnFailure: true,
  5742. },
  5743. },
  5744. },
  5745. }
  5746. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  5747. assert.NoError(t, err)
  5748. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  5749. assert.NoError(t, err)
  5750. conn, client, err := getSftpClient(user)
  5751. if assert.NoError(t, err) {
  5752. defer conn.Close()
  5753. defer client.Close()
  5754. subdir := path.Join(testDir, "sub")
  5755. err = client.MkdirAll(subdir)
  5756. assert.NoError(t, err)
  5757. lastReceivedEmail.reset()
  5758. f, err := client.Create(testFileName)
  5759. assert.NoError(t, err)
  5760. _, err = f.Write(testFileContent)
  5761. assert.NoError(t, err)
  5762. err = f.Close()
  5763. assert.NoError(t, err)
  5764. email := lastReceivedEmail.get()
  5765. assert.Len(t, email.To, 1)
  5766. assert.True(t, util.Contains(email.To, "[email protected]"))
  5767. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "upload" from "%s"`, user.Username))
  5768. assert.Contains(t, email.Data, "Content-Disposition: attachment")
  5769. _, err = client.Stat(testDir)
  5770. assert.NoError(t, err)
  5771. _, err = client.Stat(subdir)
  5772. assert.ErrorIs(t, err, os.ErrNotExist)
  5773. err = client.Mkdir(subdir)
  5774. assert.NoError(t, err)
  5775. newName := path.Join(testDir, testFileName)
  5776. err = client.Rename(testFileName, newName)
  5777. assert.NoError(t, err)
  5778. err = client.Chtimes(newName, time.Now().Add(-24*time.Hour), time.Now().Add(-24*time.Hour))
  5779. assert.NoError(t, err)
  5780. lastReceivedEmail.reset()
  5781. f, err = client.Create(testFileName)
  5782. assert.NoError(t, err)
  5783. _, err = f.Write(testFileContent)
  5784. assert.NoError(t, err)
  5785. err = f.Close()
  5786. assert.NoError(t, err)
  5787. email = lastReceivedEmail.get()
  5788. assert.Len(t, email.To, 1)
  5789. _, err = client.Stat(subdir)
  5790. assert.ErrorIs(t, err, os.ErrNotExist)
  5791. _, err = client.Stat(subdir)
  5792. assert.ErrorIs(t, err, os.ErrNotExist)
  5793. }
  5794. // now remove the retention check to test errors
  5795. rule1.Actions = []dataprovider.EventAction{
  5796. {
  5797. BaseEventAction: dataprovider.BaseEventAction{
  5798. Name: action2.Name,
  5799. },
  5800. Order: 2,
  5801. Options: dataprovider.EventActionOptions{
  5802. ExecuteSync: true,
  5803. StopOnFailure: false,
  5804. },
  5805. },
  5806. {
  5807. BaseEventAction: dataprovider.BaseEventAction{
  5808. Name: action3.Name,
  5809. },
  5810. Order: 3,
  5811. Options: dataprovider.EventActionOptions{
  5812. ExecuteSync: true,
  5813. StopOnFailure: false,
  5814. },
  5815. },
  5816. {
  5817. BaseEventAction: dataprovider.BaseEventAction{
  5818. Name: action4.Name,
  5819. },
  5820. Order: 4,
  5821. Options: dataprovider.EventActionOptions{
  5822. ExecuteSync: true,
  5823. StopOnFailure: false,
  5824. },
  5825. },
  5826. }
  5827. _, _, err = httpdtest.UpdateEventRule(rule1, http.StatusOK)
  5828. assert.NoError(t, err)
  5829. conn, client, err = getSftpClient(user)
  5830. if assert.NoError(t, err) {
  5831. defer conn.Close()
  5832. defer client.Close()
  5833. f, err := client.Create(testFileName)
  5834. assert.NoError(t, err)
  5835. _, err = f.Write(testFileContent)
  5836. assert.NoError(t, err)
  5837. err = f.Close()
  5838. assert.Error(t, err)
  5839. }
  5840. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  5841. assert.NoError(t, err)
  5842. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  5843. assert.NoError(t, err)
  5844. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  5845. assert.NoError(t, err)
  5846. _, err = httpdtest.RemoveEventAction(action3, http.StatusOK)
  5847. assert.NoError(t, err)
  5848. _, err = httpdtest.RemoveEventAction(action4, http.StatusOK)
  5849. assert.NoError(t, err)
  5850. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  5851. assert.NoError(t, err)
  5852. err = os.RemoveAll(user.GetHomeDir())
  5853. assert.NoError(t, err)
  5854. smtpCfg = smtp.Config{}
  5855. err = smtpCfg.Initialize(configDir, true)
  5856. require.NoError(t, err)
  5857. }
  5858. func TestEventRuleFirstUploadDownloadActions(t *testing.T) {
  5859. smtpCfg := smtp.Config{
  5860. Host: "127.0.0.1",
  5861. Port: 2525,
  5862. From: "[email protected]",
  5863. TemplatesPath: "templates",
  5864. }
  5865. err := smtpCfg.Initialize(configDir, true)
  5866. require.NoError(t, err)
  5867. a1 := dataprovider.BaseEventAction{
  5868. Name: "action1",
  5869. Type: dataprovider.ActionTypeEmail,
  5870. Options: dataprovider.BaseEventActionOptions{
  5871. EmailConfig: dataprovider.EventActionEmailConfig{
  5872. Recipients: []string{"[email protected]"},
  5873. Subject: `"{{Event}}" from "{{Name}}"`,
  5874. Body: "Fs path {{FsPath}}, size: {{FileSize}}, protocol: {{Protocol}}, IP: {{IP}}",
  5875. },
  5876. },
  5877. }
  5878. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  5879. assert.NoError(t, err)
  5880. r1 := dataprovider.EventRule{
  5881. Name: "test first upload rule",
  5882. Status: 1,
  5883. Trigger: dataprovider.EventTriggerFsEvent,
  5884. Conditions: dataprovider.EventConditions{
  5885. FsEvents: []string{"first-upload"},
  5886. },
  5887. Actions: []dataprovider.EventAction{
  5888. {
  5889. BaseEventAction: dataprovider.BaseEventAction{
  5890. Name: action1.Name,
  5891. },
  5892. Order: 1,
  5893. },
  5894. },
  5895. }
  5896. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  5897. assert.NoError(t, err)
  5898. r2 := dataprovider.EventRule{
  5899. Name: "test first download rule",
  5900. Status: 1,
  5901. Trigger: dataprovider.EventTriggerFsEvent,
  5902. Conditions: dataprovider.EventConditions{
  5903. FsEvents: []string{"first-download"},
  5904. },
  5905. Actions: []dataprovider.EventAction{
  5906. {
  5907. BaseEventAction: dataprovider.BaseEventAction{
  5908. Name: action1.Name,
  5909. },
  5910. Order: 1,
  5911. },
  5912. },
  5913. }
  5914. rule2, _, err := httpdtest.AddEventRule(r2, http.StatusCreated)
  5915. assert.NoError(t, err)
  5916. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  5917. assert.NoError(t, err)
  5918. conn, client, err := getSftpClient(user)
  5919. if assert.NoError(t, err) {
  5920. defer conn.Close()
  5921. defer client.Close()
  5922. testFileSize := int64(32768)
  5923. lastReceivedEmail.reset()
  5924. err = writeSFTPFileNoCheck(testFileName, testFileSize, client)
  5925. assert.NoError(t, err)
  5926. assert.Eventually(t, func() bool {
  5927. return lastReceivedEmail.get().From != ""
  5928. }, 1500*time.Millisecond, 100*time.Millisecond)
  5929. email := lastReceivedEmail.get()
  5930. assert.Len(t, email.To, 1)
  5931. assert.True(t, util.Contains(email.To, "[email protected]"))
  5932. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "first-upload" from "%s"`, user.Username))
  5933. lastReceivedEmail.reset()
  5934. // a new upload will not produce a new notification
  5935. err = writeSFTPFileNoCheck(testFileName+"_1", 32768, client)
  5936. assert.NoError(t, err)
  5937. assert.Never(t, func() bool {
  5938. return lastReceivedEmail.get().From != ""
  5939. }, 1000*time.Millisecond, 100*time.Millisecond)
  5940. // the same for download
  5941. f, err := client.Open(testFileName)
  5942. assert.NoError(t, err)
  5943. contents := make([]byte, testFileSize)
  5944. n, err := io.ReadFull(f, contents)
  5945. assert.NoError(t, err)
  5946. assert.Equal(t, int(testFileSize), n)
  5947. err = f.Close()
  5948. assert.NoError(t, err)
  5949. assert.Eventually(t, func() bool {
  5950. return lastReceivedEmail.get().From != ""
  5951. }, 1500*time.Millisecond, 100*time.Millisecond)
  5952. email = lastReceivedEmail.get()
  5953. assert.Len(t, email.To, 1)
  5954. assert.True(t, util.Contains(email.To, "[email protected]"))
  5955. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "first-download" from "%s"`, user.Username))
  5956. // download again
  5957. lastReceivedEmail.reset()
  5958. f, err = client.Open(testFileName)
  5959. assert.NoError(t, err)
  5960. contents = make([]byte, testFileSize)
  5961. n, err = io.ReadFull(f, contents)
  5962. assert.NoError(t, err)
  5963. assert.Equal(t, int(testFileSize), n)
  5964. err = f.Close()
  5965. assert.NoError(t, err)
  5966. assert.Never(t, func() bool {
  5967. return lastReceivedEmail.get().From != ""
  5968. }, 1000*time.Millisecond, 100*time.Millisecond)
  5969. }
  5970. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  5971. assert.NoError(t, err)
  5972. _, err = httpdtest.RemoveEventRule(rule2, http.StatusOK)
  5973. assert.NoError(t, err)
  5974. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  5975. assert.NoError(t, err)
  5976. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  5977. assert.NoError(t, err)
  5978. err = os.RemoveAll(user.GetHomeDir())
  5979. assert.NoError(t, err)
  5980. smtpCfg = smtp.Config{}
  5981. err = smtpCfg.Initialize(configDir, true)
  5982. require.NoError(t, err)
  5983. }
  5984. func TestEventRuleRenameEvent(t *testing.T) {
  5985. smtpCfg := smtp.Config{
  5986. Host: "127.0.0.1",
  5987. Port: 2525,
  5988. From: "[email protected]",
  5989. TemplatesPath: "templates",
  5990. }
  5991. err := smtpCfg.Initialize(configDir, true)
  5992. require.NoError(t, err)
  5993. a1 := dataprovider.BaseEventAction{
  5994. Name: "action1",
  5995. Type: dataprovider.ActionTypeEmail,
  5996. Options: dataprovider.BaseEventActionOptions{
  5997. EmailConfig: dataprovider.EventActionEmailConfig{
  5998. Recipients: []string{"[email protected]"},
  5999. Subject: `"{{Event}}" from "{{Name}}"`,
  6000. ContentType: 1,
  6001. Body: `<p>Fs path {{FsPath}}, Target path "{{VirtualTargetDirPath}}/{{TargetName}}", size: {{FileSize}}</p>`,
  6002. },
  6003. },
  6004. }
  6005. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  6006. assert.NoError(t, err)
  6007. r1 := dataprovider.EventRule{
  6008. Name: "test rename rule",
  6009. Status: 1,
  6010. Trigger: dataprovider.EventTriggerFsEvent,
  6011. Conditions: dataprovider.EventConditions{
  6012. FsEvents: []string{"rename"},
  6013. },
  6014. Actions: []dataprovider.EventAction{
  6015. {
  6016. BaseEventAction: dataprovider.BaseEventAction{
  6017. Name: action1.Name,
  6018. },
  6019. Order: 1,
  6020. },
  6021. },
  6022. }
  6023. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  6024. assert.NoError(t, err)
  6025. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  6026. assert.NoError(t, err)
  6027. conn, client, err := getSftpClient(user)
  6028. if assert.NoError(t, err) {
  6029. defer conn.Close()
  6030. defer client.Close()
  6031. testFileSize := int64(32768)
  6032. lastReceivedEmail.reset()
  6033. err = writeSFTPFileNoCheck(testFileName, testFileSize, client)
  6034. assert.NoError(t, err)
  6035. err = client.Mkdir("subdir")
  6036. assert.NoError(t, err)
  6037. err = client.Rename(testFileName, path.Join("/subdir", testFileName))
  6038. assert.NoError(t, err)
  6039. assert.Eventually(t, func() bool {
  6040. return lastReceivedEmail.get().From != ""
  6041. }, 1500*time.Millisecond, 100*time.Millisecond)
  6042. email := lastReceivedEmail.get()
  6043. assert.Len(t, email.To, 1)
  6044. assert.True(t, util.Contains(email.To, "[email protected]"))
  6045. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "rename" from "%s"`, user.Username))
  6046. assert.Contains(t, email.Data, "Content-Type: text/html")
  6047. assert.Contains(t, email.Data, fmt.Sprintf("Target path %q", path.Join("/subdir", testFileName)))
  6048. }
  6049. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  6050. assert.NoError(t, err)
  6051. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  6052. assert.NoError(t, err)
  6053. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  6054. assert.NoError(t, err)
  6055. err = os.RemoveAll(user.GetHomeDir())
  6056. assert.NoError(t, err)
  6057. smtpCfg = smtp.Config{}
  6058. err = smtpCfg.Initialize(configDir, true)
  6059. require.NoError(t, err)
  6060. }
  6061. func TestEventRuleIDPLogin(t *testing.T) {
  6062. smtpCfg := smtp.Config{
  6063. Host: "127.0.0.1",
  6064. Port: 2525,
  6065. From: "[email protected]",
  6066. TemplatesPath: "templates",
  6067. }
  6068. err := smtpCfg.Initialize(configDir, true)
  6069. require.NoError(t, err)
  6070. lastReceivedEmail.reset()
  6071. username := `test_"idp_"login`
  6072. custom1 := `cust"oa"1`
  6073. u := map[string]any{
  6074. "username": "{{Name}}",
  6075. "status": 1,
  6076. "home_dir": filepath.Join(os.TempDir(), "{{IDPFieldcustom1}}"),
  6077. "permissions": map[string][]string{
  6078. "/": {dataprovider.PermAny},
  6079. },
  6080. }
  6081. userTmpl, err := json.Marshal(u)
  6082. require.NoError(t, err)
  6083. a := map[string]any{
  6084. "username": "{{Name}}",
  6085. "status": 1,
  6086. "permissions": []string{dataprovider.PermAdminAny},
  6087. }
  6088. adminTmpl, err := json.Marshal(a)
  6089. require.NoError(t, err)
  6090. a1 := dataprovider.BaseEventAction{
  6091. Name: "a1",
  6092. Type: dataprovider.ActionTypeIDPAccountCheck,
  6093. Options: dataprovider.BaseEventActionOptions{
  6094. IDPConfig: dataprovider.EventActionIDPAccountCheck{
  6095. Mode: 1, // create if not exists
  6096. TemplateUser: string(userTmpl),
  6097. TemplateAdmin: string(adminTmpl),
  6098. },
  6099. },
  6100. }
  6101. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  6102. assert.NoError(t, err)
  6103. a2 := dataprovider.BaseEventAction{
  6104. Name: "a2",
  6105. Type: dataprovider.ActionTypeEmail,
  6106. Options: dataprovider.BaseEventActionOptions{
  6107. EmailConfig: dataprovider.EventActionEmailConfig{
  6108. Recipients: []string{"[email protected]"},
  6109. Subject: `"{{Event}} {{StatusString}}"`,
  6110. Body: "{{Name}} Custom field: {{IDPFieldcustom1}}",
  6111. },
  6112. },
  6113. }
  6114. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  6115. assert.NoError(t, err)
  6116. r1 := dataprovider.EventRule{
  6117. Name: "test rule IDP login",
  6118. Status: 1,
  6119. Trigger: dataprovider.EventTriggerIDPLogin,
  6120. Conditions: dataprovider.EventConditions{
  6121. IDPLoginEvent: dataprovider.IDPLoginUser,
  6122. },
  6123. Actions: []dataprovider.EventAction{
  6124. {
  6125. BaseEventAction: dataprovider.BaseEventAction{
  6126. Name: action1.Name, // the rule is not sync and will be skipped
  6127. },
  6128. Order: 1,
  6129. },
  6130. {
  6131. BaseEventAction: dataprovider.BaseEventAction{
  6132. Name: action2.Name,
  6133. },
  6134. Order: 2,
  6135. },
  6136. },
  6137. }
  6138. rule1, resp, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  6139. assert.NoError(t, err, string(resp))
  6140. customFields := map[string]any{
  6141. "custom1": custom1,
  6142. }
  6143. user, admin, err := common.HandleIDPLoginEvent(common.EventParams{
  6144. Name: username,
  6145. Event: common.IDPLoginUser,
  6146. Status: 1,
  6147. }, &customFields)
  6148. assert.Nil(t, user)
  6149. assert.Nil(t, admin)
  6150. assert.NoError(t, err)
  6151. rule1.Actions[0].Options.ExecuteSync = true
  6152. rule1, resp, err = httpdtest.UpdateEventRule(rule1, http.StatusOK)
  6153. assert.NoError(t, err, string(resp))
  6154. user, admin, err = common.HandleIDPLoginEvent(common.EventParams{
  6155. Name: username,
  6156. Event: common.IDPLoginUser,
  6157. Status: 1,
  6158. }, &customFields)
  6159. if assert.NotNil(t, user) {
  6160. assert.Equal(t, filepath.Join(os.TempDir(), custom1), user.GetHomeDir())
  6161. _, err = httpdtest.RemoveUser(*user, http.StatusOK)
  6162. assert.NoError(t, err)
  6163. }
  6164. assert.Nil(t, admin)
  6165. assert.NoError(t, err)
  6166. assert.Eventually(t, func() bool {
  6167. return lastReceivedEmail.get().From != ""
  6168. }, 3000*time.Millisecond, 100*time.Millisecond)
  6169. email := lastReceivedEmail.get()
  6170. assert.Len(t, email.To, 1)
  6171. assert.True(t, util.Contains(email.To, "[email protected]"))
  6172. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "%s OK"`, common.IDPLoginUser))
  6173. assert.Contains(t, email.Data, username)
  6174. assert.Contains(t, email.Data, custom1)
  6175. user, admin, err = common.HandleIDPLoginEvent(common.EventParams{
  6176. Name: username,
  6177. Event: common.IDPLoginAdmin,
  6178. Status: 1,
  6179. }, &customFields)
  6180. assert.Nil(t, user)
  6181. assert.Nil(t, admin)
  6182. assert.NoError(t, err)
  6183. rule1.Conditions.IDPLoginEvent = dataprovider.IDPLoginAny
  6184. rule1.Actions = []dataprovider.EventAction{
  6185. {
  6186. BaseEventAction: dataprovider.BaseEventAction{
  6187. Name: action1.Name,
  6188. },
  6189. Options: dataprovider.EventActionOptions{
  6190. ExecuteSync: true,
  6191. },
  6192. Order: 1,
  6193. },
  6194. }
  6195. rule1, _, err = httpdtest.UpdateEventRule(rule1, http.StatusOK)
  6196. assert.NoError(t, err)
  6197. r2 := dataprovider.EventRule{
  6198. Name: "test email on IDP login",
  6199. Status: 1,
  6200. Trigger: dataprovider.EventTriggerIDPLogin,
  6201. Conditions: dataprovider.EventConditions{
  6202. IDPLoginEvent: dataprovider.IDPLoginAdmin,
  6203. },
  6204. Actions: []dataprovider.EventAction{
  6205. {
  6206. BaseEventAction: dataprovider.BaseEventAction{
  6207. Name: action2.Name,
  6208. },
  6209. Order: 1,
  6210. },
  6211. },
  6212. }
  6213. rule2, resp, err := httpdtest.AddEventRule(r2, http.StatusCreated)
  6214. assert.NoError(t, err, string(resp))
  6215. lastReceivedEmail.reset()
  6216. user, admin, err = common.HandleIDPLoginEvent(common.EventParams{
  6217. Name: username,
  6218. Event: common.IDPLoginAdmin,
  6219. Status: 1,
  6220. }, &customFields)
  6221. assert.Nil(t, user)
  6222. if assert.NotNil(t, admin) {
  6223. assert.Equal(t, 1, admin.Status)
  6224. }
  6225. assert.NoError(t, err)
  6226. assert.Eventually(t, func() bool {
  6227. return lastReceivedEmail.get().From != ""
  6228. }, 3000*time.Millisecond, 100*time.Millisecond)
  6229. email = lastReceivedEmail.get()
  6230. assert.Len(t, email.To, 1)
  6231. assert.True(t, util.Contains(email.To, "[email protected]"))
  6232. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "%s OK"`, common.IDPLoginAdmin))
  6233. assert.Contains(t, email.Data, username)
  6234. assert.Contains(t, email.Data, custom1)
  6235. admin.Status = 0
  6236. _, _, err = httpdtest.UpdateAdmin(*admin, http.StatusOK)
  6237. assert.NoError(t, err)
  6238. user, admin, err = common.HandleIDPLoginEvent(common.EventParams{
  6239. Name: username,
  6240. Event: common.IDPLoginAdmin,
  6241. Status: 1,
  6242. }, &customFields)
  6243. assert.Nil(t, user)
  6244. if assert.NotNil(t, admin) {
  6245. assert.Equal(t, 0, admin.Status)
  6246. }
  6247. assert.NoError(t, err)
  6248. action1.Options.IDPConfig.Mode = 0
  6249. action1, _, err = httpdtest.UpdateEventAction(action1, http.StatusOK)
  6250. assert.NoError(t, err)
  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. if assert.NotNil(t, admin) {
  6258. assert.Equal(t, 1, admin.Status)
  6259. }
  6260. assert.NoError(t, err)
  6261. _, err = httpdtest.RemoveAdmin(*admin, http.StatusOK)
  6262. assert.NoError(t, err)
  6263. r3 := dataprovider.EventRule{
  6264. Name: "test rule2 IDP login",
  6265. Status: 1,
  6266. Trigger: dataprovider.EventTriggerIDPLogin,
  6267. Conditions: dataprovider.EventConditions{
  6268. IDPLoginEvent: dataprovider.IDPLoginAny,
  6269. },
  6270. Actions: []dataprovider.EventAction{
  6271. {
  6272. BaseEventAction: dataprovider.BaseEventAction{
  6273. Name: action1.Name,
  6274. },
  6275. Order: 1,
  6276. Options: dataprovider.EventActionOptions{
  6277. ExecuteSync: true,
  6278. },
  6279. },
  6280. },
  6281. }
  6282. rule3, resp, err := httpdtest.AddEventRule(r3, http.StatusCreated)
  6283. assert.NoError(t, err, string(resp))
  6284. user, admin, err = common.HandleIDPLoginEvent(common.EventParams{
  6285. Name: username,
  6286. Event: common.IDPLoginAdmin,
  6287. Status: 1,
  6288. }, &customFields)
  6289. assert.Nil(t, user)
  6290. assert.Nil(t, admin)
  6291. if assert.Error(t, err) {
  6292. assert.Contains(t, err.Error(), "more than one account check action rules matches")
  6293. }
  6294. _, err = httpdtest.RemoveEventRule(rule3, http.StatusOK)
  6295. assert.NoError(t, err)
  6296. action1.Options.IDPConfig.TemplateAdmin = `{}`
  6297. action1, _, err = httpdtest.UpdateEventAction(action1, http.StatusOK)
  6298. assert.NoError(t, err)
  6299. _, _, err = common.HandleIDPLoginEvent(common.EventParams{
  6300. Name: username,
  6301. Event: common.IDPLoginAdmin,
  6302. Status: 1,
  6303. }, &customFields)
  6304. assert.ErrorIs(t, err, util.ErrValidation)
  6305. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  6306. assert.NoError(t, err)
  6307. user, admin, err = common.HandleIDPLoginEvent(common.EventParams{
  6308. Name: username,
  6309. Event: common.IDPLoginAdmin,
  6310. Status: 1,
  6311. }, &customFields)
  6312. assert.Nil(t, user)
  6313. assert.Nil(t, admin)
  6314. assert.NoError(t, err)
  6315. _, err = httpdtest.RemoveEventRule(rule2, http.StatusOK)
  6316. assert.NoError(t, err)
  6317. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  6318. assert.NoError(t, err)
  6319. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  6320. assert.NoError(t, err)
  6321. smtpCfg = smtp.Config{}
  6322. err = smtpCfg.Initialize(configDir, true)
  6323. require.NoError(t, err)
  6324. }
  6325. func TestEventRuleEmailField(t *testing.T) {
  6326. smtpCfg := smtp.Config{
  6327. Host: "127.0.0.1",
  6328. Port: 2525,
  6329. From: "[email protected]",
  6330. TemplatesPath: "templates",
  6331. }
  6332. err := smtpCfg.Initialize(configDir, true)
  6333. require.NoError(t, err)
  6334. lastReceivedEmail.reset()
  6335. a1 := dataprovider.BaseEventAction{
  6336. Name: "action1",
  6337. Type: dataprovider.ActionTypeEmail,
  6338. Options: dataprovider.BaseEventActionOptions{
  6339. EmailConfig: dataprovider.EventActionEmailConfig{
  6340. Recipients: []string{"{{Email}}"},
  6341. Subject: `"{{Event}}" from "{{Name}}"`,
  6342. Body: "Sample email body",
  6343. },
  6344. },
  6345. }
  6346. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  6347. assert.NoError(t, err)
  6348. a2 := dataprovider.BaseEventAction{
  6349. Name: "action2",
  6350. Type: dataprovider.ActionTypeEmail,
  6351. Options: dataprovider.BaseEventActionOptions{
  6352. EmailConfig: dataprovider.EventActionEmailConfig{
  6353. Recipients: []string{"[email protected]"},
  6354. Subject: `"Failure`,
  6355. Body: "{{ErrorString}}",
  6356. },
  6357. },
  6358. }
  6359. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  6360. assert.NoError(t, err)
  6361. r1 := dataprovider.EventRule{
  6362. Name: "r1",
  6363. Status: 1,
  6364. Trigger: dataprovider.EventTriggerFsEvent,
  6365. Conditions: dataprovider.EventConditions{
  6366. FsEvents: []string{"mkdir"},
  6367. },
  6368. Actions: []dataprovider.EventAction{
  6369. {
  6370. BaseEventAction: dataprovider.BaseEventAction{
  6371. Name: action1.Name,
  6372. },
  6373. },
  6374. },
  6375. }
  6376. r2 := dataprovider.EventRule{
  6377. Name: "test rule2",
  6378. Status: 1,
  6379. Trigger: dataprovider.EventTriggerProviderEvent,
  6380. Conditions: dataprovider.EventConditions{
  6381. ProviderEvents: []string{"add"},
  6382. },
  6383. Actions: []dataprovider.EventAction{
  6384. {
  6385. BaseEventAction: dataprovider.BaseEventAction{
  6386. Name: action1.Name,
  6387. },
  6388. Order: 1,
  6389. },
  6390. {
  6391. BaseEventAction: dataprovider.BaseEventAction{
  6392. Name: action2.Name,
  6393. },
  6394. Options: dataprovider.EventActionOptions{
  6395. IsFailureAction: true,
  6396. },
  6397. },
  6398. },
  6399. }
  6400. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  6401. assert.NoError(t, err)
  6402. rule2, _, err := httpdtest.AddEventRule(r2, http.StatusCreated)
  6403. assert.NoError(t, err)
  6404. u := getTestUser()
  6405. u.Email = "[email protected]"
  6406. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  6407. assert.NoError(t, err)
  6408. assert.Eventually(t, func() bool {
  6409. return lastReceivedEmail.get().From != ""
  6410. }, 3000*time.Millisecond, 100*time.Millisecond)
  6411. email := lastReceivedEmail.get()
  6412. assert.Len(t, email.To, 1)
  6413. assert.True(t, util.Contains(email.To, user.Email))
  6414. assert.Contains(t, email.Data, `Subject: "add" from "admin"`)
  6415. // if we add a user without email the notification will fail
  6416. lastReceivedEmail.reset()
  6417. u1 := getTestUser()
  6418. u1.Username += "_1"
  6419. user1, _, err := httpdtest.AddUser(u1, http.StatusCreated)
  6420. assert.NoError(t, err)
  6421. assert.Eventually(t, func() bool {
  6422. return lastReceivedEmail.get().From != ""
  6423. }, 3000*time.Millisecond, 100*time.Millisecond)
  6424. email = lastReceivedEmail.get()
  6425. assert.Len(t, email.To, 1)
  6426. assert.True(t, util.Contains(email.To, "[email protected]"))
  6427. assert.Contains(t, email.Data, `no recipient addresses set`)
  6428. conn, client, err := getSftpClient(user)
  6429. if assert.NoError(t, err) {
  6430. defer conn.Close()
  6431. defer client.Close()
  6432. lastReceivedEmail.reset()
  6433. err = client.Mkdir(testFileName)
  6434. assert.NoError(t, err)
  6435. assert.Eventually(t, func() bool {
  6436. return lastReceivedEmail.get().From != ""
  6437. }, 3000*time.Millisecond, 100*time.Millisecond)
  6438. email := lastReceivedEmail.get()
  6439. assert.Len(t, email.To, 1)
  6440. assert.True(t, util.Contains(email.To, user.Email))
  6441. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "mkdir" from "%s"`, user.Username))
  6442. }
  6443. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  6444. assert.NoError(t, err)
  6445. _, err = httpdtest.RemoveEventRule(rule2, http.StatusOK)
  6446. assert.NoError(t, err)
  6447. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  6448. assert.NoError(t, err)
  6449. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  6450. assert.NoError(t, err)
  6451. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  6452. assert.NoError(t, err)
  6453. err = os.RemoveAll(user.GetHomeDir())
  6454. assert.NoError(t, err)
  6455. _, err = httpdtest.RemoveUser(user1, http.StatusOK)
  6456. assert.NoError(t, err)
  6457. smtpCfg = smtp.Config{}
  6458. err = smtpCfg.Initialize(configDir, true)
  6459. require.NoError(t, err)
  6460. }
  6461. func TestEventRuleCertificate(t *testing.T) {
  6462. smtpCfg := smtp.Config{
  6463. Host: "127.0.0.1",
  6464. Port: 2525,
  6465. From: "[email protected]",
  6466. TemplatesPath: "templates",
  6467. }
  6468. err := smtpCfg.Initialize(configDir, true)
  6469. require.NoError(t, err)
  6470. lastReceivedEmail.reset()
  6471. a1 := dataprovider.BaseEventAction{
  6472. Name: "action1",
  6473. Type: dataprovider.ActionTypeEmail,
  6474. Options: dataprovider.BaseEventActionOptions{
  6475. EmailConfig: dataprovider.EventActionEmailConfig{
  6476. Recipients: []string{"[email protected]"},
  6477. Subject: `"{{Event}} {{StatusString}}"`,
  6478. ContentType: 0,
  6479. Body: "Domain: {{Name}} Timestamp: {{Timestamp}} {{ErrorString}}",
  6480. },
  6481. },
  6482. }
  6483. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  6484. assert.NoError(t, err)
  6485. a2 := dataprovider.BaseEventAction{
  6486. Name: "action2",
  6487. Type: dataprovider.ActionTypeFolderQuotaReset,
  6488. }
  6489. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  6490. assert.NoError(t, err)
  6491. r1 := dataprovider.EventRule{
  6492. Name: "test rule certificate",
  6493. Status: 1,
  6494. Trigger: dataprovider.EventTriggerCertificate,
  6495. Actions: []dataprovider.EventAction{
  6496. {
  6497. BaseEventAction: dataprovider.BaseEventAction{
  6498. Name: action1.Name,
  6499. },
  6500. Order: 1,
  6501. },
  6502. },
  6503. }
  6504. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  6505. assert.NoError(t, err)
  6506. r2 := dataprovider.EventRule{
  6507. Name: "test rule 2",
  6508. Status: 1,
  6509. Trigger: dataprovider.EventTriggerCertificate,
  6510. Actions: []dataprovider.EventAction{
  6511. {
  6512. BaseEventAction: dataprovider.BaseEventAction{
  6513. Name: action1.Name,
  6514. },
  6515. Order: 1,
  6516. },
  6517. {
  6518. BaseEventAction: dataprovider.BaseEventAction{
  6519. Name: action2.Name,
  6520. },
  6521. Order: 2,
  6522. },
  6523. },
  6524. }
  6525. rule2, _, err := httpdtest.AddEventRule(r2, http.StatusCreated)
  6526. assert.NoError(t, err)
  6527. renewalEvent := "Certificate renewal"
  6528. common.HandleCertificateEvent(common.EventParams{
  6529. Name: "example.com",
  6530. Timestamp: time.Now().UnixNano(),
  6531. Status: 1,
  6532. Event: renewalEvent,
  6533. })
  6534. assert.Eventually(t, func() bool {
  6535. return lastReceivedEmail.get().From != ""
  6536. }, 3000*time.Millisecond, 100*time.Millisecond)
  6537. email := lastReceivedEmail.get()
  6538. assert.Len(t, email.To, 1)
  6539. assert.True(t, util.Contains(email.To, "[email protected]"))
  6540. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "%s OK"`, renewalEvent))
  6541. assert.Contains(t, email.Data, "Content-Type: text/plain")
  6542. assert.Contains(t, email.Data, `Domain: example.com Timestamp`)
  6543. lastReceivedEmail.reset()
  6544. params := common.EventParams{
  6545. Name: "example.com",
  6546. Timestamp: time.Now().UnixNano(),
  6547. Status: 2,
  6548. Event: renewalEvent,
  6549. }
  6550. errRenew := errors.New("generic renew error")
  6551. params.AddError(errRenew)
  6552. common.HandleCertificateEvent(params)
  6553. assert.Eventually(t, func() bool {
  6554. return lastReceivedEmail.get().From != ""
  6555. }, 3000*time.Millisecond, 100*time.Millisecond)
  6556. email = lastReceivedEmail.get()
  6557. assert.Len(t, email.To, 1)
  6558. assert.True(t, util.Contains(email.To, "[email protected]"))
  6559. assert.Contains(t, email.Data, fmt.Sprintf(`Subject: "%s KO"`, renewalEvent))
  6560. assert.Contains(t, email.Data, `Domain: example.com Timestamp`)
  6561. assert.Contains(t, email.Data, errRenew.Error())
  6562. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  6563. assert.NoError(t, err)
  6564. _, err = httpdtest.RemoveEventRule(rule2, http.StatusOK)
  6565. assert.NoError(t, err)
  6566. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  6567. assert.NoError(t, err)
  6568. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  6569. assert.NoError(t, err)
  6570. // ignored no more certificate rules
  6571. common.HandleCertificateEvent(common.EventParams{
  6572. Name: "example.com",
  6573. Timestamp: time.Now().UnixNano(),
  6574. Status: 1,
  6575. Event: renewalEvent,
  6576. })
  6577. smtpCfg = smtp.Config{}
  6578. err = smtpCfg.Initialize(configDir, true)
  6579. require.NoError(t, err)
  6580. }
  6581. func TestEventRuleIPBlocked(t *testing.T) {
  6582. oldConfig := config.GetCommonConfig()
  6583. cfg := config.GetCommonConfig()
  6584. cfg.DefenderConfig.Enabled = true
  6585. cfg.DefenderConfig.Threshold = 3
  6586. cfg.DefenderConfig.ScoreLimitExceeded = 2
  6587. err := common.Initialize(cfg, 0)
  6588. assert.NoError(t, err)
  6589. smtpCfg := smtp.Config{
  6590. Host: "127.0.0.1",
  6591. Port: 2525,
  6592. From: "[email protected]",
  6593. TemplatesPath: "templates",
  6594. }
  6595. err = smtpCfg.Initialize(configDir, true)
  6596. require.NoError(t, err)
  6597. a1 := dataprovider.BaseEventAction{
  6598. Name: "action1",
  6599. Type: dataprovider.ActionTypeEmail,
  6600. Options: dataprovider.BaseEventActionOptions{
  6601. EmailConfig: dataprovider.EventActionEmailConfig{
  6602. Recipients: []string{"[email protected]", "[email protected]"},
  6603. Subject: `New "{{Event}}"`,
  6604. Body: "IP: {{IP}} Timestamp: {{Timestamp}}",
  6605. },
  6606. },
  6607. }
  6608. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  6609. assert.NoError(t, err)
  6610. a2 := dataprovider.BaseEventAction{
  6611. Name: "action2",
  6612. Type: dataprovider.ActionTypeFolderQuotaReset,
  6613. }
  6614. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  6615. assert.NoError(t, err)
  6616. r1 := dataprovider.EventRule{
  6617. Name: "test rule ip blocked",
  6618. Status: 1,
  6619. Trigger: dataprovider.EventTriggerIPBlocked,
  6620. Actions: []dataprovider.EventAction{
  6621. {
  6622. BaseEventAction: dataprovider.BaseEventAction{
  6623. Name: action1.Name,
  6624. },
  6625. Order: 1,
  6626. },
  6627. },
  6628. }
  6629. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  6630. assert.NoError(t, err)
  6631. r2 := dataprovider.EventRule{
  6632. Name: "test rule 2",
  6633. Status: 1,
  6634. Trigger: dataprovider.EventTriggerIPBlocked,
  6635. Actions: []dataprovider.EventAction{
  6636. {
  6637. BaseEventAction: dataprovider.BaseEventAction{
  6638. Name: action1.Name,
  6639. },
  6640. Order: 1,
  6641. },
  6642. {
  6643. BaseEventAction: dataprovider.BaseEventAction{
  6644. Name: action2.Name,
  6645. },
  6646. Order: 2,
  6647. },
  6648. },
  6649. }
  6650. rule2, _, err := httpdtest.AddEventRule(r2, http.StatusCreated)
  6651. assert.NoError(t, err)
  6652. u := getTestUser()
  6653. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  6654. assert.NoError(t, err)
  6655. lastReceivedEmail.reset()
  6656. time.Sleep(300 * time.Millisecond)
  6657. assert.Empty(t, lastReceivedEmail.get().From, lastReceivedEmail.get().Data)
  6658. for i := 0; i < 3; i++ {
  6659. user.Password = "wrong_pwd"
  6660. _, _, err = getSftpClient(user)
  6661. assert.Error(t, err)
  6662. }
  6663. // the client is now banned
  6664. user.Password = defaultPassword
  6665. _, _, err = getSftpClient(user)
  6666. assert.Error(t, err)
  6667. // check the email notification
  6668. assert.Eventually(t, func() bool {
  6669. return lastReceivedEmail.get().From != ""
  6670. }, 3000*time.Millisecond, 100*time.Millisecond)
  6671. email := lastReceivedEmail.get()
  6672. assert.Len(t, email.To, 2)
  6673. assert.True(t, util.Contains(email.To, "[email protected]"))
  6674. assert.True(t, util.Contains(email.To, "[email protected]"))
  6675. assert.Contains(t, email.Data, `Subject: New "IP Blocked"`)
  6676. err = dataprovider.DeleteEventRule(rule1.Name, "", "", "")
  6677. assert.NoError(t, err)
  6678. err = dataprovider.DeleteEventRule(rule2.Name, "", "", "")
  6679. assert.NoError(t, err)
  6680. err = dataprovider.DeleteEventAction(action1.Name, "", "", "")
  6681. assert.NoError(t, err)
  6682. err = dataprovider.DeleteEventAction(action2.Name, "", "", "")
  6683. assert.NoError(t, err)
  6684. err = dataprovider.DeleteUser(user.Username, "", "", "")
  6685. assert.NoError(t, err)
  6686. err = os.RemoveAll(user.GetHomeDir())
  6687. assert.NoError(t, err)
  6688. smtpCfg = smtp.Config{}
  6689. err = smtpCfg.Initialize(configDir, true)
  6690. require.NoError(t, err)
  6691. err = common.Initialize(oldConfig, 0)
  6692. assert.NoError(t, err)
  6693. }
  6694. func TestEventRulePasswordExpiration(t *testing.T) {
  6695. smtpCfg := smtp.Config{
  6696. Host: "127.0.0.1",
  6697. Port: 2525,
  6698. From: "[email protected]",
  6699. TemplatesPath: "templates",
  6700. }
  6701. err := smtpCfg.Initialize(configDir, true)
  6702. require.NoError(t, err)
  6703. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  6704. assert.NoError(t, err)
  6705. a1 := dataprovider.BaseEventAction{
  6706. Name: "a1",
  6707. Type: dataprovider.ActionTypeEmail,
  6708. Options: dataprovider.BaseEventActionOptions{
  6709. EmailConfig: dataprovider.EventActionEmailConfig{
  6710. Recipients: []string{"[email protected]"},
  6711. Subject: `Failure`,
  6712. Body: "Failure action",
  6713. },
  6714. },
  6715. }
  6716. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  6717. assert.NoError(t, err)
  6718. a2 := dataprovider.BaseEventAction{
  6719. Name: "a2",
  6720. Type: dataprovider.ActionTypePasswordExpirationCheck,
  6721. Options: dataprovider.BaseEventActionOptions{
  6722. PwdExpirationConfig: dataprovider.EventActionPasswordExpiration{
  6723. Threshold: 10,
  6724. },
  6725. },
  6726. }
  6727. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  6728. assert.NoError(t, err)
  6729. a3 := dataprovider.BaseEventAction{
  6730. Name: "a3",
  6731. Type: dataprovider.ActionTypeEmail,
  6732. Options: dataprovider.BaseEventActionOptions{
  6733. EmailConfig: dataprovider.EventActionEmailConfig{
  6734. Recipients: []string{"[email protected]"},
  6735. Subject: `OK`,
  6736. Body: "OK action",
  6737. },
  6738. },
  6739. }
  6740. action3, _, err := httpdtest.AddEventAction(a3, http.StatusCreated)
  6741. assert.NoError(t, err)
  6742. r1 := dataprovider.EventRule{
  6743. Name: "rule1",
  6744. Status: 1,
  6745. Trigger: dataprovider.EventTriggerFsEvent,
  6746. Conditions: dataprovider.EventConditions{
  6747. FsEvents: []string{"mkdir"},
  6748. },
  6749. Actions: []dataprovider.EventAction{
  6750. {
  6751. BaseEventAction: dataprovider.BaseEventAction{
  6752. Name: action2.Name,
  6753. },
  6754. Order: 1,
  6755. },
  6756. {
  6757. BaseEventAction: dataprovider.BaseEventAction{
  6758. Name: action3.Name,
  6759. },
  6760. Order: 2,
  6761. },
  6762. {
  6763. BaseEventAction: dataprovider.BaseEventAction{
  6764. Name: action1.Name,
  6765. },
  6766. Options: dataprovider.EventActionOptions{
  6767. IsFailureAction: true,
  6768. },
  6769. },
  6770. },
  6771. }
  6772. rule1, resp, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  6773. assert.NoError(t, err, string(resp))
  6774. dirName := "aTestDir"
  6775. conn, client, err := getSftpClient(user)
  6776. if assert.NoError(t, err) {
  6777. defer conn.Close()
  6778. defer client.Close()
  6779. lastReceivedEmail.reset()
  6780. err := client.Mkdir(dirName)
  6781. assert.NoError(t, err)
  6782. // the user has no password expiration, the check will be skipped and the ok action executed
  6783. assert.Eventually(t, func() bool {
  6784. return lastReceivedEmail.get().From != ""
  6785. }, 1500*time.Millisecond, 100*time.Millisecond)
  6786. email := lastReceivedEmail.get()
  6787. assert.Len(t, email.To, 1)
  6788. assert.Contains(t, email.To, "[email protected]")
  6789. err = client.RemoveDirectory(dirName)
  6790. assert.NoError(t, err)
  6791. }
  6792. user.Filters.PasswordExpiration = 20
  6793. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  6794. assert.NoError(t, err)
  6795. conn, client, err = getSftpClient(user)
  6796. if assert.NoError(t, err) {
  6797. defer conn.Close()
  6798. defer client.Close()
  6799. lastReceivedEmail.reset()
  6800. err := client.Mkdir(dirName)
  6801. assert.NoError(t, err)
  6802. // the passowrd is not about to expire, the check will be skipped and the ok action executed
  6803. assert.Eventually(t, func() bool {
  6804. return lastReceivedEmail.get().From != ""
  6805. }, 1500*time.Millisecond, 100*time.Millisecond)
  6806. email := lastReceivedEmail.get()
  6807. assert.Len(t, email.To, 1)
  6808. assert.Contains(t, email.To, "[email protected]")
  6809. err = client.RemoveDirectory(dirName)
  6810. assert.NoError(t, err)
  6811. }
  6812. user.Filters.PasswordExpiration = 5
  6813. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  6814. assert.NoError(t, err)
  6815. conn, client, err = getSftpClient(user)
  6816. if assert.NoError(t, err) {
  6817. defer conn.Close()
  6818. defer client.Close()
  6819. lastReceivedEmail.reset()
  6820. err := client.Mkdir(dirName)
  6821. assert.NoError(t, err)
  6822. // the passowrd is about to expire, the user has no email, the failure action will be executed
  6823. assert.Eventually(t, func() bool {
  6824. return lastReceivedEmail.get().From != ""
  6825. }, 1500*time.Millisecond, 100*time.Millisecond)
  6826. email := lastReceivedEmail.get()
  6827. assert.Len(t, email.To, 1)
  6828. assert.Contains(t, email.To, "[email protected]")
  6829. err = client.RemoveDirectory(dirName)
  6830. assert.NoError(t, err)
  6831. }
  6832. // remove the success action
  6833. rule1.Actions = []dataprovider.EventAction{
  6834. {
  6835. BaseEventAction: dataprovider.BaseEventAction{
  6836. Name: action2.Name,
  6837. },
  6838. Order: 1,
  6839. },
  6840. {
  6841. BaseEventAction: dataprovider.BaseEventAction{
  6842. Name: action1.Name,
  6843. },
  6844. Options: dataprovider.EventActionOptions{
  6845. IsFailureAction: true,
  6846. },
  6847. },
  6848. }
  6849. _, _, err = httpdtest.UpdateEventRule(rule1, http.StatusOK)
  6850. assert.NoError(t, err)
  6851. user.Email = "[email protected]"
  6852. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  6853. assert.NoError(t, err)
  6854. conn, client, err = getSftpClient(user)
  6855. if assert.NoError(t, err) {
  6856. defer conn.Close()
  6857. defer client.Close()
  6858. lastReceivedEmail.reset()
  6859. err := client.Mkdir(dirName)
  6860. assert.NoError(t, err)
  6861. // the passowrd expiration will be notified
  6862. assert.Eventually(t, func() bool {
  6863. return lastReceivedEmail.get().From != ""
  6864. }, 1500*time.Millisecond, 100*time.Millisecond)
  6865. email := lastReceivedEmail.get()
  6866. assert.Len(t, email.To, 1)
  6867. assert.Contains(t, email.To, user.Email)
  6868. assert.Contains(t, email.Data, "your SFTPGo password expires in 5 days")
  6869. err = client.RemoveDirectory(dirName)
  6870. assert.NoError(t, err)
  6871. }
  6872. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  6873. assert.NoError(t, err)
  6874. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  6875. assert.NoError(t, err)
  6876. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  6877. assert.NoError(t, err)
  6878. _, err = httpdtest.RemoveEventAction(action3, http.StatusOK)
  6879. assert.NoError(t, err)
  6880. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  6881. assert.NoError(t, err)
  6882. err = os.RemoveAll(user.GetHomeDir())
  6883. assert.NoError(t, err)
  6884. smtpCfg = smtp.Config{}
  6885. err = smtpCfg.Initialize(configDir, true)
  6886. require.NoError(t, err)
  6887. }
  6888. func TestSyncUploadAction(t *testing.T) {
  6889. if runtime.GOOS == osWindows {
  6890. t.Skip("this test is not available on Windows")
  6891. }
  6892. uploadScriptPath := filepath.Join(os.TempDir(), "upload.sh")
  6893. common.Config.Actions.ExecuteOn = []string{"upload"}
  6894. common.Config.Actions.ExecuteSync = []string{"upload"}
  6895. common.Config.Actions.Hook = uploadScriptPath
  6896. u := getTestUser()
  6897. u.QuotaFiles = 1000
  6898. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  6899. assert.NoError(t, err)
  6900. movedFileName := "moved.dat"
  6901. movedPath := filepath.Join(user.HomeDir, movedFileName)
  6902. err = os.WriteFile(uploadScriptPath, getUploadScriptContent(movedPath, "", 0), 0755)
  6903. assert.NoError(t, err)
  6904. conn, client, err := getSftpClient(user)
  6905. if assert.NoError(t, err) {
  6906. defer conn.Close()
  6907. defer client.Close()
  6908. size := int64(32768)
  6909. err = writeSFTPFileNoCheck(testFileName, size, client)
  6910. assert.NoError(t, err)
  6911. _, err = client.Stat(testFileName)
  6912. assert.Error(t, err)
  6913. info, err := client.Stat(movedFileName)
  6914. if assert.NoError(t, err) {
  6915. assert.Equal(t, size, info.Size())
  6916. }
  6917. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  6918. assert.NoError(t, err)
  6919. assert.Equal(t, 1, user.UsedQuotaFiles)
  6920. assert.Equal(t, size, user.UsedQuotaSize)
  6921. // test some hook failure
  6922. // the uploaded file is moved and the hook fails, it will be not removed from the quota
  6923. err = os.WriteFile(uploadScriptPath, getUploadScriptContent(movedPath, "", 1), 0755)
  6924. assert.NoError(t, err)
  6925. err = writeSFTPFileNoCheck(testFileName+"_1", size, client)
  6926. assert.Error(t, err)
  6927. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  6928. assert.NoError(t, err)
  6929. assert.Equal(t, 2, user.UsedQuotaFiles)
  6930. assert.Equal(t, size*2, user.UsedQuotaSize)
  6931. // the uploaded file is not moved and the hook fails, the uploaded file will be deleted
  6932. // and removed from the quota
  6933. movedPath = filepath.Join(user.HomeDir, "missing dir", movedFileName)
  6934. err = os.WriteFile(uploadScriptPath, getUploadScriptContent(movedPath, "", 1), 0755)
  6935. assert.NoError(t, err)
  6936. err = writeSFTPFileNoCheck(testFileName+"_2", size, client)
  6937. assert.Error(t, err)
  6938. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  6939. assert.NoError(t, err)
  6940. assert.Equal(t, 2, user.UsedQuotaFiles)
  6941. assert.Equal(t, size*2, user.UsedQuotaSize)
  6942. // overwrite an existing file
  6943. _, err = client.Stat(movedFileName)
  6944. assert.NoError(t, err)
  6945. err = writeSFTPFileNoCheck(movedFileName, size, client)
  6946. assert.Error(t, err)
  6947. _, err = client.Stat(movedFileName)
  6948. assert.Error(t, err)
  6949. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  6950. assert.NoError(t, err)
  6951. assert.Equal(t, 1, user.UsedQuotaFiles)
  6952. assert.Equal(t, size, user.UsedQuotaSize)
  6953. }
  6954. err = os.Remove(uploadScriptPath)
  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. common.Config.Actions.ExecuteOn = nil
  6961. common.Config.Actions.ExecuteSync = nil
  6962. common.Config.Actions.Hook = uploadScriptPath
  6963. }
  6964. func TestQuotaTrackDisabled(t *testing.T) {
  6965. err := dataprovider.Close()
  6966. assert.NoError(t, err)
  6967. err = config.LoadConfig(configDir, "")
  6968. assert.NoError(t, err)
  6969. providerConf := config.GetProviderConf()
  6970. providerConf.TrackQuota = 0
  6971. err = dataprovider.Initialize(providerConf, configDir, true)
  6972. assert.NoError(t, err)
  6973. user, _, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  6974. assert.NoError(t, err)
  6975. conn, client, err := getSftpClient(user)
  6976. if assert.NoError(t, err) {
  6977. defer conn.Close()
  6978. defer client.Close()
  6979. err = writeSFTPFile(testFileName, 32, client)
  6980. assert.NoError(t, err)
  6981. err = client.Rename(testFileName, testFileName+"1")
  6982. assert.NoError(t, err)
  6983. }
  6984. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  6985. assert.NoError(t, err)
  6986. err = os.RemoveAll(user.GetHomeDir())
  6987. assert.NoError(t, err)
  6988. err = dataprovider.Close()
  6989. assert.NoError(t, err)
  6990. err = config.LoadConfig(configDir, "")
  6991. assert.NoError(t, err)
  6992. providerConf = config.GetProviderConf()
  6993. err = dataprovider.Initialize(providerConf, configDir, true)
  6994. assert.NoError(t, err)
  6995. }
  6996. func TestGetQuotaError(t *testing.T) {
  6997. if dataprovider.GetProviderStatus().Driver == "memory" {
  6998. t.Skip("this test is not available with the memory provider")
  6999. }
  7000. u := getTestUser()
  7001. u.TotalDataTransfer = 2000
  7002. mappedPath := filepath.Join(os.TempDir(), "vdir")
  7003. folderName := filepath.Base(mappedPath)
  7004. vdirPath := "/vpath"
  7005. f := vfs.BaseVirtualFolder{
  7006. Name: folderName,
  7007. MappedPath: mappedPath,
  7008. }
  7009. _, _, err := httpdtest.AddFolder(f, http.StatusCreated)
  7010. assert.NoError(t, err)
  7011. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  7012. BaseVirtualFolder: vfs.BaseVirtualFolder{
  7013. Name: folderName,
  7014. },
  7015. VirtualPath: vdirPath,
  7016. QuotaSize: 0,
  7017. QuotaFiles: 10,
  7018. })
  7019. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  7020. assert.NoError(t, err)
  7021. conn, client, err := getSftpClient(user)
  7022. if assert.NoError(t, err) {
  7023. defer conn.Close()
  7024. defer client.Close()
  7025. err = writeSFTPFile(testFileName, 32, client)
  7026. assert.NoError(t, err)
  7027. err = dataprovider.Close()
  7028. assert.NoError(t, err)
  7029. err = client.Rename(testFileName, path.Join(vdirPath, testFileName))
  7030. assert.Error(t, err)
  7031. err = config.LoadConfig(configDir, "")
  7032. assert.NoError(t, err)
  7033. providerConf := config.GetProviderConf()
  7034. err = dataprovider.Initialize(providerConf, configDir, true)
  7035. assert.NoError(t, err)
  7036. }
  7037. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7038. assert.NoError(t, err)
  7039. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName}, http.StatusOK)
  7040. assert.NoError(t, err)
  7041. err = os.RemoveAll(user.GetHomeDir())
  7042. assert.NoError(t, err)
  7043. err = os.RemoveAll(mappedPath)
  7044. assert.NoError(t, err)
  7045. }
  7046. func TestRetentionAPI(t *testing.T) {
  7047. u := getTestUser()
  7048. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  7049. assert.NoError(t, err)
  7050. uploadPath := path.Join(testDir, testFileName)
  7051. conn, client, err := getSftpClient(user)
  7052. if assert.NoError(t, err) {
  7053. defer conn.Close()
  7054. defer client.Close()
  7055. err = client.Mkdir(testDir)
  7056. assert.NoError(t, err)
  7057. err = writeSFTPFile(uploadPath, 32, client)
  7058. assert.NoError(t, err)
  7059. folderRetention := []dataprovider.FolderRetention{
  7060. {
  7061. Path: "/",
  7062. Retention: 24,
  7063. DeleteEmptyDirs: true,
  7064. },
  7065. }
  7066. _, err = httpdtest.StartRetentionCheck(user.Username, folderRetention, http.StatusAccepted)
  7067. assert.NoError(t, err)
  7068. assert.Eventually(t, func() bool {
  7069. return len(common.RetentionChecks.Get("")) == 0
  7070. }, 1000*time.Millisecond, 50*time.Millisecond)
  7071. _, err = client.Stat(uploadPath)
  7072. assert.NoError(t, err)
  7073. err = client.Chtimes(uploadPath, time.Now().Add(-48*time.Hour), time.Now().Add(-48*time.Hour))
  7074. assert.NoError(t, err)
  7075. _, err = httpdtest.StartRetentionCheck(user.Username, folderRetention, http.StatusAccepted)
  7076. assert.NoError(t, err)
  7077. assert.Eventually(t, func() bool {
  7078. return len(common.RetentionChecks.Get("")) == 0
  7079. }, 1000*time.Millisecond, 50*time.Millisecond)
  7080. _, err = client.Stat(uploadPath)
  7081. assert.ErrorIs(t, err, os.ErrNotExist)
  7082. _, err = client.Stat(testDir)
  7083. assert.ErrorIs(t, err, os.ErrNotExist)
  7084. err = client.Mkdir(testDir)
  7085. assert.NoError(t, err)
  7086. err = writeSFTPFile(uploadPath, 32, client)
  7087. assert.NoError(t, err)
  7088. folderRetention[0].DeleteEmptyDirs = false
  7089. err = client.Chtimes(uploadPath, time.Now().Add(-48*time.Hour), time.Now().Add(-48*time.Hour))
  7090. assert.NoError(t, err)
  7091. _, err = httpdtest.StartRetentionCheck(user.Username, folderRetention, http.StatusAccepted)
  7092. assert.NoError(t, err)
  7093. assert.Eventually(t, func() bool {
  7094. return len(common.RetentionChecks.Get("")) == 0
  7095. }, 1000*time.Millisecond, 50*time.Millisecond)
  7096. _, err = client.Stat(uploadPath)
  7097. assert.ErrorIs(t, err, os.ErrNotExist)
  7098. _, err = client.Stat(testDir)
  7099. assert.NoError(t, err)
  7100. err = writeSFTPFile(uploadPath, 32, client)
  7101. assert.NoError(t, err)
  7102. err = client.Chtimes(uploadPath, time.Now().Add(-48*time.Hour), time.Now().Add(-48*time.Hour))
  7103. assert.NoError(t, err)
  7104. }
  7105. // remove delete permissions to the user
  7106. user.Permissions["/"+testDir] = []string{dataprovider.PermListItems, dataprovider.PermUpload,
  7107. dataprovider.PermCreateDirs, dataprovider.PermChtimes}
  7108. user, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  7109. assert.NoError(t, err)
  7110. conn, client, err = getSftpClient(user)
  7111. if assert.NoError(t, err) {
  7112. defer conn.Close()
  7113. defer client.Close()
  7114. innerUploadFilePath := path.Join("/"+testDir, testDir, testFileName)
  7115. err = client.Mkdir(path.Join(testDir, testDir))
  7116. assert.NoError(t, err)
  7117. err = writeSFTPFile(innerUploadFilePath, 32, client)
  7118. assert.NoError(t, err)
  7119. err = client.Chtimes(innerUploadFilePath, time.Now().Add(-48*time.Hour), time.Now().Add(-48*time.Hour))
  7120. assert.NoError(t, err)
  7121. folderRetention := []dataprovider.FolderRetention{
  7122. {
  7123. Path: "/missing",
  7124. Retention: 24,
  7125. },
  7126. {
  7127. Path: "/" + testDir,
  7128. Retention: 24,
  7129. DeleteEmptyDirs: true,
  7130. },
  7131. {
  7132. Path: path.Dir(innerUploadFilePath),
  7133. Retention: 0,
  7134. IgnoreUserPermissions: true,
  7135. },
  7136. }
  7137. _, err = httpdtest.StartRetentionCheck(user.Username, folderRetention, http.StatusAccepted)
  7138. assert.NoError(t, err)
  7139. assert.Eventually(t, func() bool {
  7140. return len(common.RetentionChecks.Get("")) == 0
  7141. }, 1000*time.Millisecond, 50*time.Millisecond)
  7142. _, err = client.Stat(uploadPath)
  7143. assert.NoError(t, err)
  7144. _, err = client.Stat(innerUploadFilePath)
  7145. assert.NoError(t, err)
  7146. folderRetention[1].IgnoreUserPermissions = true
  7147. _, err = httpdtest.StartRetentionCheck(user.Username, folderRetention, http.StatusAccepted)
  7148. assert.NoError(t, err)
  7149. assert.Eventually(t, func() bool {
  7150. return len(common.RetentionChecks.Get("")) == 0
  7151. }, 1000*time.Millisecond, 50*time.Millisecond)
  7152. _, err = client.Stat(uploadPath)
  7153. assert.ErrorIs(t, err, os.ErrNotExist)
  7154. _, err = client.Stat(innerUploadFilePath)
  7155. assert.NoError(t, err)
  7156. folderRetention = []dataprovider.FolderRetention{
  7157. {
  7158. Path: "/" + testDir,
  7159. Retention: 24,
  7160. DeleteEmptyDirs: true,
  7161. IgnoreUserPermissions: true,
  7162. },
  7163. }
  7164. _, err = httpdtest.StartRetentionCheck(user.Username, folderRetention, http.StatusAccepted)
  7165. assert.NoError(t, err)
  7166. assert.Eventually(t, func() bool {
  7167. return len(common.RetentionChecks.Get("")) == 0
  7168. }, 1000*time.Millisecond, 50*time.Millisecond)
  7169. _, err = client.Stat(innerUploadFilePath)
  7170. assert.ErrorIs(t, err, os.ErrNotExist)
  7171. }
  7172. // finally test some errors removing files or folders
  7173. if runtime.GOOS != osWindows {
  7174. dirPath := filepath.Join(user.HomeDir, "adir", "sub")
  7175. err := os.MkdirAll(dirPath, os.ModePerm)
  7176. assert.NoError(t, err)
  7177. filePath := filepath.Join(dirPath, "f.dat")
  7178. err = os.WriteFile(filePath, nil, os.ModePerm)
  7179. assert.NoError(t, err)
  7180. err = os.Chtimes(filePath, time.Now().Add(-72*time.Hour), time.Now().Add(-72*time.Hour))
  7181. assert.NoError(t, err)
  7182. err = os.Chmod(dirPath, 0001)
  7183. assert.NoError(t, err)
  7184. folderRetention := []dataprovider.FolderRetention{
  7185. {
  7186. Path: "/adir",
  7187. Retention: 24,
  7188. DeleteEmptyDirs: true,
  7189. IgnoreUserPermissions: true,
  7190. },
  7191. }
  7192. _, err = httpdtest.StartRetentionCheck(user.Username, folderRetention, http.StatusAccepted)
  7193. assert.NoError(t, err)
  7194. assert.Eventually(t, func() bool {
  7195. return len(common.RetentionChecks.Get("")) == 0
  7196. }, 1000*time.Millisecond, 50*time.Millisecond)
  7197. err = os.Chmod(dirPath, 0555)
  7198. assert.NoError(t, err)
  7199. _, err = httpdtest.StartRetentionCheck(user.Username, folderRetention, http.StatusAccepted)
  7200. assert.NoError(t, err)
  7201. assert.Eventually(t, func() bool {
  7202. return len(common.RetentionChecks.Get("")) == 0
  7203. }, 1000*time.Millisecond, 50*time.Millisecond)
  7204. err = os.Chmod(dirPath, os.ModePerm)
  7205. assert.NoError(t, err)
  7206. _, err = httpdtest.StartRetentionCheck(user.Username, folderRetention, http.StatusAccepted)
  7207. assert.NoError(t, err)
  7208. assert.Eventually(t, func() bool {
  7209. return len(common.RetentionChecks.Get("")) == 0
  7210. }, 1000*time.Millisecond, 50*time.Millisecond)
  7211. assert.NoDirExists(t, dirPath)
  7212. }
  7213. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7214. assert.NoError(t, err)
  7215. err = os.RemoveAll(user.GetHomeDir())
  7216. assert.NoError(t, err)
  7217. }
  7218. func TestRenameDir(t *testing.T) {
  7219. u := getTestUser()
  7220. testDir := "/dir-to-rename"
  7221. u.Permissions[testDir] = []string{dataprovider.PermListItems, dataprovider.PermUpload}
  7222. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  7223. assert.NoError(t, err)
  7224. conn, client, err := getSftpClient(user)
  7225. if assert.NoError(t, err) {
  7226. defer conn.Close()
  7227. defer client.Close()
  7228. err = client.Mkdir(testDir)
  7229. assert.NoError(t, err)
  7230. err = writeSFTPFile(path.Join(testDir, testFileName), 32, client)
  7231. assert.NoError(t, err)
  7232. err = client.Rename(testDir, testDir+"_rename")
  7233. assert.ErrorIs(t, err, os.ErrPermission)
  7234. }
  7235. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7236. assert.NoError(t, err)
  7237. err = os.RemoveAll(user.GetHomeDir())
  7238. assert.NoError(t, err)
  7239. }
  7240. func TestBuiltinKeyboardInteractiveAuthentication(t *testing.T) {
  7241. u := getTestUser()
  7242. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  7243. assert.NoError(t, err)
  7244. authMethods := []ssh.AuthMethod{
  7245. ssh.KeyboardInteractive(func(user, instruction string, questions []string, echos []bool) ([]string, error) {
  7246. return []string{defaultPassword}, nil
  7247. }),
  7248. }
  7249. conn, client, err := getCustomAuthSftpClient(user, authMethods)
  7250. if assert.NoError(t, err) {
  7251. defer conn.Close()
  7252. defer client.Close()
  7253. assert.NoError(t, checkBasicSFTP(client))
  7254. err = writeSFTPFile(testFileName, 4096, client)
  7255. assert.NoError(t, err)
  7256. }
  7257. // add multi-factor authentication
  7258. configName, _, secret, _, err := mfa.GenerateTOTPSecret(mfa.GetAvailableTOTPConfigNames()[0], user.Username)
  7259. assert.NoError(t, err)
  7260. user.Password = defaultPassword
  7261. user.Filters.TOTPConfig = dataprovider.UserTOTPConfig{
  7262. Enabled: true,
  7263. ConfigName: configName,
  7264. Secret: kms.NewPlainSecret(secret),
  7265. Protocols: []string{common.ProtocolSSH},
  7266. }
  7267. err = dataprovider.UpdateUser(&user, "", "", "")
  7268. assert.NoError(t, err)
  7269. passcode, err := generateTOTPPasscode(secret, otp.AlgorithmSHA1)
  7270. assert.NoError(t, err)
  7271. passwordAsked := false
  7272. passcodeAsked := false
  7273. authMethods = []ssh.AuthMethod{
  7274. ssh.KeyboardInteractive(func(user, instruction string, questions []string, echos []bool) ([]string, error) {
  7275. var answers []string
  7276. if strings.HasPrefix(questions[0], "Password") {
  7277. answers = append(answers, defaultPassword)
  7278. passwordAsked = true
  7279. } else {
  7280. answers = append(answers, passcode)
  7281. passcodeAsked = true
  7282. }
  7283. return answers, nil
  7284. }),
  7285. }
  7286. conn, client, err = getCustomAuthSftpClient(user, authMethods)
  7287. if assert.NoError(t, err) {
  7288. defer conn.Close()
  7289. defer client.Close()
  7290. assert.NoError(t, checkBasicSFTP(client))
  7291. err = writeSFTPFile(testFileName, 4096, client)
  7292. assert.NoError(t, err)
  7293. }
  7294. assert.True(t, passwordAsked)
  7295. assert.True(t, passcodeAsked)
  7296. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7297. assert.NoError(t, err)
  7298. err = os.RemoveAll(user.GetHomeDir())
  7299. assert.NoError(t, err)
  7300. }
  7301. func TestRenameSymlink(t *testing.T) {
  7302. u := getTestUser()
  7303. testDir := "/dir-no-create-links"
  7304. otherDir := "otherdir"
  7305. u.Permissions[testDir] = []string{dataprovider.PermListItems, dataprovider.PermUpload, dataprovider.PermDelete,
  7306. dataprovider.PermCreateDirs}
  7307. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  7308. assert.NoError(t, err)
  7309. conn, client, err := getSftpClient(user)
  7310. if assert.NoError(t, err) {
  7311. defer conn.Close()
  7312. defer client.Close()
  7313. err = client.Mkdir(otherDir)
  7314. assert.NoError(t, err)
  7315. err = client.Symlink(otherDir, otherDir+".link")
  7316. assert.NoError(t, err)
  7317. err = client.Rename(otherDir+".link", path.Join(testDir, "symlink"))
  7318. assert.ErrorIs(t, err, os.ErrPermission)
  7319. err = client.Rename(otherDir+".link", "allowed_link")
  7320. assert.NoError(t, err)
  7321. }
  7322. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7323. assert.NoError(t, err)
  7324. err = os.RemoveAll(user.GetHomeDir())
  7325. assert.NoError(t, err)
  7326. }
  7327. func TestSplittedDeletePerms(t *testing.T) {
  7328. u := getTestUser()
  7329. u.Permissions["/"] = []string{dataprovider.PermListItems, dataprovider.PermUpload, dataprovider.PermDeleteDirs,
  7330. dataprovider.PermCreateDirs}
  7331. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  7332. assert.NoError(t, err)
  7333. conn, client, err := getSftpClient(user)
  7334. if assert.NoError(t, err) {
  7335. defer conn.Close()
  7336. defer client.Close()
  7337. err = writeSFTPFile(testFileName, 4096, client)
  7338. assert.NoError(t, err)
  7339. err = client.Remove(testFileName)
  7340. assert.Error(t, err)
  7341. err = client.Mkdir(testDir)
  7342. assert.NoError(t, err)
  7343. err = client.RemoveDirectory(testDir)
  7344. assert.NoError(t, err)
  7345. }
  7346. u.Permissions["/"] = []string{dataprovider.PermListItems, dataprovider.PermUpload, dataprovider.PermDeleteFiles,
  7347. dataprovider.PermCreateDirs, dataprovider.PermOverwrite}
  7348. _, _, err = httpdtest.UpdateUser(u, http.StatusOK, "")
  7349. assert.NoError(t, err)
  7350. conn, client, err = getSftpClient(user)
  7351. if assert.NoError(t, err) {
  7352. defer conn.Close()
  7353. defer client.Close()
  7354. err = writeSFTPFile(testFileName, 4096, client)
  7355. assert.NoError(t, err)
  7356. err = client.Remove(testFileName)
  7357. assert.NoError(t, err)
  7358. err = client.Mkdir(testDir)
  7359. assert.NoError(t, err)
  7360. err = client.RemoveDirectory(testDir)
  7361. assert.Error(t, err)
  7362. }
  7363. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7364. assert.NoError(t, err)
  7365. err = os.RemoveAll(user.GetHomeDir())
  7366. assert.NoError(t, err)
  7367. }
  7368. func TestSplittedRenamePerms(t *testing.T) {
  7369. u := getTestUser()
  7370. u.Permissions["/"] = []string{dataprovider.PermListItems, dataprovider.PermUpload, dataprovider.PermRenameDirs,
  7371. dataprovider.PermCreateDirs}
  7372. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  7373. assert.NoError(t, err)
  7374. conn, client, err := getSftpClient(user)
  7375. if assert.NoError(t, err) {
  7376. defer conn.Close()
  7377. defer client.Close()
  7378. err = writeSFTPFile(testFileName, 4096, client)
  7379. assert.NoError(t, err)
  7380. err = client.Mkdir(testDir)
  7381. assert.NoError(t, err)
  7382. err = client.Rename(testFileName, testFileName+"_renamed")
  7383. assert.Error(t, err)
  7384. err = client.Rename(testDir, testDir+"_renamed")
  7385. assert.NoError(t, err)
  7386. }
  7387. u.Permissions["/"] = []string{dataprovider.PermListItems, dataprovider.PermUpload, dataprovider.PermRenameFiles,
  7388. dataprovider.PermCreateDirs, dataprovider.PermOverwrite}
  7389. _, _, err = httpdtest.UpdateUser(u, http.StatusOK, "")
  7390. assert.NoError(t, err)
  7391. conn, client, err = getSftpClient(user)
  7392. if assert.NoError(t, err) {
  7393. defer conn.Close()
  7394. defer client.Close()
  7395. err = writeSFTPFile(testFileName, 4096, client)
  7396. assert.NoError(t, err)
  7397. err = client.Mkdir(testDir)
  7398. assert.NoError(t, err)
  7399. err = client.Rename(testFileName, testFileName+"_renamed")
  7400. assert.NoError(t, err)
  7401. err = client.Rename(testDir, testDir+"_renamed")
  7402. assert.Error(t, err)
  7403. }
  7404. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7405. assert.NoError(t, err)
  7406. err = os.RemoveAll(user.GetHomeDir())
  7407. assert.NoError(t, err)
  7408. }
  7409. func TestSFTPLoopError(t *testing.T) {
  7410. smtpCfg := smtp.Config{
  7411. Host: "127.0.0.1",
  7412. Port: 2525,
  7413. From: "[email protected]",
  7414. TemplatesPath: "templates",
  7415. }
  7416. err := smtpCfg.Initialize(configDir, true)
  7417. require.NoError(t, err)
  7418. user1 := getTestUser()
  7419. user2 := getTestUser()
  7420. user1.Username += "1"
  7421. user2.Username += "2"
  7422. // user1 is a local account with a virtual SFTP folder to user2
  7423. // user2 has user1 as SFTP fs
  7424. f := vfs.BaseVirtualFolder{
  7425. Name: "sftp",
  7426. FsConfig: vfs.Filesystem{
  7427. Provider: sdk.SFTPFilesystemProvider,
  7428. SFTPConfig: vfs.SFTPFsConfig{
  7429. BaseSFTPFsConfig: sdk.BaseSFTPFsConfig{
  7430. Endpoint: sftpServerAddr,
  7431. Username: user2.Username,
  7432. },
  7433. Password: kms.NewPlainSecret(defaultPassword),
  7434. },
  7435. },
  7436. }
  7437. folder, _, err := httpdtest.AddFolder(f, http.StatusCreated)
  7438. assert.NoError(t, err)
  7439. user1.VirtualFolders = append(user1.VirtualFolders, vfs.VirtualFolder{
  7440. BaseVirtualFolder: vfs.BaseVirtualFolder{
  7441. Name: folder.Name,
  7442. },
  7443. VirtualPath: "/vdir",
  7444. })
  7445. user2.FsConfig.Provider = sdk.SFTPFilesystemProvider
  7446. user2.FsConfig.SFTPConfig = vfs.SFTPFsConfig{
  7447. BaseSFTPFsConfig: sdk.BaseSFTPFsConfig{
  7448. Endpoint: sftpServerAddr,
  7449. Username: user1.Username,
  7450. },
  7451. Password: kms.NewPlainSecret(defaultPassword),
  7452. }
  7453. user1, resp, err := httpdtest.AddUser(user1, http.StatusCreated)
  7454. assert.NoError(t, err, string(resp))
  7455. user2, resp, err = httpdtest.AddUser(user2, http.StatusCreated)
  7456. assert.NoError(t, err, string(resp))
  7457. // test metadata check event error
  7458. a1 := dataprovider.BaseEventAction{
  7459. Name: "a1",
  7460. Type: dataprovider.ActionTypeMetadataCheck,
  7461. }
  7462. action1, _, err := httpdtest.AddEventAction(a1, http.StatusCreated)
  7463. assert.NoError(t, err)
  7464. a2 := dataprovider.BaseEventAction{
  7465. Name: "a2",
  7466. Type: dataprovider.ActionTypeEmail,
  7467. Options: dataprovider.BaseEventActionOptions{
  7468. EmailConfig: dataprovider.EventActionEmailConfig{
  7469. Recipients: []string{"[email protected]"},
  7470. Subject: `Failed action"`,
  7471. Body: "Test body",
  7472. },
  7473. },
  7474. }
  7475. action2, _, err := httpdtest.AddEventAction(a2, http.StatusCreated)
  7476. assert.NoError(t, err)
  7477. r1 := dataprovider.EventRule{
  7478. Name: "rule1",
  7479. Status: 1,
  7480. Trigger: dataprovider.EventTriggerProviderEvent,
  7481. Conditions: dataprovider.EventConditions{
  7482. ProviderEvents: []string{"update"},
  7483. },
  7484. Actions: []dataprovider.EventAction{
  7485. {
  7486. BaseEventAction: dataprovider.BaseEventAction{
  7487. Name: action1.Name,
  7488. },
  7489. Order: 1,
  7490. },
  7491. {
  7492. BaseEventAction: dataprovider.BaseEventAction{
  7493. Name: action2.Name,
  7494. },
  7495. Order: 2,
  7496. Options: dataprovider.EventActionOptions{
  7497. IsFailureAction: true,
  7498. },
  7499. },
  7500. },
  7501. }
  7502. rule1, _, err := httpdtest.AddEventRule(r1, http.StatusCreated)
  7503. assert.NoError(t, err)
  7504. lastReceivedEmail.reset()
  7505. _, _, err = httpdtest.UpdateUser(user2, http.StatusOK, "")
  7506. assert.NoError(t, err)
  7507. assert.Eventually(t, func() bool {
  7508. return lastReceivedEmail.get().From != ""
  7509. }, 3000*time.Millisecond, 100*time.Millisecond)
  7510. email := lastReceivedEmail.get()
  7511. assert.Len(t, email.To, 1)
  7512. assert.True(t, util.Contains(email.To, "[email protected]"))
  7513. assert.Contains(t, email.Data, `Subject: Failed action`)
  7514. user1.VirtualFolders[0].FsConfig.SFTPConfig.Password = kms.NewPlainSecret(defaultPassword)
  7515. user2.FsConfig.SFTPConfig.Password = kms.NewPlainSecret(defaultPassword)
  7516. conn := common.NewBaseConnection("", common.ProtocolWebDAV, "", "", user1)
  7517. _, _, err = conn.GetFsAndResolvedPath(user1.VirtualFolders[0].VirtualPath)
  7518. assert.ErrorIs(t, err, os.ErrPermission)
  7519. conn = common.NewBaseConnection("", common.ProtocolSFTP, "", "", user1)
  7520. _, _, err = conn.GetFsAndResolvedPath(user1.VirtualFolders[0].VirtualPath)
  7521. assert.Error(t, err)
  7522. conn = common.NewBaseConnection("", common.ProtocolFTP, "", "", user1)
  7523. _, _, err = conn.GetFsAndResolvedPath(user1.VirtualFolders[0].VirtualPath)
  7524. assert.Error(t, err)
  7525. _, err = httpdtest.RemoveEventRule(rule1, http.StatusOK)
  7526. assert.NoError(t, err)
  7527. _, err = httpdtest.RemoveEventAction(action1, http.StatusOK)
  7528. assert.NoError(t, err)
  7529. _, err = httpdtest.RemoveEventAction(action2, http.StatusOK)
  7530. assert.NoError(t, err)
  7531. _, err = httpdtest.RemoveUser(user1, http.StatusOK)
  7532. assert.NoError(t, err)
  7533. err = os.RemoveAll(user1.GetHomeDir())
  7534. assert.NoError(t, err)
  7535. _, err = httpdtest.RemoveUser(user2, http.StatusOK)
  7536. assert.NoError(t, err)
  7537. err = os.RemoveAll(user2.GetHomeDir())
  7538. assert.NoError(t, err)
  7539. _, err = httpdtest.RemoveFolder(folder, http.StatusOK)
  7540. assert.NoError(t, err)
  7541. smtpCfg = smtp.Config{}
  7542. err = smtpCfg.Initialize(configDir, true)
  7543. require.NoError(t, err)
  7544. }
  7545. func TestNonLocalCrossRename(t *testing.T) {
  7546. baseUser, resp, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  7547. assert.NoError(t, err, string(resp))
  7548. u := getTestUser()
  7549. u.HomeDir += "_folders"
  7550. u.Username += "_folders"
  7551. mappedPathSFTP := filepath.Join(os.TempDir(), "sftp")
  7552. folderNameSFTP := filepath.Base(mappedPathSFTP)
  7553. vdirSFTPPath := "/vdir/sftp"
  7554. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  7555. BaseVirtualFolder: vfs.BaseVirtualFolder{
  7556. Name: folderNameSFTP,
  7557. },
  7558. VirtualPath: vdirSFTPPath,
  7559. })
  7560. mappedPathCrypt := filepath.Join(os.TempDir(), "crypt")
  7561. folderNameCrypt := filepath.Base(mappedPathCrypt)
  7562. vdirCryptPath := "/vdir/crypt"
  7563. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  7564. BaseVirtualFolder: vfs.BaseVirtualFolder{
  7565. Name: folderNameCrypt,
  7566. },
  7567. VirtualPath: vdirCryptPath,
  7568. })
  7569. f1 := vfs.BaseVirtualFolder{
  7570. Name: folderNameSFTP,
  7571. FsConfig: vfs.Filesystem{
  7572. Provider: sdk.SFTPFilesystemProvider,
  7573. SFTPConfig: vfs.SFTPFsConfig{
  7574. BaseSFTPFsConfig: sdk.BaseSFTPFsConfig{
  7575. Endpoint: sftpServerAddr,
  7576. Username: baseUser.Username,
  7577. },
  7578. Password: kms.NewPlainSecret(defaultPassword),
  7579. },
  7580. },
  7581. }
  7582. _, _, err = httpdtest.AddFolder(f1, http.StatusCreated)
  7583. assert.NoError(t, err)
  7584. f2 := vfs.BaseVirtualFolder{
  7585. Name: folderNameCrypt,
  7586. FsConfig: vfs.Filesystem{
  7587. Provider: sdk.CryptedFilesystemProvider,
  7588. CryptConfig: vfs.CryptFsConfig{
  7589. Passphrase: kms.NewPlainSecret(defaultPassword),
  7590. },
  7591. },
  7592. MappedPath: mappedPathCrypt,
  7593. }
  7594. _, _, err = httpdtest.AddFolder(f2, http.StatusCreated)
  7595. assert.NoError(t, err)
  7596. user, resp, err := httpdtest.AddUser(u, http.StatusCreated)
  7597. assert.NoError(t, err, string(resp))
  7598. conn, client, err := getSftpClient(user)
  7599. if assert.NoError(t, err) {
  7600. defer conn.Close()
  7601. defer client.Close()
  7602. assert.NoError(t, checkBasicSFTP(client))
  7603. err = writeSFTPFile(testFileName, 4096, client)
  7604. assert.NoError(t, err)
  7605. err = writeSFTPFile(path.Join(vdirSFTPPath, testFileName), 8192, client)
  7606. assert.NoError(t, err)
  7607. err = writeSFTPFile(path.Join(vdirCryptPath, testFileName), 16384, client)
  7608. assert.NoError(t, err)
  7609. err = client.Rename(path.Join(vdirSFTPPath, testFileName), path.Join(vdirCryptPath, testFileName+".rename"))
  7610. assert.ErrorIs(t, err, os.ErrPermission)
  7611. err = client.Rename(path.Join(vdirCryptPath, testFileName), path.Join(vdirSFTPPath, testFileName+".rename"))
  7612. assert.ErrorIs(t, err, os.ErrPermission)
  7613. err = client.Rename(testFileName, path.Join(vdirCryptPath, testFileName+".rename"))
  7614. assert.ErrorIs(t, err, os.ErrPermission)
  7615. err = client.Rename(testFileName, path.Join(vdirSFTPPath, testFileName+".rename"))
  7616. assert.ErrorIs(t, err, os.ErrPermission)
  7617. err = client.Rename(path.Join(vdirSFTPPath, testFileName), testFileName+".rename")
  7618. assert.ErrorIs(t, err, os.ErrPermission)
  7619. err = client.Rename(path.Join(vdirCryptPath, testFileName), testFileName+".rename")
  7620. assert.ErrorIs(t, err, os.ErrPermission)
  7621. // rename on local fs or on the same folder must work
  7622. err = client.Rename(testFileName, testFileName+".rename")
  7623. assert.NoError(t, err)
  7624. err = client.Rename(path.Join(vdirSFTPPath, testFileName), path.Join(vdirSFTPPath, testFileName+"_rename"))
  7625. assert.NoError(t, err)
  7626. err = client.Rename(path.Join(vdirCryptPath, testFileName), path.Join(vdirCryptPath, testFileName+"_rename"))
  7627. assert.NoError(t, err)
  7628. // renaming a virtual folder is not allowed
  7629. err = client.Rename(vdirSFTPPath, vdirSFTPPath+"_rename")
  7630. assert.ErrorIs(t, err, os.ErrPermission)
  7631. err = client.Rename(vdirCryptPath, vdirCryptPath+"_rename")
  7632. assert.ErrorIs(t, err, os.ErrPermission)
  7633. err = client.Rename(vdirCryptPath, path.Join(vdirCryptPath, "rename"))
  7634. assert.ErrorIs(t, err, os.ErrPermission)
  7635. err = client.Mkdir(path.Join(vdirCryptPath, "subcryptdir"))
  7636. assert.NoError(t, err)
  7637. err = client.Rename(path.Join(vdirCryptPath, "subcryptdir"), vdirCryptPath)
  7638. assert.ErrorIs(t, err, os.ErrPermission)
  7639. // renaming root folder is not allowed
  7640. err = client.Rename("/", "new_name")
  7641. assert.ErrorIs(t, err, os.ErrPermission)
  7642. // renaming a path to a virtual folder is not allowed
  7643. err = client.Rename("/vdir", "new_vdir")
  7644. if assert.Error(t, err) {
  7645. assert.Contains(t, err.Error(), "SSH_FX_OP_UNSUPPORTED")
  7646. }
  7647. }
  7648. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7649. assert.NoError(t, err)
  7650. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderNameCrypt}, http.StatusOK)
  7651. assert.NoError(t, err)
  7652. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderNameSFTP}, http.StatusOK)
  7653. assert.NoError(t, err)
  7654. _, err = httpdtest.RemoveUser(baseUser, http.StatusOK)
  7655. assert.NoError(t, err)
  7656. err = os.RemoveAll(user.GetHomeDir())
  7657. assert.NoError(t, err)
  7658. err = os.RemoveAll(baseUser.GetHomeDir())
  7659. assert.NoError(t, err)
  7660. err = os.RemoveAll(mappedPathCrypt)
  7661. assert.NoError(t, err)
  7662. err = os.RemoveAll(mappedPathSFTP)
  7663. assert.NoError(t, err)
  7664. }
  7665. func TestNonLocalCrossRenameNonLocalBaseUser(t *testing.T) {
  7666. baseUser, resp, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  7667. assert.NoError(t, err, string(resp))
  7668. u := getTestSFTPUser()
  7669. mappedPathLocal := filepath.Join(os.TempDir(), "local")
  7670. folderNameLocal := filepath.Base(mappedPathLocal)
  7671. vdirLocalPath := "/vdir/local"
  7672. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  7673. BaseVirtualFolder: vfs.BaseVirtualFolder{
  7674. Name: folderNameLocal,
  7675. },
  7676. VirtualPath: vdirLocalPath,
  7677. })
  7678. mappedPathCrypt := filepath.Join(os.TempDir(), "crypt")
  7679. folderNameCrypt := filepath.Base(mappedPathCrypt)
  7680. vdirCryptPath := "/vdir/crypt"
  7681. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  7682. BaseVirtualFolder: vfs.BaseVirtualFolder{
  7683. Name: folderNameCrypt,
  7684. },
  7685. VirtualPath: vdirCryptPath,
  7686. })
  7687. f1 := vfs.BaseVirtualFolder{
  7688. Name: folderNameLocal,
  7689. MappedPath: mappedPathLocal,
  7690. }
  7691. _, _, err = httpdtest.AddFolder(f1, http.StatusCreated)
  7692. assert.NoError(t, err)
  7693. f2 := vfs.BaseVirtualFolder{
  7694. Name: folderNameCrypt,
  7695. FsConfig: vfs.Filesystem{
  7696. Provider: sdk.CryptedFilesystemProvider,
  7697. CryptConfig: vfs.CryptFsConfig{
  7698. Passphrase: kms.NewPlainSecret(defaultPassword),
  7699. },
  7700. },
  7701. MappedPath: mappedPathCrypt,
  7702. }
  7703. _, _, err = httpdtest.AddFolder(f2, http.StatusCreated)
  7704. assert.NoError(t, err)
  7705. user, resp, err := httpdtest.AddUser(u, http.StatusCreated)
  7706. assert.NoError(t, err, string(resp))
  7707. conn, client, err := getSftpClient(user)
  7708. if assert.NoError(t, err) {
  7709. defer conn.Close()
  7710. defer client.Close()
  7711. assert.NoError(t, checkBasicSFTP(client))
  7712. err = writeSFTPFile(testFileName, 4096, client)
  7713. assert.NoError(t, err)
  7714. err = writeSFTPFile(path.Join(vdirLocalPath, testFileName), 8192, client)
  7715. assert.NoError(t, err)
  7716. err = writeSFTPFile(path.Join(vdirCryptPath, testFileName), 16384, client)
  7717. assert.NoError(t, err)
  7718. err = client.Rename(path.Join(vdirLocalPath, testFileName), path.Join(vdirCryptPath, testFileName+".rename"))
  7719. assert.ErrorIs(t, err, os.ErrPermission)
  7720. err = client.Rename(path.Join(vdirCryptPath, testFileName), path.Join(vdirLocalPath, testFileName+".rename"))
  7721. assert.ErrorIs(t, err, os.ErrPermission)
  7722. err = client.Rename(testFileName, path.Join(vdirCryptPath, testFileName+".rename"))
  7723. assert.ErrorIs(t, err, os.ErrPermission)
  7724. err = client.Rename(testFileName, path.Join(vdirLocalPath, testFileName+".rename"))
  7725. assert.ErrorIs(t, err, os.ErrPermission)
  7726. err = client.Rename(path.Join(vdirLocalPath, testFileName), testFileName+".rename")
  7727. assert.ErrorIs(t, err, os.ErrPermission)
  7728. err = client.Rename(path.Join(vdirCryptPath, testFileName), testFileName+".rename")
  7729. assert.ErrorIs(t, err, os.ErrPermission)
  7730. // rename on local fs or on the same folder must work
  7731. err = client.Rename(testFileName, testFileName+".rename")
  7732. assert.NoError(t, err)
  7733. err = client.Rename(path.Join(vdirLocalPath, testFileName), path.Join(vdirLocalPath, testFileName+"_rename"))
  7734. assert.NoError(t, err)
  7735. err = client.Rename(path.Join(vdirCryptPath, testFileName), path.Join(vdirCryptPath, testFileName+"_rename"))
  7736. assert.NoError(t, err)
  7737. // renaming a virtual folder is not allowed
  7738. err = client.Rename(vdirLocalPath, vdirLocalPath+"_rename")
  7739. assert.ErrorIs(t, err, os.ErrPermission)
  7740. err = client.Rename(vdirCryptPath, vdirCryptPath+"_rename")
  7741. assert.ErrorIs(t, err, os.ErrPermission)
  7742. // renaming root folder is not allowed
  7743. err = client.Rename("/", "new_name")
  7744. assert.ErrorIs(t, err, os.ErrPermission)
  7745. // renaming a path to a virtual folder is not allowed
  7746. err = client.Rename("/vdir", "new_vdir")
  7747. if assert.Error(t, err) {
  7748. assert.Contains(t, err.Error(), "SSH_FX_OP_UNSUPPORTED")
  7749. }
  7750. }
  7751. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7752. assert.NoError(t, err)
  7753. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderNameCrypt}, http.StatusOK)
  7754. assert.NoError(t, err)
  7755. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderNameLocal}, http.StatusOK)
  7756. assert.NoError(t, err)
  7757. _, err = httpdtest.RemoveUser(baseUser, http.StatusOK)
  7758. assert.NoError(t, err)
  7759. err = os.RemoveAll(user.GetHomeDir())
  7760. assert.NoError(t, err)
  7761. err = os.RemoveAll(baseUser.GetHomeDir())
  7762. assert.NoError(t, err)
  7763. err = os.RemoveAll(mappedPathCrypt)
  7764. assert.NoError(t, err)
  7765. err = os.RemoveAll(mappedPathLocal)
  7766. assert.NoError(t, err)
  7767. }
  7768. func TestCopyAndRemoveSSHCommands(t *testing.T) {
  7769. u := getTestUser()
  7770. u.QuotaFiles = 1000
  7771. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  7772. assert.NoError(t, err)
  7773. conn, client, err := getSftpClient(user)
  7774. if assert.NoError(t, err) {
  7775. defer conn.Close()
  7776. defer client.Close()
  7777. fileSize := int64(32)
  7778. err = writeSFTPFile(testFileName, fileSize, client)
  7779. assert.NoError(t, err)
  7780. testFileNameCopy := testFileName + "_copy"
  7781. out, err := runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", testFileName, testFileNameCopy), user)
  7782. assert.NoError(t, err, string(out))
  7783. // the resolved destination path match the source path
  7784. out, err = runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", testFileName, path.Dir(testFileName)), user)
  7785. assert.Error(t, err, string(out))
  7786. info, err := client.Stat(testFileNameCopy)
  7787. if assert.NoError(t, err) {
  7788. assert.Equal(t, fileSize, info.Size())
  7789. }
  7790. testDir := "test dir"
  7791. err = client.Mkdir(testDir)
  7792. assert.NoError(t, err)
  7793. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s '%s'`, testFileName, testDir), user)
  7794. assert.NoError(t, err, string(out))
  7795. info, err = client.Stat(path.Join(testDir, testFileName))
  7796. if assert.NoError(t, err) {
  7797. assert.Equal(t, fileSize, info.Size())
  7798. }
  7799. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  7800. assert.NoError(t, err)
  7801. assert.Equal(t, 3*fileSize, user.UsedQuotaSize)
  7802. assert.Equal(t, 3, user.UsedQuotaFiles)
  7803. out, err = runSSHCommand(fmt.Sprintf("sftpgo-remove %s", testFileNameCopy), user)
  7804. assert.NoError(t, err, string(out))
  7805. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-remove '%s'`, testDir), user)
  7806. assert.NoError(t, err, string(out))
  7807. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  7808. assert.NoError(t, err)
  7809. assert.Equal(t, fileSize, user.UsedQuotaSize)
  7810. assert.Equal(t, 1, user.UsedQuotaFiles)
  7811. _, err = client.Stat(testFileNameCopy)
  7812. assert.ErrorIs(t, err, os.ErrNotExist)
  7813. // create a dir tree
  7814. dir1 := "dir1"
  7815. dir2 := "dir 2"
  7816. err = client.MkdirAll(path.Join(dir1, dir2))
  7817. assert.NoError(t, err)
  7818. toCreate := []string{
  7819. path.Join(dir1, testFileName),
  7820. path.Join(dir1, dir2, testFileName),
  7821. }
  7822. for _, p := range toCreate {
  7823. err = writeSFTPFile(p, fileSize, client)
  7824. assert.NoError(t, err)
  7825. }
  7826. // create a symlink, copying a symlink is not supported
  7827. err = client.Symlink(path.Join("/", dir1, testFileName), path.Join("/", dir1, testFileName+"_link"))
  7828. assert.NoError(t, err)
  7829. out, err = runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", path.Join("/", dir1, testFileName+"_link"),
  7830. path.Join("/", testFileName+"_link")), user)
  7831. assert.Error(t, err, string(out))
  7832. // copying a dir inside itself should fail
  7833. out, err = runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", path.Join("/", dir1),
  7834. path.Join("/", dir1, "sub")), user)
  7835. assert.Error(t, err, string(out))
  7836. // copy source and dest must differ
  7837. out, err = runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", path.Join("/", dir1),
  7838. path.Join("/", dir1)), user)
  7839. assert.Error(t, err, string(out))
  7840. // copy a missing file/dir should fail
  7841. out, err = runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", path.Join("/", "missing_entry"),
  7842. path.Join("/", dir1)), user)
  7843. assert.Error(t, err, string(out))
  7844. // try to overwrite a file with a dir
  7845. out, err = runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", path.Join("/", dir1), testFileName), user)
  7846. assert.Error(t, err, string(out))
  7847. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s "%s"`, dir1, dir2), user)
  7848. assert.NoError(t, err, string(out))
  7849. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  7850. assert.NoError(t, err)
  7851. assert.Equal(t, 5*fileSize, user.UsedQuotaSize)
  7852. assert.Equal(t, 5, user.UsedQuotaFiles)
  7853. // copy again, quota must remain unchanged
  7854. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s/ "%s"`, dir1, dir2), user)
  7855. assert.NoError(t, err, string(out))
  7856. _, err = client.Stat(dir2)
  7857. assert.NoError(t, err)
  7858. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  7859. assert.NoError(t, err)
  7860. assert.Equal(t, 5*fileSize, user.UsedQuotaSize)
  7861. assert.Equal(t, 5, user.UsedQuotaFiles)
  7862. // now copy inside target
  7863. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s "%s"`, dir1, dir2), user)
  7864. assert.NoError(t, err, string(out))
  7865. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  7866. assert.NoError(t, err)
  7867. assert.Equal(t, 7*fileSize, user.UsedQuotaSize)
  7868. assert.Equal(t, 7, user.UsedQuotaFiles)
  7869. for _, p := range []string{dir1, dir2} {
  7870. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-remove "%s"`, p), user)
  7871. assert.NoError(t, err, string(out))
  7872. _, err = client.Stat(p)
  7873. assert.ErrorIs(t, err, os.ErrNotExist)
  7874. }
  7875. user, _, err = httpdtest.GetUserByUsername(user.Username, http.StatusOK)
  7876. assert.NoError(t, err)
  7877. assert.Equal(t, fileSize, user.UsedQuotaSize)
  7878. assert.Equal(t, 1, user.UsedQuotaFiles)
  7879. // test quota errors
  7880. user.QuotaFiles = 1
  7881. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  7882. assert.NoError(t, err)
  7883. // quota files exceeded
  7884. out, err = runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", testFileName, testFileNameCopy), user)
  7885. assert.Error(t, err, string(out))
  7886. user.QuotaFiles = 1000
  7887. user.QuotaSize = fileSize + 1
  7888. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  7889. assert.NoError(t, err)
  7890. // quota size exceeded after the copy
  7891. out, err = runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", testFileName, testFileNameCopy), user)
  7892. assert.Error(t, err, string(out))
  7893. user.QuotaSize = fileSize - 1
  7894. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  7895. assert.NoError(t, err)
  7896. // quota size exceeded
  7897. out, err = runSSHCommand(fmt.Sprintf("sftpgo-copy %s %s", testFileName, testFileNameCopy), user)
  7898. assert.Error(t, err, string(out))
  7899. }
  7900. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7901. assert.NoError(t, err)
  7902. err = os.RemoveAll(user.GetHomeDir())
  7903. assert.NoError(t, err)
  7904. }
  7905. func TestCopyAndRemovePermissions(t *testing.T) {
  7906. u := getTestUser()
  7907. restrictedPath := "/dir/path"
  7908. patternFilterPath := "/patterns"
  7909. u.Filters.FilePatterns = []sdk.PatternsFilter{
  7910. {
  7911. Path: patternFilterPath,
  7912. DeniedPatterns: []string{"*.dat"},
  7913. },
  7914. }
  7915. u.Permissions[restrictedPath] = []string{}
  7916. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  7917. assert.NoError(t, err)
  7918. conn, client, err := getSftpClient(user)
  7919. if assert.NoError(t, err) {
  7920. defer conn.Close()
  7921. defer client.Close()
  7922. err = client.MkdirAll(restrictedPath)
  7923. assert.NoError(t, err)
  7924. err = client.MkdirAll(patternFilterPath)
  7925. assert.NoError(t, err)
  7926. err = writeSFTPFile(testFileName, 100, client)
  7927. assert.NoError(t, err)
  7928. // getting file writer will fail
  7929. out, err := runSSHCommand(fmt.Sprintf(`sftpgo-copy %s %s`, testFileName, restrictedPath), user)
  7930. assert.Error(t, err, string(out))
  7931. // file pattern not allowed
  7932. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s %s`, testFileName, patternFilterPath), user)
  7933. assert.Error(t, err, string(out))
  7934. testDir := path.Join("/", path.Base(restrictedPath))
  7935. err = client.Mkdir(testDir)
  7936. assert.NoError(t, err)
  7937. err = writeSFTPFile(path.Join(testDir, testFileName), 100, client)
  7938. assert.NoError(t, err)
  7939. // creating target dir will fail
  7940. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s %s/`, testDir, restrictedPath), user)
  7941. assert.Error(t, err, string(out))
  7942. // get dir contents will fail
  7943. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s /`, restrictedPath), user)
  7944. assert.Error(t, err, string(out))
  7945. // get dir contents will fail
  7946. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-remove %s`, restrictedPath), user)
  7947. assert.Error(t, err, string(out))
  7948. // give list dir permissions and retry, now delete will fail
  7949. user.Permissions[restrictedPath] = []string{dataprovider.PermListItems, dataprovider.PermUpload}
  7950. user.Permissions[testDir] = []string{dataprovider.PermListItems}
  7951. _, _, err = httpdtest.UpdateUser(user, http.StatusOK, "")
  7952. assert.NoError(t, err)
  7953. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s %s`, testFileName, restrictedPath), user)
  7954. assert.NoError(t, err, string(out))
  7955. // overwrite will fail, no permission
  7956. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s %s`, testFileName, restrictedPath), user)
  7957. assert.Error(t, err, string(out))
  7958. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-remove %s`, restrictedPath), user)
  7959. assert.Error(t, err, string(out))
  7960. // try to copy a file from testDir, we have only list permissions so getFileReader will fail
  7961. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s %s`, path.Join(testDir, testFileName), testFileName+".copy"), user)
  7962. assert.Error(t, err, string(out))
  7963. }
  7964. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  7965. assert.NoError(t, err)
  7966. err = os.RemoveAll(user.GetHomeDir())
  7967. assert.NoError(t, err)
  7968. }
  7969. func TestCrossFoldersCopy(t *testing.T) {
  7970. baseUser, resp, err := httpdtest.AddUser(getTestUser(), http.StatusCreated)
  7971. assert.NoError(t, err, string(resp))
  7972. u := getTestUser()
  7973. u.Username += "_1"
  7974. u.HomeDir = filepath.Join(os.TempDir(), u.Username)
  7975. u.QuotaFiles = 1000
  7976. mappedPath1 := filepath.Join(os.TempDir(), "mapped1")
  7977. folderName1 := filepath.Base(mappedPath1)
  7978. vpath1 := "/vdirs/vdir1"
  7979. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  7980. BaseVirtualFolder: vfs.BaseVirtualFolder{
  7981. Name: folderName1,
  7982. },
  7983. VirtualPath: vpath1,
  7984. QuotaSize: -1,
  7985. QuotaFiles: -1,
  7986. })
  7987. mappedPath2 := filepath.Join(os.TempDir(), "mapped1", "dir", "mapped2")
  7988. folderName2 := filepath.Base(mappedPath2)
  7989. vpath2 := "/vdirs/vdir2"
  7990. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  7991. BaseVirtualFolder: vfs.BaseVirtualFolder{
  7992. Name: folderName2,
  7993. },
  7994. VirtualPath: vpath2,
  7995. QuotaSize: -1,
  7996. QuotaFiles: -1,
  7997. })
  7998. mappedPath3 := filepath.Join(os.TempDir(), "mapped3")
  7999. folderName3 := filepath.Base(mappedPath3)
  8000. vpath3 := "/vdirs/vdir3"
  8001. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  8002. BaseVirtualFolder: vfs.BaseVirtualFolder{
  8003. Name: folderName3,
  8004. },
  8005. VirtualPath: vpath3,
  8006. QuotaSize: -1,
  8007. QuotaFiles: -1,
  8008. })
  8009. mappedPath4 := filepath.Join(os.TempDir(), "mapped4")
  8010. folderName4 := filepath.Base(mappedPath4)
  8011. vpath4 := "/vdirs/vdir4"
  8012. u.VirtualFolders = append(u.VirtualFolders, vfs.VirtualFolder{
  8013. BaseVirtualFolder: vfs.BaseVirtualFolder{
  8014. Name: folderName4,
  8015. },
  8016. VirtualPath: vpath4,
  8017. QuotaSize: -1,
  8018. QuotaFiles: -1,
  8019. })
  8020. f1 := vfs.BaseVirtualFolder{
  8021. Name: folderName1,
  8022. MappedPath: mappedPath1,
  8023. }
  8024. _, _, err = httpdtest.AddFolder(f1, http.StatusCreated)
  8025. assert.NoError(t, err)
  8026. f2 := vfs.BaseVirtualFolder{
  8027. Name: folderName2,
  8028. MappedPath: mappedPath2,
  8029. }
  8030. _, _, err = httpdtest.AddFolder(f2, http.StatusCreated)
  8031. assert.NoError(t, err)
  8032. f3 := vfs.BaseVirtualFolder{
  8033. Name: folderName3,
  8034. MappedPath: mappedPath3,
  8035. FsConfig: vfs.Filesystem{
  8036. Provider: sdk.CryptedFilesystemProvider,
  8037. CryptConfig: vfs.CryptFsConfig{
  8038. Passphrase: kms.NewPlainSecret(defaultPassword),
  8039. },
  8040. },
  8041. }
  8042. _, _, err = httpdtest.AddFolder(f3, http.StatusCreated)
  8043. assert.NoError(t, err)
  8044. f4 := vfs.BaseVirtualFolder{
  8045. Name: folderName4,
  8046. MappedPath: mappedPath4,
  8047. FsConfig: vfs.Filesystem{
  8048. Provider: sdk.SFTPFilesystemProvider,
  8049. SFTPConfig: vfs.SFTPFsConfig{
  8050. BaseSFTPFsConfig: sdk.BaseSFTPFsConfig{
  8051. Endpoint: sftpServerAddr,
  8052. Username: baseUser.Username,
  8053. },
  8054. Password: kms.NewPlainSecret(defaultPassword),
  8055. },
  8056. },
  8057. }
  8058. _, _, err = httpdtest.AddFolder(f4, http.StatusCreated)
  8059. assert.NoError(t, err)
  8060. user, resp, err := httpdtest.AddUser(u, http.StatusCreated)
  8061. assert.NoError(t, err, string(resp))
  8062. conn, client, err := getSftpClient(user)
  8063. if assert.NoError(t, err) {
  8064. defer conn.Close()
  8065. defer client.Close()
  8066. baseFileSize := int64(100)
  8067. err = writeSFTPFile(path.Join(vpath1, testFileName), baseFileSize+1, client)
  8068. assert.NoError(t, err)
  8069. err = writeSFTPFile(path.Join(vpath2, testFileName), baseFileSize+2, client)
  8070. assert.NoError(t, err)
  8071. err = writeSFTPFile(path.Join(vpath3, testFileName), baseFileSize+3, client)
  8072. assert.NoError(t, err)
  8073. err = writeSFTPFile(path.Join(vpath4, testFileName), baseFileSize+4, client)
  8074. assert.NoError(t, err)
  8075. // cannot remove a directory with virtual folders inside
  8076. out, err := runSSHCommand(fmt.Sprintf(`sftpgo-remove %s`, path.Dir(vpath1)), user)
  8077. assert.Error(t, err, string(out))
  8078. // copy across virtual folders
  8079. copyDir := "/copy"
  8080. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s %s/`, path.Dir(vpath1), copyDir), user)
  8081. assert.NoError(t, err, string(out))
  8082. // check the copy
  8083. info, err := client.Stat(path.Join(copyDir, vpath1, testFileName))
  8084. if assert.NoError(t, err) {
  8085. assert.Equal(t, baseFileSize+1, info.Size())
  8086. }
  8087. info, err = client.Stat(path.Join(copyDir, vpath2, testFileName))
  8088. if assert.NoError(t, err) {
  8089. assert.Equal(t, baseFileSize+2, info.Size())
  8090. }
  8091. info, err = client.Stat(path.Join(copyDir, vpath3, testFileName))
  8092. if assert.NoError(t, err) {
  8093. assert.Equal(t, baseFileSize+3, info.Size())
  8094. }
  8095. info, err = client.Stat(path.Join(copyDir, vpath4, testFileName))
  8096. if assert.NoError(t, err) {
  8097. assert.Equal(t, baseFileSize+4, info.Size())
  8098. }
  8099. // nested fs paths
  8100. out, err = runSSHCommand(fmt.Sprintf(`sftpgo-copy %s %s`, vpath1, vpath2), user)
  8101. assert.Error(t, err, string(out))
  8102. }
  8103. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  8104. assert.NoError(t, err)
  8105. err = os.RemoveAll(user.GetHomeDir())
  8106. assert.NoError(t, err)
  8107. _, err = httpdtest.RemoveUser(baseUser, http.StatusOK)
  8108. assert.NoError(t, err)
  8109. err = os.RemoveAll(baseUser.GetHomeDir())
  8110. assert.NoError(t, err)
  8111. for _, folderName := range []string{folderName1, folderName2, folderName3, folderName4} {
  8112. _, err = httpdtest.RemoveFolder(vfs.BaseVirtualFolder{Name: folderName}, http.StatusOK)
  8113. assert.NoError(t, err)
  8114. err = os.RemoveAll(filepath.Join(os.TempDir(), folderName))
  8115. assert.NoError(t, err)
  8116. }
  8117. }
  8118. func TestHTTPFs(t *testing.T) {
  8119. u := getTestUserWithHTTPFs()
  8120. user, _, err := httpdtest.AddUser(u, http.StatusCreated)
  8121. assert.NoError(t, err)
  8122. err = os.MkdirAll(user.GetHomeDir(), os.ModePerm)
  8123. assert.NoError(t, err)
  8124. conn := common.NewBaseConnection(xid.New().String(), common.ProtocolFTP, "", "", user)
  8125. err = conn.CreateDir(httpFsWellKnowDir, false)
  8126. assert.NoError(t, err)
  8127. err = os.WriteFile(filepath.Join(os.TempDir(), "httpfs", defaultHTTPFsUsername, httpFsWellKnowDir, "file.txt"), []byte("data"), 0666)
  8128. assert.NoError(t, err)
  8129. err = conn.Copy(httpFsWellKnowDir, httpFsWellKnowDir+"_copy")
  8130. assert.NoError(t, err)
  8131. _, err = httpdtest.RemoveUser(user, http.StatusOK)
  8132. assert.NoError(t, err)
  8133. err = os.RemoveAll(user.GetHomeDir())
  8134. assert.NoError(t, err)
  8135. }
  8136. func TestProxyProtocol(t *testing.T) {
  8137. resp, err := httpclient.Get(fmt.Sprintf("http://%v", httpProxyAddr))
  8138. if assert.NoError(t, err) {
  8139. defer resp.Body.Close()
  8140. assert.Equal(t, http.StatusBadRequest, resp.StatusCode)
  8141. }
  8142. }
  8143. func TestSetProtocol(t *testing.T) {
  8144. conn := common.NewBaseConnection("id", "sshd_exec", "", "", dataprovider.User{BaseUser: sdk.BaseUser{HomeDir: os.TempDir()}})
  8145. conn.SetProtocol(common.ProtocolSCP)
  8146. require.Equal(t, "SCP_id", conn.GetID())
  8147. }
  8148. func TestGetFsError(t *testing.T) {
  8149. u := getTestUser()
  8150. u.FsConfig.Provider = sdk.GCSFilesystemProvider
  8151. u.FsConfig.GCSConfig.Bucket = "test"
  8152. u.FsConfig.GCSConfig.Credentials = kms.NewPlainSecret("invalid JSON for credentials")
  8153. conn := common.NewBaseConnection("", common.ProtocolFTP, "", "", u)
  8154. _, _, err := conn.GetFsAndResolvedPath("/vpath")
  8155. assert.Error(t, err)
  8156. }
  8157. func waitTCPListening(address string) {
  8158. for {
  8159. conn, err := net.Dial("tcp", address)
  8160. if err != nil {
  8161. logger.WarnToConsole("tcp server %v not listening: %v", address, err)
  8162. time.Sleep(100 * time.Millisecond)
  8163. continue
  8164. }
  8165. logger.InfoToConsole("tcp server %v now listening", address)
  8166. conn.Close()
  8167. break
  8168. }
  8169. }
  8170. func checkBasicSFTP(client *sftp.Client) error {
  8171. _, err := client.Getwd()
  8172. if err != nil {
  8173. return err
  8174. }
  8175. _, err = client.ReadDir(".")
  8176. return err
  8177. }
  8178. func getCustomAuthSftpClient(user dataprovider.User, authMethods []ssh.AuthMethod) (*ssh.Client, *sftp.Client, error) {
  8179. var sftpClient *sftp.Client
  8180. config := &ssh.ClientConfig{
  8181. User: user.Username,
  8182. HostKeyCallback: func(hostname string, remote net.Addr, key ssh.PublicKey) error {
  8183. return nil
  8184. },
  8185. Auth: authMethods,
  8186. Timeout: 5 * time.Second,
  8187. }
  8188. conn, err := ssh.Dial("tcp", sftpServerAddr, config)
  8189. if err != nil {
  8190. return conn, sftpClient, err
  8191. }
  8192. sftpClient, err = sftp.NewClient(conn)
  8193. if err != nil {
  8194. conn.Close()
  8195. }
  8196. return conn, sftpClient, err
  8197. }
  8198. func getSftpClient(user dataprovider.User) (*ssh.Client, *sftp.Client, error) {
  8199. var sftpClient *sftp.Client
  8200. config := &ssh.ClientConfig{
  8201. User: user.Username,
  8202. HostKeyCallback: func(hostname string, remote net.Addr, key ssh.PublicKey) error {
  8203. return nil
  8204. },
  8205. Timeout: 5 * time.Second,
  8206. }
  8207. if user.Password != "" {
  8208. config.Auth = []ssh.AuthMethod{ssh.Password(user.Password)}
  8209. } else {
  8210. config.Auth = []ssh.AuthMethod{ssh.Password(defaultPassword)}
  8211. }
  8212. conn, err := ssh.Dial("tcp", sftpServerAddr, config)
  8213. if err != nil {
  8214. return conn, sftpClient, err
  8215. }
  8216. sftpClient, err = sftp.NewClient(conn)
  8217. if err != nil {
  8218. conn.Close()
  8219. }
  8220. return conn, sftpClient, err
  8221. }
  8222. func runSSHCommand(command string, user dataprovider.User) ([]byte, error) {
  8223. var sshSession *ssh.Session
  8224. var output []byte
  8225. config := &ssh.ClientConfig{
  8226. User: user.Username,
  8227. HostKeyCallback: func(hostname string, remote net.Addr, key ssh.PublicKey) error {
  8228. return nil
  8229. },
  8230. Timeout: 5 * time.Second,
  8231. }
  8232. if user.Password != "" {
  8233. config.Auth = []ssh.AuthMethod{ssh.Password(user.Password)}
  8234. } else {
  8235. config.Auth = []ssh.AuthMethod{ssh.Password(defaultPassword)}
  8236. }
  8237. conn, err := ssh.Dial("tcp", sftpServerAddr, config)
  8238. if err != nil {
  8239. return output, err
  8240. }
  8241. defer conn.Close()
  8242. sshSession, err = conn.NewSession()
  8243. if err != nil {
  8244. return output, err
  8245. }
  8246. var stdout, stderr bytes.Buffer
  8247. sshSession.Stdout = &stdout
  8248. sshSession.Stderr = &stderr
  8249. err = sshSession.Run(command)
  8250. if err != nil {
  8251. return nil, fmt.Errorf("failed to run command %v: %v", command, stderr.Bytes())
  8252. }
  8253. return stdout.Bytes(), err
  8254. }
  8255. func getWebDavClient(user dataprovider.User) *gowebdav.Client {
  8256. rootPath := fmt.Sprintf("http://localhost:%d/", webDavServerPort)
  8257. pwd := defaultPassword
  8258. if user.Password != "" {
  8259. pwd = user.Password
  8260. }
  8261. client := gowebdav.NewClient(rootPath, user.Username, pwd)
  8262. client.SetTimeout(10 * time.Second)
  8263. return client
  8264. }
  8265. func getTestUser() dataprovider.User {
  8266. user := dataprovider.User{
  8267. BaseUser: sdk.BaseUser{
  8268. Username: defaultUsername,
  8269. Password: defaultPassword,
  8270. HomeDir: filepath.Join(homeBasePath, defaultUsername),
  8271. Status: 1,
  8272. ExpirationDate: 0,
  8273. },
  8274. }
  8275. user.Permissions = make(map[string][]string)
  8276. user.Permissions["/"] = allPerms
  8277. return user
  8278. }
  8279. func getTestSFTPUser() dataprovider.User {
  8280. u := getTestUser()
  8281. u.Username = defaultSFTPUsername
  8282. u.FsConfig.Provider = sdk.SFTPFilesystemProvider
  8283. u.FsConfig.SFTPConfig.Endpoint = sftpServerAddr
  8284. u.FsConfig.SFTPConfig.Username = defaultUsername
  8285. u.FsConfig.SFTPConfig.Password = kms.NewPlainSecret(defaultPassword)
  8286. return u
  8287. }
  8288. func getCryptFsUser() dataprovider.User {
  8289. u := getTestUser()
  8290. u.Username += "_crypt"
  8291. u.FsConfig.Provider = sdk.CryptedFilesystemProvider
  8292. u.FsConfig.CryptConfig.Passphrase = kms.NewPlainSecret(defaultPassword)
  8293. return u
  8294. }
  8295. func getTestUserWithHTTPFs() dataprovider.User {
  8296. u := getTestUser()
  8297. u.FsConfig.Provider = sdk.HTTPFilesystemProvider
  8298. u.FsConfig.HTTPConfig = vfs.HTTPFsConfig{
  8299. BaseHTTPFsConfig: sdk.BaseHTTPFsConfig{
  8300. Endpoint: fmt.Sprintf("http://127.0.0.1:%d/api/v1", httpFsPort),
  8301. Username: defaultHTTPFsUsername,
  8302. },
  8303. }
  8304. return u
  8305. }
  8306. func writeSFTPFile(name string, size int64, client *sftp.Client) error {
  8307. err := writeSFTPFileNoCheck(name, size, client)
  8308. if err != nil {
  8309. return err
  8310. }
  8311. info, err := client.Stat(name)
  8312. if err != nil {
  8313. return err
  8314. }
  8315. if info.Size() != size {
  8316. return fmt.Errorf("file size mismatch, wanted %v, actual %v", size, info.Size())
  8317. }
  8318. return nil
  8319. }
  8320. func writeSFTPFileNoCheck(name string, size int64, client *sftp.Client) error {
  8321. content := make([]byte, size)
  8322. _, err := rand.Read(content)
  8323. if err != nil {
  8324. return err
  8325. }
  8326. f, err := client.Create(name)
  8327. if err != nil {
  8328. return err
  8329. }
  8330. _, err = io.Copy(f, bytes.NewBuffer(content))
  8331. if err != nil {
  8332. f.Close()
  8333. return err
  8334. }
  8335. return f.Close()
  8336. }
  8337. func getUploadScriptContent(movedPath, logFilePath string, exitStatus int) []byte {
  8338. content := []byte("#!/bin/sh\n\n")
  8339. content = append(content, []byte("sleep 1\n")...)
  8340. if logFilePath != "" {
  8341. content = append(content, []byte(fmt.Sprintf("echo $@ > %v\n", logFilePath))...)
  8342. }
  8343. content = append(content, []byte(fmt.Sprintf("mv ${SFTPGO_ACTION_PATH} %v\n", movedPath))...)
  8344. content = append(content, []byte(fmt.Sprintf("exit %d", exitStatus))...)
  8345. return content
  8346. }
  8347. func getSaveProviderObjectScriptContent(outFilePath string, exitStatus int) []byte {
  8348. content := []byte("#!/bin/sh\n\n")
  8349. content = append(content, []byte(fmt.Sprintf("echo ${SFTPGO_OBJECT_DATA} > %v\n", outFilePath))...)
  8350. content = append(content, []byte(fmt.Sprintf("exit %d", exitStatus))...)
  8351. return content
  8352. }
  8353. func generateTOTPPasscode(secret string, algo otp.Algorithm) (string, error) {
  8354. return totp.GenerateCodeCustom(secret, time.Now(), totp.ValidateOpts{
  8355. Period: 30,
  8356. Skew: 1,
  8357. Digits: otp.DigitsSix,
  8358. Algorithm: algo,
  8359. })
  8360. }
  8361. func isDbDefenderSupported() bool {
  8362. // SQLite shares the implementation with other SQL-based provider but it makes no sense
  8363. // to use it outside test cases
  8364. switch dataprovider.GetProviderStatus().Driver {
  8365. case dataprovider.MySQLDataProviderName, dataprovider.PGSQLDataProviderName,
  8366. dataprovider.CockroachDataProviderName, dataprovider.SQLiteDataProviderName:
  8367. return true
  8368. default:
  8369. return false
  8370. }
  8371. }
  8372. func getEncryptedFileSize(size int64) (int64, error) {
  8373. encSize, err := sio.EncryptedSize(uint64(size))
  8374. return int64(encSize) + 33, err
  8375. }
  8376. func printLatestLogs(maxNumberOfLines int) {
  8377. var lines []string
  8378. f, err := os.Open(logFilePath)
  8379. if err != nil {
  8380. return
  8381. }
  8382. defer f.Close()
  8383. scanner := bufio.NewScanner(f)
  8384. for scanner.Scan() {
  8385. lines = append(lines, scanner.Text()+"\r\n")
  8386. for len(lines) > maxNumberOfLines {
  8387. lines = lines[1:]
  8388. }
  8389. }
  8390. if scanner.Err() != nil {
  8391. logger.WarnToConsole("Unable to print latest logs: %v", scanner.Err())
  8392. return
  8393. }
  8394. for _, line := range lines {
  8395. logger.DebugToConsole(line)
  8396. }
  8397. }
  8398. type receivedEmail struct {
  8399. sync.RWMutex
  8400. From string
  8401. To []string
  8402. Data string
  8403. }
  8404. func (e *receivedEmail) set(from string, to []string, data []byte) {
  8405. e.Lock()
  8406. defer e.Unlock()
  8407. e.From = from
  8408. e.To = to
  8409. e.Data = strings.ReplaceAll(string(data), "=\r\n", "")
  8410. }
  8411. func (e *receivedEmail) reset() {
  8412. e.Lock()
  8413. defer e.Unlock()
  8414. e.From = ""
  8415. e.To = nil
  8416. e.Data = ""
  8417. }
  8418. func (e *receivedEmail) get() receivedEmail {
  8419. e.RLock()
  8420. defer e.RUnlock()
  8421. return receivedEmail{
  8422. From: e.From,
  8423. To: e.To,
  8424. Data: e.Data,
  8425. }
  8426. }
  8427. func startHTTPFs() {
  8428. go func() {
  8429. readdirCallback := func(name string) []os.FileInfo {
  8430. if name == httpFsWellKnowDir {
  8431. return []os.FileInfo{vfs.NewFileInfo("ghost.txt", false, 0, time.Unix(0, 0), false)}
  8432. }
  8433. return nil
  8434. }
  8435. callbacks := &httpdtest.HTTPFsCallbacks{
  8436. Readdir: readdirCallback,
  8437. }
  8438. if err := httpdtest.StartTestHTTPFs(httpFsPort, callbacks); err != nil {
  8439. logger.ErrorToConsole("could not start HTTPfs test server: %v", err)
  8440. os.Exit(1)
  8441. }
  8442. }()
  8443. waitTCPListening(fmt.Sprintf(":%d", httpFsPort))
  8444. }