eventmanager_test.go 62 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158
  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
  15. import (
  16. "bytes"
  17. "crypto/rand"
  18. "errors"
  19. "fmt"
  20. "io"
  21. "mime/multipart"
  22. "net/http"
  23. "net/url"
  24. "os"
  25. "path"
  26. "path/filepath"
  27. "runtime"
  28. "strings"
  29. "testing"
  30. "time"
  31. "github.com/klauspost/compress/zip"
  32. "github.com/rs/xid"
  33. "github.com/sftpgo/sdk"
  34. sdkkms "github.com/sftpgo/sdk/kms"
  35. "github.com/stretchr/testify/assert"
  36. "github.com/stretchr/testify/require"
  37. "github.com/drakkan/sftpgo/v2/internal/dataprovider"
  38. "github.com/drakkan/sftpgo/v2/internal/kms"
  39. "github.com/drakkan/sftpgo/v2/internal/util"
  40. "github.com/drakkan/sftpgo/v2/internal/vfs"
  41. )
  42. func TestEventRuleMatch(t *testing.T) {
  43. role := "role1"
  44. conditions := &dataprovider.EventConditions{
  45. ProviderEvents: []string{"add", "update"},
  46. Options: dataprovider.ConditionOptions{
  47. Names: []dataprovider.ConditionPattern{
  48. {
  49. Pattern: "user1",
  50. InverseMatch: true,
  51. },
  52. },
  53. RoleNames: []dataprovider.ConditionPattern{
  54. {
  55. Pattern: role,
  56. },
  57. },
  58. },
  59. }
  60. res := eventManager.checkProviderEventMatch(conditions, &EventParams{
  61. Name: "user1",
  62. Role: role,
  63. Event: "add",
  64. })
  65. assert.False(t, res)
  66. res = eventManager.checkProviderEventMatch(conditions, &EventParams{
  67. Name: "user2",
  68. Role: role,
  69. Event: "update",
  70. })
  71. assert.True(t, res)
  72. res = eventManager.checkProviderEventMatch(conditions, &EventParams{
  73. Name: "user2",
  74. Role: role,
  75. Event: "delete",
  76. })
  77. assert.False(t, res)
  78. conditions.Options.ProviderObjects = []string{"api_key"}
  79. res = eventManager.checkProviderEventMatch(conditions, &EventParams{
  80. Name: "user2",
  81. Event: "update",
  82. Role: role,
  83. ObjectType: "share",
  84. })
  85. assert.False(t, res)
  86. res = eventManager.checkProviderEventMatch(conditions, &EventParams{
  87. Name: "user2",
  88. Event: "update",
  89. Role: role,
  90. ObjectType: "api_key",
  91. })
  92. assert.True(t, res)
  93. res = eventManager.checkProviderEventMatch(conditions, &EventParams{
  94. Name: "user2",
  95. Event: "update",
  96. Role: role + "1",
  97. ObjectType: "api_key",
  98. })
  99. assert.False(t, res)
  100. // now test fs events
  101. conditions = &dataprovider.EventConditions{
  102. FsEvents: []string{operationUpload, operationDownload},
  103. Options: dataprovider.ConditionOptions{
  104. Names: []dataprovider.ConditionPattern{
  105. {
  106. Pattern: "user*",
  107. },
  108. {
  109. Pattern: "tester*",
  110. },
  111. },
  112. RoleNames: []dataprovider.ConditionPattern{
  113. {
  114. Pattern: role,
  115. InverseMatch: true,
  116. },
  117. },
  118. FsPaths: []dataprovider.ConditionPattern{
  119. {
  120. Pattern: "/**/*.txt",
  121. },
  122. },
  123. Protocols: []string{ProtocolSFTP},
  124. MinFileSize: 10,
  125. MaxFileSize: 30,
  126. },
  127. }
  128. params := EventParams{
  129. Name: "tester4",
  130. Event: operationDelete,
  131. VirtualPath: "/path.txt",
  132. Protocol: ProtocolSFTP,
  133. ObjectName: "path.txt",
  134. FileSize: 20,
  135. }
  136. res = eventManager.checkFsEventMatch(conditions, &params)
  137. assert.False(t, res)
  138. params.Event = operationDownload
  139. res = eventManager.checkFsEventMatch(conditions, &params)
  140. assert.True(t, res)
  141. params.Role = role
  142. res = eventManager.checkFsEventMatch(conditions, &params)
  143. assert.False(t, res)
  144. params.Role = ""
  145. params.Name = "name"
  146. res = eventManager.checkFsEventMatch(conditions, &params)
  147. assert.False(t, res)
  148. params.Name = "user5"
  149. res = eventManager.checkFsEventMatch(conditions, &params)
  150. assert.True(t, res)
  151. params.VirtualPath = "/sub/f.jpg"
  152. params.ObjectName = path.Base(params.VirtualPath)
  153. res = eventManager.checkFsEventMatch(conditions, &params)
  154. assert.False(t, res)
  155. params.VirtualPath = "/sub/f.txt"
  156. params.ObjectName = path.Base(params.VirtualPath)
  157. res = eventManager.checkFsEventMatch(conditions, &params)
  158. assert.True(t, res)
  159. params.Protocol = ProtocolHTTP
  160. res = eventManager.checkFsEventMatch(conditions, &params)
  161. assert.False(t, res)
  162. params.Protocol = ProtocolSFTP
  163. params.FileSize = 5
  164. res = eventManager.checkFsEventMatch(conditions, &params)
  165. assert.False(t, res)
  166. params.FileSize = 50
  167. res = eventManager.checkFsEventMatch(conditions, &params)
  168. assert.False(t, res)
  169. params.FileSize = 25
  170. res = eventManager.checkFsEventMatch(conditions, &params)
  171. assert.True(t, res)
  172. // bad pattern
  173. conditions.Options.Names = []dataprovider.ConditionPattern{
  174. {
  175. Pattern: "[-]",
  176. },
  177. }
  178. res = eventManager.checkFsEventMatch(conditions, &params)
  179. assert.False(t, res)
  180. // check fs events with group name filters
  181. conditions = &dataprovider.EventConditions{
  182. FsEvents: []string{operationUpload, operationDownload},
  183. Options: dataprovider.ConditionOptions{
  184. GroupNames: []dataprovider.ConditionPattern{
  185. {
  186. Pattern: "group*",
  187. },
  188. {
  189. Pattern: "testgroup*",
  190. },
  191. },
  192. },
  193. }
  194. params = EventParams{
  195. Name: "user1",
  196. Event: operationUpload,
  197. }
  198. res = eventManager.checkFsEventMatch(conditions, &params)
  199. assert.False(t, res)
  200. params.Groups = []sdk.GroupMapping{
  201. {
  202. Name: "g1",
  203. Type: sdk.GroupTypePrimary,
  204. },
  205. {
  206. Name: "g2",
  207. Type: sdk.GroupTypeSecondary,
  208. },
  209. }
  210. res = eventManager.checkFsEventMatch(conditions, &params)
  211. assert.False(t, res)
  212. params.Groups = []sdk.GroupMapping{
  213. {
  214. Name: "testgroup2",
  215. Type: sdk.GroupTypePrimary,
  216. },
  217. {
  218. Name: "g2",
  219. Type: sdk.GroupTypeSecondary,
  220. },
  221. }
  222. res = eventManager.checkFsEventMatch(conditions, &params)
  223. assert.True(t, res)
  224. // check user conditions
  225. user := dataprovider.User{}
  226. user.Username = "u1"
  227. res = checkUserConditionOptions(&user, &dataprovider.ConditionOptions{})
  228. assert.True(t, res)
  229. res = checkUserConditionOptions(&user, &dataprovider.ConditionOptions{
  230. Names: []dataprovider.ConditionPattern{
  231. {
  232. Pattern: "user",
  233. },
  234. },
  235. })
  236. assert.False(t, res)
  237. res = checkUserConditionOptions(&user, &dataprovider.ConditionOptions{
  238. RoleNames: []dataprovider.ConditionPattern{
  239. {
  240. Pattern: role,
  241. },
  242. },
  243. })
  244. assert.False(t, res)
  245. user.Role = role
  246. res = checkUserConditionOptions(&user, &dataprovider.ConditionOptions{
  247. RoleNames: []dataprovider.ConditionPattern{
  248. {
  249. Pattern: role,
  250. },
  251. },
  252. })
  253. assert.True(t, res)
  254. res = checkUserConditionOptions(&user, &dataprovider.ConditionOptions{
  255. GroupNames: []dataprovider.ConditionPattern{
  256. {
  257. Pattern: "group",
  258. },
  259. },
  260. RoleNames: []dataprovider.ConditionPattern{
  261. {
  262. Pattern: role,
  263. },
  264. },
  265. })
  266. assert.False(t, res)
  267. res = eventManager.checkIPDLoginEventMatch(&dataprovider.EventConditions{
  268. IDPLoginEvent: 0,
  269. }, &EventParams{
  270. Event: IDPLoginAdmin,
  271. })
  272. assert.True(t, res)
  273. res = eventManager.checkIPDLoginEventMatch(&dataprovider.EventConditions{
  274. IDPLoginEvent: 2,
  275. }, &EventParams{
  276. Event: IDPLoginAdmin,
  277. })
  278. assert.True(t, res)
  279. res = eventManager.checkIPDLoginEventMatch(&dataprovider.EventConditions{
  280. IDPLoginEvent: 1,
  281. }, &EventParams{
  282. Event: IDPLoginAdmin,
  283. })
  284. assert.False(t, res)
  285. res = eventManager.checkIPDLoginEventMatch(&dataprovider.EventConditions{
  286. IDPLoginEvent: 1,
  287. }, &EventParams{
  288. Event: IDPLoginUser,
  289. })
  290. assert.True(t, res)
  291. res = eventManager.checkIPDLoginEventMatch(&dataprovider.EventConditions{
  292. IDPLoginEvent: 1,
  293. }, &EventParams{
  294. Name: "user",
  295. Event: IDPLoginUser,
  296. })
  297. assert.True(t, res)
  298. res = eventManager.checkIPDLoginEventMatch(&dataprovider.EventConditions{
  299. IDPLoginEvent: 1,
  300. Options: dataprovider.ConditionOptions{
  301. Names: []dataprovider.ConditionPattern{
  302. {
  303. Pattern: "abc",
  304. },
  305. },
  306. },
  307. }, &EventParams{
  308. Name: "user",
  309. Event: IDPLoginUser,
  310. })
  311. assert.False(t, res)
  312. res = eventManager.checkIPDLoginEventMatch(&dataprovider.EventConditions{
  313. IDPLoginEvent: 2,
  314. }, &EventParams{
  315. Name: "user",
  316. Event: IDPLoginUser,
  317. })
  318. assert.False(t, res)
  319. }
  320. func TestDoubleStarMatching(t *testing.T) {
  321. c := dataprovider.ConditionPattern{
  322. Pattern: "/mydir/**",
  323. }
  324. res := checkEventConditionPattern(c, "/mydir")
  325. assert.True(t, res)
  326. res = checkEventConditionPattern(c, "/mydirname")
  327. assert.False(t, res)
  328. res = checkEventConditionPattern(c, "/mydir/sub")
  329. assert.True(t, res)
  330. res = checkEventConditionPattern(c, "/mydir/sub/dir")
  331. assert.True(t, res)
  332. c.Pattern = "/**/*"
  333. res = checkEventConditionPattern(c, "/mydir")
  334. assert.True(t, res)
  335. res = checkEventConditionPattern(c, "/mydirname")
  336. assert.True(t, res)
  337. res = checkEventConditionPattern(c, "/mydir/sub/dir/file.txt")
  338. assert.True(t, res)
  339. c.Pattern = "/mydir/**/*.txt"
  340. res = checkEventConditionPattern(c, "/mydir")
  341. assert.False(t, res)
  342. res = checkEventConditionPattern(c, "/mydirname/f.txt")
  343. assert.False(t, res)
  344. res = checkEventConditionPattern(c, "/mydir/sub")
  345. assert.False(t, res)
  346. res = checkEventConditionPattern(c, "/mydir/sub/dir")
  347. assert.False(t, res)
  348. res = checkEventConditionPattern(c, "/mydir/sub/dir/a.txt")
  349. assert.True(t, res)
  350. }
  351. func TestEventManager(t *testing.T) {
  352. startEventScheduler()
  353. action := &dataprovider.BaseEventAction{
  354. Name: "test_action",
  355. Type: dataprovider.ActionTypeHTTP,
  356. Options: dataprovider.BaseEventActionOptions{
  357. HTTPConfig: dataprovider.EventActionHTTPConfig{
  358. Endpoint: "http://localhost",
  359. Timeout: 20,
  360. Method: http.MethodGet,
  361. },
  362. },
  363. }
  364. err := dataprovider.AddEventAction(action, "", "", "")
  365. assert.NoError(t, err)
  366. rule := &dataprovider.EventRule{
  367. Name: "rule",
  368. Status: 1,
  369. Trigger: dataprovider.EventTriggerFsEvent,
  370. Conditions: dataprovider.EventConditions{
  371. FsEvents: []string{operationUpload},
  372. },
  373. Actions: []dataprovider.EventAction{
  374. {
  375. BaseEventAction: dataprovider.BaseEventAction{
  376. Name: action.Name,
  377. },
  378. Order: 1,
  379. },
  380. },
  381. }
  382. err = dataprovider.AddEventRule(rule, "", "", "")
  383. assert.NoError(t, err)
  384. eventManager.RLock()
  385. assert.Len(t, eventManager.FsEvents, 1)
  386. assert.Len(t, eventManager.ProviderEvents, 0)
  387. assert.Len(t, eventManager.Schedules, 0)
  388. assert.Len(t, eventManager.schedulesMapping, 0)
  389. eventManager.RUnlock()
  390. rule.Trigger = dataprovider.EventTriggerProviderEvent
  391. rule.Conditions = dataprovider.EventConditions{
  392. ProviderEvents: []string{"add"},
  393. }
  394. err = dataprovider.UpdateEventRule(rule, "", "", "")
  395. assert.NoError(t, err)
  396. eventManager.RLock()
  397. assert.Len(t, eventManager.FsEvents, 0)
  398. assert.Len(t, eventManager.ProviderEvents, 1)
  399. assert.Len(t, eventManager.Schedules, 0)
  400. assert.Len(t, eventManager.schedulesMapping, 0)
  401. eventManager.RUnlock()
  402. rule.Trigger = dataprovider.EventTriggerSchedule
  403. rule.Conditions = dataprovider.EventConditions{
  404. Schedules: []dataprovider.Schedule{
  405. {
  406. Hours: "0",
  407. DayOfWeek: "*",
  408. DayOfMonth: "*",
  409. Month: "*",
  410. },
  411. },
  412. }
  413. rule.DeletedAt = util.GetTimeAsMsSinceEpoch(time.Now().Add(-12 * time.Hour))
  414. eventManager.addUpdateRuleInternal(*rule)
  415. eventManager.RLock()
  416. assert.Len(t, eventManager.FsEvents, 0)
  417. assert.Len(t, eventManager.ProviderEvents, 0)
  418. assert.Len(t, eventManager.Schedules, 0)
  419. assert.Len(t, eventManager.schedulesMapping, 0)
  420. eventManager.RUnlock()
  421. assert.Eventually(t, func() bool {
  422. _, err = dataprovider.EventRuleExists(rule.Name)
  423. ok := errors.Is(err, util.ErrNotFound)
  424. return ok
  425. }, 2*time.Second, 100*time.Millisecond)
  426. rule.DeletedAt = 0
  427. err = dataprovider.AddEventRule(rule, "", "", "")
  428. assert.NoError(t, err)
  429. eventManager.RLock()
  430. assert.Len(t, eventManager.FsEvents, 0)
  431. assert.Len(t, eventManager.ProviderEvents, 0)
  432. assert.Len(t, eventManager.Schedules, 1)
  433. assert.Len(t, eventManager.schedulesMapping, 1)
  434. eventManager.RUnlock()
  435. err = dataprovider.DeleteEventRule(rule.Name, "", "", "")
  436. assert.NoError(t, err)
  437. eventManager.RLock()
  438. assert.Len(t, eventManager.FsEvents, 0)
  439. assert.Len(t, eventManager.ProviderEvents, 0)
  440. assert.Len(t, eventManager.Schedules, 0)
  441. assert.Len(t, eventManager.schedulesMapping, 0)
  442. eventManager.RUnlock()
  443. err = dataprovider.DeleteEventAction(action.Name, "", "", "")
  444. assert.NoError(t, err)
  445. stopEventScheduler()
  446. }
  447. func TestEventManagerErrors(t *testing.T) {
  448. startEventScheduler()
  449. providerConf := dataprovider.GetProviderConfig()
  450. err := dataprovider.Close()
  451. assert.NoError(t, err)
  452. params := EventParams{
  453. sender: "sender",
  454. }
  455. _, err = params.getUsers()
  456. assert.Error(t, err)
  457. _, err = params.getFolders()
  458. assert.Error(t, err)
  459. err = executeUsersQuotaResetRuleAction(dataprovider.ConditionOptions{}, &EventParams{})
  460. assert.Error(t, err)
  461. err = executeFoldersQuotaResetRuleAction(dataprovider.ConditionOptions{}, &EventParams{})
  462. assert.Error(t, err)
  463. err = executeTransferQuotaResetRuleAction(dataprovider.ConditionOptions{}, &EventParams{})
  464. assert.Error(t, err)
  465. err = executeMetadataCheckRuleAction(dataprovider.ConditionOptions{}, &EventParams{})
  466. assert.Error(t, err)
  467. err = executeUserExpirationCheckRuleAction(dataprovider.ConditionOptions{}, &EventParams{})
  468. assert.Error(t, err)
  469. err = executeDeleteFsRuleAction(nil, nil, dataprovider.ConditionOptions{}, &EventParams{})
  470. assert.Error(t, err)
  471. err = executeMkdirFsRuleAction(nil, nil, dataprovider.ConditionOptions{}, &EventParams{})
  472. assert.Error(t, err)
  473. err = executeRenameFsRuleAction(nil, nil, dataprovider.ConditionOptions{}, &EventParams{})
  474. assert.Error(t, err)
  475. err = executeExistFsRuleAction(nil, nil, dataprovider.ConditionOptions{}, &EventParams{})
  476. assert.Error(t, err)
  477. err = executeCopyFsRuleAction(nil, nil, dataprovider.ConditionOptions{}, &EventParams{})
  478. assert.Error(t, err)
  479. err = executeCompressFsRuleAction(dataprovider.EventActionFsCompress{}, nil, dataprovider.ConditionOptions{}, &EventParams{})
  480. assert.Error(t, err)
  481. err = executePwdExpirationCheckRuleAction(dataprovider.EventActionPasswordExpiration{},
  482. dataprovider.ConditionOptions{}, &EventParams{})
  483. assert.Error(t, err)
  484. _, err = executeAdminCheckAction(&dataprovider.EventActionIDPAccountCheck{}, &EventParams{})
  485. assert.Error(t, err)
  486. _, err = executeUserCheckAction(&dataprovider.EventActionIDPAccountCheck{}, &EventParams{})
  487. assert.Error(t, err)
  488. groupName := "agroup"
  489. err = executeQuotaResetForUser(&dataprovider.User{
  490. Groups: []sdk.GroupMapping{
  491. {
  492. Name: groupName,
  493. Type: sdk.GroupTypePrimary,
  494. },
  495. },
  496. })
  497. assert.Error(t, err)
  498. err = executeMetadataCheckForUser(&dataprovider.User{
  499. Groups: []sdk.GroupMapping{
  500. {
  501. Name: groupName,
  502. Type: sdk.GroupTypePrimary,
  503. },
  504. },
  505. })
  506. assert.Error(t, err)
  507. err = executeDataRetentionCheckForUser(dataprovider.User{
  508. Groups: []sdk.GroupMapping{
  509. {
  510. Name: groupName,
  511. Type: sdk.GroupTypePrimary,
  512. },
  513. },
  514. }, nil, &EventParams{}, "")
  515. assert.Error(t, err)
  516. err = executeDeleteFsActionForUser(nil, nil, dataprovider.User{
  517. Groups: []sdk.GroupMapping{
  518. {
  519. Name: groupName,
  520. Type: sdk.GroupTypePrimary,
  521. },
  522. },
  523. })
  524. assert.Error(t, err)
  525. err = executeMkDirsFsActionForUser(nil, nil, dataprovider.User{
  526. Groups: []sdk.GroupMapping{
  527. {
  528. Name: groupName,
  529. Type: sdk.GroupTypePrimary,
  530. },
  531. },
  532. })
  533. assert.Error(t, err)
  534. err = executeRenameFsActionForUser(nil, nil, dataprovider.User{
  535. Groups: []sdk.GroupMapping{
  536. {
  537. Name: groupName,
  538. Type: sdk.GroupTypePrimary,
  539. },
  540. },
  541. })
  542. assert.Error(t, err)
  543. err = executeExistFsActionForUser(nil, nil, dataprovider.User{
  544. Groups: []sdk.GroupMapping{
  545. {
  546. Name: groupName,
  547. Type: sdk.GroupTypePrimary,
  548. },
  549. },
  550. })
  551. assert.Error(t, err)
  552. err = executeCopyFsActionForUser(nil, nil, dataprovider.User{
  553. Groups: []sdk.GroupMapping{
  554. {
  555. Name: groupName,
  556. Type: sdk.GroupTypePrimary,
  557. },
  558. },
  559. })
  560. assert.Error(t, err)
  561. err = executeCompressFsActionForUser(dataprovider.EventActionFsCompress{}, nil, dataprovider.User{
  562. Groups: []sdk.GroupMapping{
  563. {
  564. Name: groupName,
  565. Type: sdk.GroupTypePrimary,
  566. },
  567. },
  568. })
  569. assert.Error(t, err)
  570. err = executePwdExpirationCheckForUser(&dataprovider.User{
  571. Groups: []sdk.GroupMapping{
  572. {
  573. Name: groupName,
  574. Type: sdk.GroupTypePrimary,
  575. },
  576. }}, dataprovider.EventActionPasswordExpiration{})
  577. assert.Error(t, err)
  578. _, _, err = getHTTPRuleActionBody(&dataprovider.EventActionHTTPConfig{
  579. Method: http.MethodPost,
  580. Parts: []dataprovider.HTTPPart{
  581. {
  582. Name: "p1",
  583. },
  584. },
  585. }, nil, nil, dataprovider.User{
  586. BaseUser: sdk.BaseUser{
  587. Username: "u",
  588. },
  589. Groups: []sdk.GroupMapping{
  590. {
  591. Name: groupName,
  592. Type: sdk.GroupTypePrimary,
  593. },
  594. },
  595. }, &EventParams{}, false)
  596. assert.Error(t, err)
  597. dataRetentionAction := dataprovider.BaseEventAction{
  598. Type: dataprovider.ActionTypeDataRetentionCheck,
  599. Options: dataprovider.BaseEventActionOptions{
  600. RetentionConfig: dataprovider.EventActionDataRetentionConfig{
  601. Folders: []dataprovider.FolderRetention{
  602. {
  603. Path: "/",
  604. Retention: 24,
  605. },
  606. },
  607. },
  608. },
  609. }
  610. err = executeRuleAction(dataRetentionAction, &EventParams{}, dataprovider.ConditionOptions{
  611. Names: []dataprovider.ConditionPattern{
  612. {
  613. Pattern: "username1",
  614. },
  615. },
  616. })
  617. if assert.Error(t, err) {
  618. assert.Contains(t, err.Error(), "unable to get users")
  619. }
  620. eventManager.loadRules()
  621. eventManager.RLock()
  622. assert.Len(t, eventManager.FsEvents, 0)
  623. assert.Len(t, eventManager.ProviderEvents, 0)
  624. assert.Len(t, eventManager.Schedules, 0)
  625. eventManager.RUnlock()
  626. // rule with invalid trigger
  627. eventManager.addUpdateRuleInternal(dataprovider.EventRule{
  628. Name: "test rule",
  629. Status: 1,
  630. Trigger: -1,
  631. })
  632. eventManager.RLock()
  633. assert.Len(t, eventManager.FsEvents, 0)
  634. assert.Len(t, eventManager.ProviderEvents, 0)
  635. assert.Len(t, eventManager.Schedules, 0)
  636. eventManager.RUnlock()
  637. // rule with invalid cronspec
  638. eventManager.addUpdateRuleInternal(dataprovider.EventRule{
  639. Name: "test rule",
  640. Status: 1,
  641. Trigger: dataprovider.EventTriggerSchedule,
  642. Conditions: dataprovider.EventConditions{
  643. Schedules: []dataprovider.Schedule{
  644. {
  645. Hours: "1000",
  646. },
  647. },
  648. },
  649. })
  650. eventManager.RLock()
  651. assert.Len(t, eventManager.FsEvents, 0)
  652. assert.Len(t, eventManager.ProviderEvents, 0)
  653. assert.Len(t, eventManager.Schedules, 0)
  654. eventManager.RUnlock()
  655. err = dataprovider.Initialize(providerConf, configDir, true)
  656. assert.NoError(t, err)
  657. stopEventScheduler()
  658. }
  659. func TestEventRuleActions(t *testing.T) {
  660. actionName := "test rule action"
  661. action := dataprovider.BaseEventAction{
  662. Name: actionName,
  663. Type: dataprovider.ActionTypeBackup,
  664. }
  665. err := executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{})
  666. assert.NoError(t, err)
  667. action.Type = -1
  668. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{})
  669. assert.Error(t, err)
  670. action = dataprovider.BaseEventAction{
  671. Name: actionName,
  672. Type: dataprovider.ActionTypeHTTP,
  673. Options: dataprovider.BaseEventActionOptions{
  674. HTTPConfig: dataprovider.EventActionHTTPConfig{
  675. Endpoint: "http://foo\x7f.com/", // invalid URL
  676. SkipTLSVerify: true,
  677. Body: "{{ObjectData}}",
  678. Method: http.MethodPost,
  679. QueryParameters: []dataprovider.KeyValue{
  680. {
  681. Key: "param",
  682. Value: "value",
  683. },
  684. },
  685. Timeout: 5,
  686. Headers: []dataprovider.KeyValue{
  687. {
  688. Key: "Content-Type",
  689. Value: "application/json",
  690. },
  691. },
  692. Username: "httpuser",
  693. },
  694. },
  695. }
  696. action.Options.SetEmptySecretsIfNil()
  697. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{})
  698. if assert.Error(t, err) {
  699. assert.Contains(t, err.Error(), "invalid endpoint")
  700. }
  701. action.Options.HTTPConfig.Endpoint = fmt.Sprintf("http://%v", httpAddr)
  702. params := &EventParams{
  703. Name: "a",
  704. Object: &dataprovider.User{
  705. BaseUser: sdk.BaseUser{
  706. Username: "test user",
  707. },
  708. },
  709. }
  710. err = executeRuleAction(action, params, dataprovider.ConditionOptions{})
  711. assert.NoError(t, err)
  712. action.Options.HTTPConfig.Method = http.MethodGet
  713. err = executeRuleAction(action, params, dataprovider.ConditionOptions{})
  714. assert.NoError(t, err)
  715. action.Options.HTTPConfig.Endpoint = fmt.Sprintf("http://%v/404", httpAddr)
  716. err = executeRuleAction(action, params, dataprovider.ConditionOptions{})
  717. if assert.Error(t, err) {
  718. assert.Contains(t, err.Error(), "unexpected status code: 404")
  719. }
  720. action.Options.HTTPConfig.Endpoint = "http://invalid:1234"
  721. err = executeRuleAction(action, params, dataprovider.ConditionOptions{})
  722. assert.Error(t, err)
  723. action.Options.HTTPConfig.QueryParameters = nil
  724. action.Options.HTTPConfig.Endpoint = "http://bar\x7f.com/"
  725. err = executeRuleAction(action, params, dataprovider.ConditionOptions{})
  726. assert.Error(t, err)
  727. action.Options.HTTPConfig.Password = kms.NewSecret(sdkkms.SecretStatusSecretBox, "payload", "key", "data")
  728. err = executeRuleAction(action, params, dataprovider.ConditionOptions{})
  729. if assert.Error(t, err) {
  730. assert.Contains(t, err.Error(), "unable to decrypt HTTP password")
  731. }
  732. action.Options.HTTPConfig.Endpoint = fmt.Sprintf("http://%v", httpAddr)
  733. action.Options.HTTPConfig.Password = kms.NewEmptySecret()
  734. action.Options.HTTPConfig.Body = ""
  735. action.Options.HTTPConfig.Parts = []dataprovider.HTTPPart{
  736. {
  737. Name: "p1",
  738. Filepath: "path",
  739. },
  740. }
  741. err = executeRuleAction(action, params, dataprovider.ConditionOptions{})
  742. assert.Contains(t, getErrorString(err), "error getting user")
  743. action.Options.HTTPConfig.Parts = nil
  744. action.Options.HTTPConfig.Body = "{{ObjectData}}"
  745. // test disk and transfer quota reset
  746. username1 := "user1"
  747. username2 := "user2"
  748. user1 := dataprovider.User{
  749. BaseUser: sdk.BaseUser{
  750. Username: username1,
  751. HomeDir: filepath.Join(os.TempDir(), username1),
  752. Status: 1,
  753. Permissions: map[string][]string{
  754. "/": {dataprovider.PermAny},
  755. },
  756. },
  757. }
  758. user2 := dataprovider.User{
  759. BaseUser: sdk.BaseUser{
  760. Username: username2,
  761. HomeDir: filepath.Join(os.TempDir(), username2),
  762. Status: 1,
  763. Permissions: map[string][]string{
  764. "/": {dataprovider.PermAny},
  765. },
  766. },
  767. }
  768. user2.Filters.PasswordExpiration = 10
  769. err = dataprovider.AddUser(&user1, "", "", "")
  770. assert.NoError(t, err)
  771. err = dataprovider.AddUser(&user2, "", "", "")
  772. assert.NoError(t, err)
  773. err = executePwdExpirationCheckRuleAction(dataprovider.EventActionPasswordExpiration{
  774. Threshold: 20,
  775. }, dataprovider.ConditionOptions{
  776. Names: []dataprovider.ConditionPattern{
  777. {
  778. Pattern: user2.Username,
  779. },
  780. },
  781. }, &EventParams{})
  782. // smtp not configured
  783. assert.Error(t, err)
  784. action = dataprovider.BaseEventAction{
  785. Type: dataprovider.ActionTypeUserQuotaReset,
  786. }
  787. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  788. Names: []dataprovider.ConditionPattern{
  789. {
  790. Pattern: username1,
  791. },
  792. },
  793. })
  794. assert.Error(t, err) // no home dir
  795. // create the home dir
  796. err = os.MkdirAll(user1.GetHomeDir(), os.ModePerm)
  797. assert.NoError(t, err)
  798. err = os.WriteFile(filepath.Join(user1.GetHomeDir(), "file.txt"), []byte("user"), 0666)
  799. assert.NoError(t, err)
  800. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  801. Names: []dataprovider.ConditionPattern{
  802. {
  803. Pattern: username1,
  804. },
  805. },
  806. })
  807. assert.NoError(t, err)
  808. userGet, err := dataprovider.UserExists(username1, "")
  809. assert.NoError(t, err)
  810. assert.Equal(t, 1, userGet.UsedQuotaFiles)
  811. assert.Equal(t, int64(4), userGet.UsedQuotaSize)
  812. // simulate another quota scan in progress
  813. assert.True(t, QuotaScans.AddUserQuotaScan(username1, ""))
  814. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  815. Names: []dataprovider.ConditionPattern{
  816. {
  817. Pattern: username1,
  818. },
  819. },
  820. })
  821. assert.Error(t, err)
  822. assert.True(t, QuotaScans.RemoveUserQuotaScan(username1))
  823. // non matching pattern
  824. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  825. Names: []dataprovider.ConditionPattern{
  826. {
  827. Pattern: "don't match",
  828. },
  829. },
  830. })
  831. assert.Error(t, err)
  832. assert.Contains(t, getErrorString(err), "no user quota reset executed")
  833. action = dataprovider.BaseEventAction{
  834. Type: dataprovider.ActionTypeMetadataCheck,
  835. }
  836. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  837. Names: []dataprovider.ConditionPattern{
  838. {
  839. Pattern: "don't match",
  840. },
  841. },
  842. })
  843. assert.Error(t, err)
  844. assert.Contains(t, getErrorString(err), "no metadata check executed")
  845. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  846. Names: []dataprovider.ConditionPattern{
  847. {
  848. Pattern: username1,
  849. },
  850. },
  851. })
  852. assert.NoError(t, err)
  853. // simulate another metadata check in progress
  854. assert.True(t, ActiveMetadataChecks.Add(username1, ""))
  855. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  856. Names: []dataprovider.ConditionPattern{
  857. {
  858. Pattern: username1,
  859. },
  860. },
  861. })
  862. assert.Error(t, err)
  863. assert.True(t, ActiveMetadataChecks.Remove(username1))
  864. action = dataprovider.BaseEventAction{
  865. Type: dataprovider.ActionTypeUserExpirationCheck,
  866. }
  867. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  868. Names: []dataprovider.ConditionPattern{
  869. {
  870. Pattern: "don't match",
  871. },
  872. },
  873. })
  874. assert.Error(t, err)
  875. assert.Contains(t, getErrorString(err), "no user expiration check executed")
  876. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  877. Names: []dataprovider.ConditionPattern{
  878. {
  879. Pattern: username1,
  880. },
  881. },
  882. })
  883. assert.NoError(t, err)
  884. dataRetentionAction := dataprovider.BaseEventAction{
  885. Type: dataprovider.ActionTypeDataRetentionCheck,
  886. Options: dataprovider.BaseEventActionOptions{
  887. RetentionConfig: dataprovider.EventActionDataRetentionConfig{
  888. Folders: []dataprovider.FolderRetention{
  889. {
  890. Path: "",
  891. Retention: 24,
  892. },
  893. },
  894. },
  895. },
  896. }
  897. err = executeRuleAction(dataRetentionAction, &EventParams{}, dataprovider.ConditionOptions{
  898. Names: []dataprovider.ConditionPattern{
  899. {
  900. Pattern: username1,
  901. },
  902. },
  903. })
  904. assert.Error(t, err) // invalid config, no folder path specified
  905. retentionDir := "testretention"
  906. dataRetentionAction = dataprovider.BaseEventAction{
  907. Type: dataprovider.ActionTypeDataRetentionCheck,
  908. Options: dataprovider.BaseEventActionOptions{
  909. RetentionConfig: dataprovider.EventActionDataRetentionConfig{
  910. Folders: []dataprovider.FolderRetention{
  911. {
  912. Path: path.Join("/", retentionDir),
  913. Retention: 24,
  914. DeleteEmptyDirs: true,
  915. },
  916. },
  917. },
  918. },
  919. }
  920. // create some test files
  921. file1 := filepath.Join(user1.GetHomeDir(), "file1.txt")
  922. file2 := filepath.Join(user1.GetHomeDir(), retentionDir, "file2.txt")
  923. file3 := filepath.Join(user1.GetHomeDir(), retentionDir, "file3.txt")
  924. file4 := filepath.Join(user1.GetHomeDir(), retentionDir, "sub", "file4.txt")
  925. err = os.MkdirAll(filepath.Dir(file4), os.ModePerm)
  926. assert.NoError(t, err)
  927. for _, f := range []string{file1, file2, file3, file4} {
  928. err = os.WriteFile(f, []byte(""), 0666)
  929. assert.NoError(t, err)
  930. }
  931. timeBeforeRetention := time.Now().Add(-48 * time.Hour)
  932. err = os.Chtimes(file1, timeBeforeRetention, timeBeforeRetention)
  933. assert.NoError(t, err)
  934. err = os.Chtimes(file2, timeBeforeRetention, timeBeforeRetention)
  935. assert.NoError(t, err)
  936. err = os.Chtimes(file4, timeBeforeRetention, timeBeforeRetention)
  937. assert.NoError(t, err)
  938. err = executeRuleAction(dataRetentionAction, &EventParams{}, dataprovider.ConditionOptions{
  939. Names: []dataprovider.ConditionPattern{
  940. {
  941. Pattern: username1,
  942. },
  943. },
  944. })
  945. assert.NoError(t, err)
  946. assert.FileExists(t, file1)
  947. assert.NoFileExists(t, file2)
  948. assert.FileExists(t, file3)
  949. assert.NoDirExists(t, filepath.Dir(file4))
  950. // simulate another check in progress
  951. c := RetentionChecks.Add(RetentionCheck{}, &user1)
  952. assert.NotNil(t, c)
  953. err = executeRuleAction(dataRetentionAction, &EventParams{}, dataprovider.ConditionOptions{
  954. Names: []dataprovider.ConditionPattern{
  955. {
  956. Pattern: username1,
  957. },
  958. },
  959. })
  960. assert.Error(t, err)
  961. RetentionChecks.remove(user1.Username)
  962. err = executeRuleAction(dataRetentionAction, &EventParams{}, dataprovider.ConditionOptions{
  963. Names: []dataprovider.ConditionPattern{
  964. {
  965. Pattern: "no match",
  966. },
  967. },
  968. })
  969. assert.Error(t, err)
  970. assert.Contains(t, getErrorString(err), "no retention check executed")
  971. // test file exists action
  972. action = dataprovider.BaseEventAction{
  973. Type: dataprovider.ActionTypeFilesystem,
  974. Options: dataprovider.BaseEventActionOptions{
  975. FsConfig: dataprovider.EventActionFilesystemConfig{
  976. Type: dataprovider.FilesystemActionExist,
  977. Exist: []string{"/file1.txt", path.Join("/", retentionDir, "file3.txt")},
  978. },
  979. },
  980. }
  981. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  982. Names: []dataprovider.ConditionPattern{
  983. {
  984. Pattern: "no match",
  985. },
  986. },
  987. })
  988. assert.Error(t, err)
  989. assert.Contains(t, getErrorString(err), "no existence check executed")
  990. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  991. Names: []dataprovider.ConditionPattern{
  992. {
  993. Pattern: username1,
  994. },
  995. },
  996. })
  997. assert.NoError(t, err)
  998. action.Options.FsConfig.Exist = []string{"/file1.txt", path.Join("/", retentionDir, "file2.txt")}
  999. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  1000. Names: []dataprovider.ConditionPattern{
  1001. {
  1002. Pattern: username1,
  1003. },
  1004. },
  1005. })
  1006. assert.Error(t, err)
  1007. err = os.RemoveAll(user1.GetHomeDir())
  1008. assert.NoError(t, err)
  1009. err = dataprovider.UpdateUserTransferQuota(&user1, 100, 100, true)
  1010. assert.NoError(t, err)
  1011. action.Type = dataprovider.ActionTypeTransferQuotaReset
  1012. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  1013. Names: []dataprovider.ConditionPattern{
  1014. {
  1015. Pattern: username1,
  1016. },
  1017. },
  1018. })
  1019. assert.NoError(t, err)
  1020. userGet, err = dataprovider.UserExists(username1, "")
  1021. assert.NoError(t, err)
  1022. assert.Equal(t, int64(0), userGet.UsedDownloadDataTransfer)
  1023. assert.Equal(t, int64(0), userGet.UsedUploadDataTransfer)
  1024. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  1025. Names: []dataprovider.ConditionPattern{
  1026. {
  1027. Pattern: "no match",
  1028. },
  1029. },
  1030. })
  1031. assert.Error(t, err)
  1032. assert.Contains(t, getErrorString(err), "no transfer quota reset executed")
  1033. action.Type = dataprovider.ActionTypeFilesystem
  1034. action.Options = dataprovider.BaseEventActionOptions{
  1035. FsConfig: dataprovider.EventActionFilesystemConfig{
  1036. Type: dataprovider.FilesystemActionRename,
  1037. Renames: []dataprovider.KeyValue{
  1038. {
  1039. Key: "/source",
  1040. Value: "/target",
  1041. },
  1042. },
  1043. },
  1044. }
  1045. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  1046. Names: []dataprovider.ConditionPattern{
  1047. {
  1048. Pattern: "no match",
  1049. },
  1050. },
  1051. })
  1052. assert.Error(t, err)
  1053. assert.Contains(t, getErrorString(err), "no rename executed")
  1054. action.Options = dataprovider.BaseEventActionOptions{
  1055. FsConfig: dataprovider.EventActionFilesystemConfig{
  1056. Type: dataprovider.FilesystemActionDelete,
  1057. Deletes: []string{"/dir1"},
  1058. },
  1059. }
  1060. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  1061. Names: []dataprovider.ConditionPattern{
  1062. {
  1063. Pattern: "no match",
  1064. },
  1065. },
  1066. })
  1067. assert.Error(t, err)
  1068. assert.Contains(t, getErrorString(err), "no delete executed")
  1069. action.Options = dataprovider.BaseEventActionOptions{
  1070. FsConfig: dataprovider.EventActionFilesystemConfig{
  1071. Type: dataprovider.FilesystemActionMkdirs,
  1072. Deletes: []string{"/dir1"},
  1073. },
  1074. }
  1075. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  1076. Names: []dataprovider.ConditionPattern{
  1077. {
  1078. Pattern: "no match",
  1079. },
  1080. },
  1081. })
  1082. assert.Error(t, err)
  1083. assert.Contains(t, getErrorString(err), "no mkdir executed")
  1084. action.Options = dataprovider.BaseEventActionOptions{
  1085. FsConfig: dataprovider.EventActionFilesystemConfig{
  1086. Type: dataprovider.FilesystemActionCompress,
  1087. Compress: dataprovider.EventActionFsCompress{
  1088. Name: "test.zip",
  1089. Paths: []string{"/{{VirtualPath}}"},
  1090. },
  1091. },
  1092. }
  1093. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  1094. Names: []dataprovider.ConditionPattern{
  1095. {
  1096. Pattern: "no match",
  1097. },
  1098. },
  1099. })
  1100. assert.Error(t, err)
  1101. assert.Contains(t, getErrorString(err), "no file/folder compressed")
  1102. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  1103. GroupNames: []dataprovider.ConditionPattern{
  1104. {
  1105. Pattern: "no match",
  1106. },
  1107. },
  1108. })
  1109. assert.Error(t, err)
  1110. assert.Contains(t, getErrorString(err), "no file/folder compressed")
  1111. err = dataprovider.DeleteUser(username1, "", "", "")
  1112. assert.NoError(t, err)
  1113. err = dataprovider.DeleteUser(username2, "", "", "")
  1114. assert.NoError(t, err)
  1115. // test folder quota reset
  1116. foldername1 := "f1"
  1117. foldername2 := "f2"
  1118. folder1 := vfs.BaseVirtualFolder{
  1119. Name: foldername1,
  1120. MappedPath: filepath.Join(os.TempDir(), foldername1),
  1121. }
  1122. folder2 := vfs.BaseVirtualFolder{
  1123. Name: foldername2,
  1124. MappedPath: filepath.Join(os.TempDir(), foldername2),
  1125. }
  1126. err = dataprovider.AddFolder(&folder1, "", "", "")
  1127. assert.NoError(t, err)
  1128. err = dataprovider.AddFolder(&folder2, "", "", "")
  1129. assert.NoError(t, err)
  1130. action = dataprovider.BaseEventAction{
  1131. Type: dataprovider.ActionTypeFolderQuotaReset,
  1132. }
  1133. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  1134. Names: []dataprovider.ConditionPattern{
  1135. {
  1136. Pattern: foldername1,
  1137. },
  1138. },
  1139. })
  1140. assert.Error(t, err) // no home dir
  1141. err = os.MkdirAll(folder1.MappedPath, os.ModePerm)
  1142. assert.NoError(t, err)
  1143. err = os.WriteFile(filepath.Join(folder1.MappedPath, "file.txt"), []byte("folder"), 0666)
  1144. assert.NoError(t, err)
  1145. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  1146. Names: []dataprovider.ConditionPattern{
  1147. {
  1148. Pattern: foldername1,
  1149. },
  1150. },
  1151. })
  1152. assert.NoError(t, err)
  1153. folderGet, err := dataprovider.GetFolderByName(foldername1)
  1154. assert.NoError(t, err)
  1155. assert.Equal(t, 1, folderGet.UsedQuotaFiles)
  1156. assert.Equal(t, int64(6), folderGet.UsedQuotaSize)
  1157. // simulate another quota scan in progress
  1158. assert.True(t, QuotaScans.AddVFolderQuotaScan(foldername1))
  1159. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  1160. Names: []dataprovider.ConditionPattern{
  1161. {
  1162. Pattern: foldername1,
  1163. },
  1164. },
  1165. })
  1166. assert.Error(t, err)
  1167. assert.True(t, QuotaScans.RemoveVFolderQuotaScan(foldername1))
  1168. err = executeRuleAction(action, &EventParams{}, dataprovider.ConditionOptions{
  1169. Names: []dataprovider.ConditionPattern{
  1170. {
  1171. Pattern: "no folder match",
  1172. },
  1173. },
  1174. })
  1175. if assert.Error(t, err) {
  1176. assert.Contains(t, err.Error(), "no folder quota reset executed")
  1177. }
  1178. body, _, err := getHTTPRuleActionBody(&dataprovider.EventActionHTTPConfig{
  1179. Method: http.MethodPost,
  1180. }, nil, nil, dataprovider.User{}, &EventParams{}, true)
  1181. assert.NoError(t, err)
  1182. assert.Nil(t, body)
  1183. body, _, err = getHTTPRuleActionBody(&dataprovider.EventActionHTTPConfig{
  1184. Method: http.MethodPost,
  1185. Body: "test body",
  1186. }, nil, nil, dataprovider.User{}, &EventParams{}, false)
  1187. assert.NoError(t, err)
  1188. assert.NotNil(t, body)
  1189. err = os.RemoveAll(folder1.MappedPath)
  1190. assert.NoError(t, err)
  1191. err = dataprovider.DeleteFolder(foldername1, "", "", "")
  1192. assert.NoError(t, err)
  1193. err = dataprovider.DeleteFolder(foldername2, "", "", "")
  1194. assert.NoError(t, err)
  1195. }
  1196. func TestIDPAccountCheckRule(t *testing.T) {
  1197. _, _, err := executeIDPAccountCheckRule(dataprovider.EventRule{}, EventParams{})
  1198. if assert.Error(t, err) {
  1199. assert.Contains(t, err.Error(), "no action executed")
  1200. }
  1201. _, _, err = executeIDPAccountCheckRule(dataprovider.EventRule{
  1202. Actions: []dataprovider.EventAction{
  1203. {
  1204. BaseEventAction: dataprovider.BaseEventAction{
  1205. Name: "n",
  1206. Type: dataprovider.ActionTypeIDPAccountCheck,
  1207. },
  1208. },
  1209. },
  1210. }, EventParams{Event: "invalid"})
  1211. if assert.Error(t, err) {
  1212. assert.Contains(t, err.Error(), "unsupported IDP login event")
  1213. }
  1214. // invalid json
  1215. _, err = executeAdminCheckAction(&dataprovider.EventActionIDPAccountCheck{TemplateAdmin: "{"}, &EventParams{Name: "missing admin"})
  1216. assert.Error(t, err)
  1217. _, err = executeUserCheckAction(&dataprovider.EventActionIDPAccountCheck{TemplateUser: "["}, &EventParams{Name: "missing user"})
  1218. assert.Error(t, err)
  1219. _, err = executeUserCheckAction(&dataprovider.EventActionIDPAccountCheck{TemplateUser: "{}"}, &EventParams{Name: "invalid user template"})
  1220. assert.ErrorIs(t, err, util.ErrValidation)
  1221. username := "u"
  1222. c := &dataprovider.EventActionIDPAccountCheck{
  1223. Mode: 1,
  1224. TemplateUser: `{"username":"` + username + `","status":1,"home_dir":"` + util.JSONEscape(filepath.Join(os.TempDir())) + `","permissions":{"/":["*"]}}`,
  1225. }
  1226. params := &EventParams{
  1227. Name: username,
  1228. Event: IDPLoginUser,
  1229. }
  1230. user, err := executeUserCheckAction(c, params)
  1231. assert.NoError(t, err)
  1232. assert.Equal(t, username, user.Username)
  1233. assert.Equal(t, 1, user.Status)
  1234. user.Status = 0
  1235. err = dataprovider.UpdateUser(user, "", "", "")
  1236. assert.NoError(t, err)
  1237. // the user is not changed
  1238. user, err = executeUserCheckAction(c, params)
  1239. assert.NoError(t, err)
  1240. assert.Equal(t, username, user.Username)
  1241. assert.Equal(t, 0, user.Status)
  1242. // change the mode, the user is now updated
  1243. c.Mode = 0
  1244. user, err = executeUserCheckAction(c, params)
  1245. assert.NoError(t, err)
  1246. assert.Equal(t, username, user.Username)
  1247. assert.Equal(t, 1, user.Status)
  1248. err = dataprovider.DeleteUser(username, "", "", "")
  1249. assert.NoError(t, err)
  1250. // check rule consistency
  1251. r := dataprovider.EventRule{
  1252. Actions: []dataprovider.EventAction{
  1253. {
  1254. BaseEventAction: dataprovider.BaseEventAction{
  1255. Type: dataprovider.ActionTypeIDPAccountCheck,
  1256. },
  1257. Order: 1,
  1258. },
  1259. },
  1260. }
  1261. err = r.CheckActionsConsistency("")
  1262. if assert.Error(t, err) {
  1263. assert.Contains(t, err.Error(), "IDP account check action is only supported for IDP login trigger")
  1264. }
  1265. r.Trigger = dataprovider.EventTriggerIDPLogin
  1266. err = r.CheckActionsConsistency("")
  1267. if assert.Error(t, err) {
  1268. assert.Contains(t, err.Error(), "IDP account check must be a sync action")
  1269. }
  1270. r.Actions[0].Options.ExecuteSync = true
  1271. err = r.CheckActionsConsistency("")
  1272. assert.NoError(t, err)
  1273. r.Actions = append(r.Actions, dataprovider.EventAction{
  1274. BaseEventAction: dataprovider.BaseEventAction{
  1275. Type: dataprovider.ActionTypeCommand,
  1276. },
  1277. Options: dataprovider.EventActionOptions{
  1278. ExecuteSync: true,
  1279. },
  1280. Order: 2,
  1281. })
  1282. err = r.CheckActionsConsistency("")
  1283. if assert.Error(t, err) {
  1284. assert.Contains(t, err.Error(), "IDP account check must be the only sync action")
  1285. }
  1286. }
  1287. func TestUserExpirationCheck(t *testing.T) {
  1288. username := "test_user_expiration_check"
  1289. user := dataprovider.User{
  1290. BaseUser: sdk.BaseUser{
  1291. Username: username,
  1292. Permissions: map[string][]string{
  1293. "/": {dataprovider.PermAny},
  1294. },
  1295. HomeDir: filepath.Join(os.TempDir(), username),
  1296. ExpirationDate: util.GetTimeAsMsSinceEpoch(time.Now().Add(-24 * time.Hour)),
  1297. },
  1298. }
  1299. user.Filters.PasswordExpiration = 5
  1300. err := dataprovider.AddUser(&user, "", "", "")
  1301. assert.NoError(t, err)
  1302. conditions := dataprovider.ConditionOptions{
  1303. Names: []dataprovider.ConditionPattern{
  1304. {
  1305. Pattern: username,
  1306. },
  1307. },
  1308. }
  1309. err = executeUserExpirationCheckRuleAction(conditions, &EventParams{})
  1310. if assert.Error(t, err) {
  1311. assert.Contains(t, err.Error(), "expired users")
  1312. }
  1313. // the check will be skipped, the user is expired
  1314. err = executePwdExpirationCheckRuleAction(dataprovider.EventActionPasswordExpiration{Threshold: 10}, conditions, &EventParams{})
  1315. assert.NoError(t, err)
  1316. err = dataprovider.DeleteUser(username, "", "", "")
  1317. assert.NoError(t, err)
  1318. err = os.RemoveAll(user.GetHomeDir())
  1319. assert.NoError(t, err)
  1320. }
  1321. func TestEventRuleActionsNoGroupMatching(t *testing.T) {
  1322. username := "test_user_action_group_matching"
  1323. user := dataprovider.User{
  1324. BaseUser: sdk.BaseUser{
  1325. Username: username,
  1326. Permissions: map[string][]string{
  1327. "/": {dataprovider.PermAny},
  1328. },
  1329. HomeDir: filepath.Join(os.TempDir(), username),
  1330. },
  1331. }
  1332. err := dataprovider.AddUser(&user, "", "", "")
  1333. assert.NoError(t, err)
  1334. conditions := dataprovider.ConditionOptions{
  1335. GroupNames: []dataprovider.ConditionPattern{
  1336. {
  1337. Pattern: "agroup",
  1338. },
  1339. },
  1340. }
  1341. err = executeDeleteFsRuleAction(nil, nil, conditions, &EventParams{})
  1342. if assert.Error(t, err) {
  1343. assert.Contains(t, err.Error(), "no delete executed")
  1344. }
  1345. err = executeMkdirFsRuleAction(nil, nil, conditions, &EventParams{})
  1346. if assert.Error(t, err) {
  1347. assert.Contains(t, err.Error(), "no mkdir executed")
  1348. }
  1349. err = executeRenameFsRuleAction(nil, nil, conditions, &EventParams{})
  1350. if assert.Error(t, err) {
  1351. assert.Contains(t, err.Error(), "no rename executed")
  1352. }
  1353. err = executeExistFsRuleAction(nil, nil, conditions, &EventParams{})
  1354. if assert.Error(t, err) {
  1355. assert.Contains(t, err.Error(), "no existence check executed")
  1356. }
  1357. err = executeCopyFsRuleAction(nil, nil, conditions, &EventParams{})
  1358. if assert.Error(t, err) {
  1359. assert.Contains(t, err.Error(), "no copy executed")
  1360. }
  1361. err = executeUsersQuotaResetRuleAction(conditions, &EventParams{})
  1362. if assert.Error(t, err) {
  1363. assert.Contains(t, err.Error(), "no user quota reset executed")
  1364. }
  1365. err = executeMetadataCheckRuleAction(conditions, &EventParams{})
  1366. if assert.Error(t, err) {
  1367. assert.Contains(t, err.Error(), "no metadata check executed")
  1368. }
  1369. err = executeTransferQuotaResetRuleAction(conditions, &EventParams{})
  1370. if assert.Error(t, err) {
  1371. assert.Contains(t, err.Error(), "no transfer quota reset executed")
  1372. }
  1373. err = executeDataRetentionCheckRuleAction(dataprovider.EventActionDataRetentionConfig{}, conditions, &EventParams{}, "")
  1374. if assert.Error(t, err) {
  1375. assert.Contains(t, err.Error(), "no retention check executed")
  1376. }
  1377. err = dataprovider.DeleteUser(username, "", "", "")
  1378. assert.NoError(t, err)
  1379. err = os.RemoveAll(user.GetHomeDir())
  1380. assert.NoError(t, err)
  1381. }
  1382. func TestGetFileContent(t *testing.T) {
  1383. username := "test_user_get_file_content"
  1384. user := dataprovider.User{
  1385. BaseUser: sdk.BaseUser{
  1386. Username: username,
  1387. Permissions: map[string][]string{
  1388. "/": {dataprovider.PermAny},
  1389. },
  1390. HomeDir: filepath.Join(os.TempDir(), username),
  1391. },
  1392. }
  1393. err := dataprovider.AddUser(&user, "", "", "")
  1394. assert.NoError(t, err)
  1395. err = os.MkdirAll(user.GetHomeDir(), os.ModePerm)
  1396. assert.NoError(t, err)
  1397. fileContent := []byte("test file content")
  1398. err = os.WriteFile(filepath.Join(user.GetHomeDir(), "file.txt"), fileContent, 0666)
  1399. assert.NoError(t, err)
  1400. conn := NewBaseConnection(xid.New().String(), protocolEventAction, "", "", user)
  1401. replacer := strings.NewReplacer("old", "new")
  1402. files, err := getMailAttachments(conn, []string{"/file.txt"}, replacer)
  1403. assert.NoError(t, err)
  1404. if assert.Len(t, files, 1) {
  1405. var b bytes.Buffer
  1406. _, err = files[0].Writer(&b)
  1407. assert.NoError(t, err)
  1408. assert.Equal(t, fileContent, b.Bytes())
  1409. }
  1410. // missing file
  1411. _, err = getMailAttachments(conn, []string{"/file1.txt"}, replacer)
  1412. assert.Error(t, err)
  1413. // directory
  1414. _, err = getMailAttachments(conn, []string{"/"}, replacer)
  1415. assert.Error(t, err)
  1416. // files too large
  1417. content := make([]byte, maxAttachmentsSize/2+1)
  1418. _, err = rand.Read(content)
  1419. assert.NoError(t, err)
  1420. err = os.WriteFile(filepath.Join(user.GetHomeDir(), "file1.txt"), content, 0666)
  1421. assert.NoError(t, err)
  1422. err = os.WriteFile(filepath.Join(user.GetHomeDir(), "file2.txt"), content, 0666)
  1423. assert.NoError(t, err)
  1424. files, err = getMailAttachments(conn, []string{"/file1.txt"}, replacer)
  1425. assert.NoError(t, err)
  1426. if assert.Len(t, files, 1) {
  1427. var b bytes.Buffer
  1428. _, err = files[0].Writer(&b)
  1429. assert.NoError(t, err)
  1430. assert.Equal(t, content, b.Bytes())
  1431. }
  1432. _, err = getMailAttachments(conn, []string{"/file1.txt", "/file2.txt"}, replacer)
  1433. if assert.Error(t, err) {
  1434. assert.Contains(t, err.Error(), "size too large")
  1435. }
  1436. // change the filesystem provider
  1437. user.FsConfig.Provider = sdk.CryptedFilesystemProvider
  1438. user.FsConfig.CryptConfig.Passphrase = kms.NewPlainSecret("pwd")
  1439. err = dataprovider.UpdateUser(&user, "", "", "")
  1440. assert.NoError(t, err)
  1441. conn = NewBaseConnection(xid.New().String(), protocolEventAction, "", "", user)
  1442. // the file is not encrypted so reading the encryption header will fail
  1443. files, err = getMailAttachments(conn, []string{"/file.txt"}, replacer)
  1444. assert.NoError(t, err)
  1445. if assert.Len(t, files, 1) {
  1446. var b bytes.Buffer
  1447. _, err = files[0].Writer(&b)
  1448. assert.Error(t, err)
  1449. }
  1450. err = dataprovider.DeleteUser(username, "", "", "")
  1451. assert.NoError(t, err)
  1452. err = os.RemoveAll(user.GetHomeDir())
  1453. assert.NoError(t, err)
  1454. }
  1455. func TestFilesystemActionErrors(t *testing.T) {
  1456. err := executeFsRuleAction(dataprovider.EventActionFilesystemConfig{}, dataprovider.ConditionOptions{}, &EventParams{})
  1457. if assert.Error(t, err) {
  1458. assert.Contains(t, err.Error(), "unsupported filesystem action")
  1459. }
  1460. username := "test_user_for_actions"
  1461. testReplacer := strings.NewReplacer("old", "new")
  1462. user := dataprovider.User{
  1463. BaseUser: sdk.BaseUser{
  1464. Username: username,
  1465. Permissions: map[string][]string{
  1466. "/": {dataprovider.PermAny},
  1467. },
  1468. HomeDir: filepath.Join(os.TempDir(), username),
  1469. },
  1470. FsConfig: vfs.Filesystem{
  1471. Provider: sdk.SFTPFilesystemProvider,
  1472. SFTPConfig: vfs.SFTPFsConfig{
  1473. BaseSFTPFsConfig: sdk.BaseSFTPFsConfig{
  1474. Endpoint: "127.0.0.1:4022",
  1475. Username: username,
  1476. },
  1477. Password: kms.NewPlainSecret("pwd"),
  1478. },
  1479. },
  1480. }
  1481. err = executeEmailRuleAction(dataprovider.EventActionEmailConfig{
  1482. Recipients: []string{"test@example.net"},
  1483. Subject: "subject",
  1484. Body: "body",
  1485. Attachments: []string{"/file.txt"},
  1486. }, &EventParams{
  1487. sender: username,
  1488. })
  1489. assert.Error(t, err)
  1490. conn := NewBaseConnection("", protocolEventAction, "", "", user)
  1491. err = executeDeleteFileFsAction(conn, "", nil)
  1492. assert.Error(t, err)
  1493. err = dataprovider.AddUser(&user, "", "", "")
  1494. assert.NoError(t, err)
  1495. // check root fs fails
  1496. err = executeDeleteFsActionForUser(nil, testReplacer, user)
  1497. assert.Error(t, err)
  1498. err = executeMkDirsFsActionForUser(nil, testReplacer, user)
  1499. assert.Error(t, err)
  1500. err = executeRenameFsActionForUser(nil, testReplacer, user)
  1501. assert.Error(t, err)
  1502. err = executeExistFsActionForUser(nil, testReplacer, user)
  1503. assert.Error(t, err)
  1504. err = executeCopyFsActionForUser(nil, testReplacer, user)
  1505. assert.Error(t, err)
  1506. err = executeCompressFsActionForUser(dataprovider.EventActionFsCompress{}, testReplacer, user)
  1507. assert.Error(t, err)
  1508. _, _, _, _, err = getFileWriter(conn, "/path.txt", -1) //nolint:dogsled
  1509. assert.Error(t, err)
  1510. err = executeEmailRuleAction(dataprovider.EventActionEmailConfig{
  1511. Recipients: []string{"test@example.net"},
  1512. Subject: "subject",
  1513. Body: "body",
  1514. Attachments: []string{"/file1.txt"},
  1515. }, &EventParams{
  1516. sender: username,
  1517. })
  1518. assert.Error(t, err)
  1519. fn := getFileContentFn(NewBaseConnection("", protocolEventAction, "", "", user), "/f.txt", 1234)
  1520. var b bytes.Buffer
  1521. _, err = fn(&b)
  1522. assert.Error(t, err)
  1523. err = executeHTTPRuleAction(dataprovider.EventActionHTTPConfig{
  1524. Endpoint: "http://127.0.0.1:9999/",
  1525. Method: http.MethodPost,
  1526. Parts: []dataprovider.HTTPPart{
  1527. {
  1528. Name: "p1",
  1529. Filepath: "/filepath",
  1530. },
  1531. },
  1532. }, &EventParams{
  1533. sender: username,
  1534. })
  1535. assert.Error(t, err)
  1536. user.FsConfig.Provider = sdk.LocalFilesystemProvider
  1537. user.Permissions["/"] = []string{dataprovider.PermUpload}
  1538. err = dataprovider.DeleteUser(username, "", "", "")
  1539. assert.NoError(t, err)
  1540. err = dataprovider.AddUser(&user, "", "", "")
  1541. assert.NoError(t, err)
  1542. err = executeRenameFsActionForUser([]dataprovider.KeyValue{
  1543. {
  1544. Key: "/p1",
  1545. Value: "/p1",
  1546. },
  1547. }, testReplacer, user)
  1548. if assert.Error(t, err) {
  1549. assert.Contains(t, err.Error(), "the rename source and target cannot be the same")
  1550. }
  1551. err = executeRuleAction(dataprovider.BaseEventAction{
  1552. Type: dataprovider.ActionTypeFilesystem,
  1553. Options: dataprovider.BaseEventActionOptions{
  1554. FsConfig: dataprovider.EventActionFilesystemConfig{
  1555. Type: dataprovider.FilesystemActionRename,
  1556. Renames: []dataprovider.KeyValue{
  1557. {
  1558. Key: "/p2",
  1559. Value: "/p2",
  1560. },
  1561. },
  1562. },
  1563. },
  1564. }, &EventParams{}, dataprovider.ConditionOptions{
  1565. Names: []dataprovider.ConditionPattern{
  1566. {
  1567. Pattern: username,
  1568. },
  1569. },
  1570. })
  1571. assert.Error(t, err)
  1572. if runtime.GOOS != osWindows {
  1573. dirPath := filepath.Join(user.HomeDir, "adir", "sub")
  1574. err := os.MkdirAll(dirPath, os.ModePerm)
  1575. assert.NoError(t, err)
  1576. filePath := filepath.Join(dirPath, "f.dat")
  1577. err = os.WriteFile(filePath, []byte("test file content"), 0666)
  1578. assert.NoError(t, err)
  1579. err = os.Chmod(dirPath, 0001)
  1580. assert.NoError(t, err)
  1581. err = executeDeleteFsActionForUser([]string{"/adir/sub"}, testReplacer, user)
  1582. assert.Error(t, err)
  1583. err = executeDeleteFsActionForUser([]string{"/adir/sub/f.dat"}, testReplacer, user)
  1584. assert.Error(t, err)
  1585. err = os.Chmod(dirPath, 0555)
  1586. assert.NoError(t, err)
  1587. err = executeDeleteFsActionForUser([]string{"/adir/sub/f.dat"}, testReplacer, user)
  1588. if assert.Error(t, err) {
  1589. assert.Contains(t, err.Error(), "unable to remove file")
  1590. }
  1591. err = executeRuleAction(dataprovider.BaseEventAction{
  1592. Type: dataprovider.ActionTypeFilesystem,
  1593. Options: dataprovider.BaseEventActionOptions{
  1594. FsConfig: dataprovider.EventActionFilesystemConfig{
  1595. Type: dataprovider.FilesystemActionDelete,
  1596. Deletes: []string{"/adir/sub/f.dat"},
  1597. },
  1598. },
  1599. }, &EventParams{}, dataprovider.ConditionOptions{
  1600. Names: []dataprovider.ConditionPattern{
  1601. {
  1602. Pattern: username,
  1603. },
  1604. },
  1605. })
  1606. assert.Error(t, err)
  1607. err = executeMkDirsFsActionForUser([]string{"/adir/sub/sub"}, testReplacer, user)
  1608. if assert.Error(t, err) {
  1609. assert.Contains(t, err.Error(), "unable to create dir")
  1610. }
  1611. err = executeMkDirsFsActionForUser([]string{"/adir/sub/sub/sub"}, testReplacer, user)
  1612. if assert.Error(t, err) {
  1613. assert.Contains(t, err.Error(), "unable to check parent dirs")
  1614. }
  1615. err = executeRuleAction(dataprovider.BaseEventAction{
  1616. Type: dataprovider.ActionTypeFilesystem,
  1617. Options: dataprovider.BaseEventActionOptions{
  1618. FsConfig: dataprovider.EventActionFilesystemConfig{
  1619. Type: dataprovider.FilesystemActionMkdirs,
  1620. MkDirs: []string{"/adir/sub/sub1"},
  1621. },
  1622. },
  1623. }, &EventParams{}, dataprovider.ConditionOptions{
  1624. Names: []dataprovider.ConditionPattern{
  1625. {
  1626. Pattern: username,
  1627. },
  1628. },
  1629. })
  1630. assert.Error(t, err)
  1631. err = os.Chmod(dirPath, os.ModePerm)
  1632. assert.NoError(t, err)
  1633. conn = NewBaseConnection("", protocolEventAction, "", "", user)
  1634. wr := &zipWriterWrapper{
  1635. Name: "test.zip",
  1636. Writer: zip.NewWriter(bytes.NewBuffer(nil)),
  1637. Entries: map[string]bool{},
  1638. }
  1639. err = addZipEntry(wr, conn, "/adir/sub/f.dat", "/adir/sub/sub")
  1640. assert.Error(t, err)
  1641. assert.Contains(t, getErrorString(err), "is outside base dir")
  1642. }
  1643. err = dataprovider.DeleteUser(username, "", "", "")
  1644. assert.NoError(t, err)
  1645. err = os.RemoveAll(user.GetHomeDir())
  1646. assert.NoError(t, err)
  1647. }
  1648. func TestQuotaActionsWithQuotaTrackDisabled(t *testing.T) {
  1649. oldProviderConf := dataprovider.GetProviderConfig()
  1650. providerConf := dataprovider.GetProviderConfig()
  1651. providerConf.TrackQuota = 0
  1652. err := dataprovider.Close()
  1653. assert.NoError(t, err)
  1654. err = dataprovider.Initialize(providerConf, configDir, true)
  1655. assert.NoError(t, err)
  1656. username := "u1"
  1657. user := dataprovider.User{
  1658. BaseUser: sdk.BaseUser{
  1659. Username: username,
  1660. HomeDir: filepath.Join(os.TempDir(), username),
  1661. Status: 1,
  1662. Permissions: map[string][]string{
  1663. "/": {dataprovider.PermAny},
  1664. },
  1665. },
  1666. FsConfig: vfs.Filesystem{
  1667. Provider: sdk.LocalFilesystemProvider,
  1668. },
  1669. }
  1670. err = dataprovider.AddUser(&user, "", "", "")
  1671. assert.NoError(t, err)
  1672. err = os.MkdirAll(user.GetHomeDir(), os.ModePerm)
  1673. assert.NoError(t, err)
  1674. err = executeRuleAction(dataprovider.BaseEventAction{Type: dataprovider.ActionTypeUserQuotaReset},
  1675. &EventParams{}, dataprovider.ConditionOptions{
  1676. Names: []dataprovider.ConditionPattern{
  1677. {
  1678. Pattern: username,
  1679. },
  1680. },
  1681. })
  1682. assert.Error(t, err)
  1683. err = executeRuleAction(dataprovider.BaseEventAction{Type: dataprovider.ActionTypeTransferQuotaReset},
  1684. &EventParams{}, dataprovider.ConditionOptions{
  1685. Names: []dataprovider.ConditionPattern{
  1686. {
  1687. Pattern: username,
  1688. },
  1689. },
  1690. })
  1691. assert.Error(t, err)
  1692. err = os.RemoveAll(user.GetHomeDir())
  1693. assert.NoError(t, err)
  1694. err = dataprovider.DeleteUser(username, "", "", "")
  1695. assert.NoError(t, err)
  1696. foldername := "f1"
  1697. folder := vfs.BaseVirtualFolder{
  1698. Name: foldername,
  1699. MappedPath: filepath.Join(os.TempDir(), foldername),
  1700. }
  1701. err = dataprovider.AddFolder(&folder, "", "", "")
  1702. assert.NoError(t, err)
  1703. err = os.MkdirAll(folder.MappedPath, os.ModePerm)
  1704. assert.NoError(t, err)
  1705. err = executeRuleAction(dataprovider.BaseEventAction{Type: dataprovider.ActionTypeFolderQuotaReset},
  1706. &EventParams{}, dataprovider.ConditionOptions{
  1707. Names: []dataprovider.ConditionPattern{
  1708. {
  1709. Pattern: foldername,
  1710. },
  1711. },
  1712. })
  1713. assert.Error(t, err)
  1714. err = os.RemoveAll(folder.MappedPath)
  1715. assert.NoError(t, err)
  1716. err = dataprovider.DeleteFolder(foldername, "", "", "")
  1717. assert.NoError(t, err)
  1718. err = dataprovider.Close()
  1719. assert.NoError(t, err)
  1720. err = dataprovider.Initialize(oldProviderConf, configDir, true)
  1721. assert.NoError(t, err)
  1722. }
  1723. func TestScheduledActions(t *testing.T) {
  1724. startEventScheduler()
  1725. backupsPath := filepath.Join(os.TempDir(), "backups")
  1726. err := os.RemoveAll(backupsPath)
  1727. assert.NoError(t, err)
  1728. action := &dataprovider.BaseEventAction{
  1729. Name: "action",
  1730. Type: dataprovider.ActionTypeBackup,
  1731. }
  1732. err = dataprovider.AddEventAction(action, "", "", "")
  1733. assert.NoError(t, err)
  1734. rule := &dataprovider.EventRule{
  1735. Name: "rule",
  1736. Status: 1,
  1737. Trigger: dataprovider.EventTriggerSchedule,
  1738. Conditions: dataprovider.EventConditions{
  1739. Schedules: []dataprovider.Schedule{
  1740. {
  1741. Hours: "11",
  1742. DayOfWeek: "*",
  1743. DayOfMonth: "*",
  1744. Month: "*",
  1745. },
  1746. },
  1747. },
  1748. Actions: []dataprovider.EventAction{
  1749. {
  1750. BaseEventAction: dataprovider.BaseEventAction{
  1751. Name: action.Name,
  1752. },
  1753. Order: 1,
  1754. },
  1755. },
  1756. }
  1757. job := eventCronJob{
  1758. ruleName: rule.Name,
  1759. }
  1760. job.Run() // rule not found
  1761. assert.NoDirExists(t, backupsPath)
  1762. err = dataprovider.AddEventRule(rule, "", "", "")
  1763. assert.NoError(t, err)
  1764. job.Run()
  1765. assert.DirExists(t, backupsPath)
  1766. action.Type = dataprovider.ActionTypeEmail
  1767. action.Options = dataprovider.BaseEventActionOptions{
  1768. EmailConfig: dataprovider.EventActionEmailConfig{
  1769. Recipients: []string{"example@example.com"},
  1770. Subject: "test with attachments",
  1771. Body: "body",
  1772. Attachments: []string{"/file1.txt"},
  1773. },
  1774. }
  1775. err = dataprovider.UpdateEventAction(action, "", "", "")
  1776. assert.NoError(t, err)
  1777. job.Run() // action is not compatible with a scheduled rule
  1778. err = dataprovider.DeleteEventRule(rule.Name, "", "", "")
  1779. assert.NoError(t, err)
  1780. err = dataprovider.DeleteEventAction(action.Name, "", "", "")
  1781. assert.NoError(t, err)
  1782. err = os.RemoveAll(backupsPath)
  1783. assert.NoError(t, err)
  1784. stopEventScheduler()
  1785. }
  1786. func TestEventParamsCopy(t *testing.T) {
  1787. params := EventParams{
  1788. Name: "name",
  1789. Event: "event",
  1790. Status: 1,
  1791. errors: []string{"error1"},
  1792. retentionChecks: []executedRetentionCheck{},
  1793. }
  1794. paramsCopy := params.getACopy()
  1795. assert.Equal(t, params, *paramsCopy)
  1796. params.Name = "name mod"
  1797. paramsCopy.Event = "event mod"
  1798. paramsCopy.Status = 2
  1799. params.errors = append(params.errors, "error2")
  1800. paramsCopy.errors = append(paramsCopy.errors, "error3")
  1801. assert.Equal(t, []string{"error1", "error3"}, paramsCopy.errors)
  1802. assert.Equal(t, []string{"error1", "error2"}, params.errors)
  1803. assert.Equal(t, "name mod", params.Name)
  1804. assert.Equal(t, "name", paramsCopy.Name)
  1805. assert.Equal(t, "event", params.Event)
  1806. assert.Equal(t, "event mod", paramsCopy.Event)
  1807. assert.Equal(t, 1, params.Status)
  1808. assert.Equal(t, 2, paramsCopy.Status)
  1809. params = EventParams{
  1810. retentionChecks: []executedRetentionCheck{
  1811. {
  1812. Username: "u",
  1813. ActionName: "a",
  1814. Results: []folderRetentionCheckResult{
  1815. {
  1816. Path: "p",
  1817. Retention: 1,
  1818. },
  1819. },
  1820. },
  1821. },
  1822. }
  1823. paramsCopy = params.getACopy()
  1824. require.Len(t, paramsCopy.retentionChecks, 1)
  1825. paramsCopy.retentionChecks[0].Username = "u_copy"
  1826. paramsCopy.retentionChecks[0].ActionName = "a_copy"
  1827. require.Len(t, paramsCopy.retentionChecks[0].Results, 1)
  1828. paramsCopy.retentionChecks[0].Results[0].Path = "p_copy"
  1829. paramsCopy.retentionChecks[0].Results[0].Retention = 2
  1830. assert.Equal(t, "u", params.retentionChecks[0].Username)
  1831. assert.Equal(t, "a", params.retentionChecks[0].ActionName)
  1832. assert.Equal(t, "p", params.retentionChecks[0].Results[0].Path)
  1833. assert.Equal(t, 1, params.retentionChecks[0].Results[0].Retention)
  1834. assert.Equal(t, "u_copy", paramsCopy.retentionChecks[0].Username)
  1835. assert.Equal(t, "a_copy", paramsCopy.retentionChecks[0].ActionName)
  1836. assert.Equal(t, "p_copy", paramsCopy.retentionChecks[0].Results[0].Path)
  1837. assert.Equal(t, 2, paramsCopy.retentionChecks[0].Results[0].Retention)
  1838. assert.Nil(t, params.IDPCustomFields)
  1839. params.addIDPCustomFields(nil)
  1840. assert.Nil(t, params.IDPCustomFields)
  1841. params.IDPCustomFields = &map[string]string{
  1842. "field1": "val1",
  1843. }
  1844. paramsCopy = params.getACopy()
  1845. for k, v := range *paramsCopy.IDPCustomFields {
  1846. assert.Equal(t, "field1", k)
  1847. assert.Equal(t, "val1", v)
  1848. }
  1849. assert.Equal(t, params.IDPCustomFields, paramsCopy.IDPCustomFields)
  1850. paramsCopy.addIDPCustomFields(&map[string]any{
  1851. "field2": "val2",
  1852. })
  1853. assert.NotEqual(t, params.IDPCustomFields, paramsCopy.IDPCustomFields)
  1854. }
  1855. func TestEventParamsStatusFromError(t *testing.T) {
  1856. params := EventParams{Status: 1}
  1857. params.AddError(os.ErrNotExist)
  1858. assert.Equal(t, 1, params.Status)
  1859. params = EventParams{Status: 1, updateStatusFromError: true}
  1860. params.AddError(os.ErrNotExist)
  1861. assert.Equal(t, 2, params.Status)
  1862. }
  1863. type testWriter struct {
  1864. errTest error
  1865. sentinel string
  1866. }
  1867. func (w *testWriter) Write(p []byte) (int, error) {
  1868. if w.errTest != nil {
  1869. return 0, w.errTest
  1870. }
  1871. if w.sentinel == string(p) {
  1872. return 0, io.ErrUnexpectedEOF
  1873. }
  1874. return len(p), nil
  1875. }
  1876. func TestWriteHTTPPartsError(t *testing.T) {
  1877. m := multipart.NewWriter(&testWriter{
  1878. errTest: io.ErrShortWrite,
  1879. })
  1880. err := writeHTTPPart(m, dataprovider.HTTPPart{}, nil, nil, nil, &EventParams{}, false)
  1881. assert.ErrorIs(t, err, io.ErrShortWrite)
  1882. body := "test body"
  1883. m = multipart.NewWriter(&testWriter{sentinel: body})
  1884. err = writeHTTPPart(m, dataprovider.HTTPPart{
  1885. Body: body,
  1886. }, nil, nil, nil, &EventParams{}, false)
  1887. assert.ErrorIs(t, err, io.ErrUnexpectedEOF)
  1888. }
  1889. func TestReplacePathsPlaceholders(t *testing.T) {
  1890. replacer := strings.NewReplacer("{{VirtualPath}}", "/path1")
  1891. paths := []string{"{{VirtualPath}}", "/path1"}
  1892. paths = replacePathsPlaceholders(paths, replacer)
  1893. assert.Equal(t, []string{"/path1"}, paths)
  1894. paths = []string{"{{VirtualPath}}", "/path2"}
  1895. paths = replacePathsPlaceholders(paths, replacer)
  1896. assert.Equal(t, []string{"/path1", "/path2"}, paths)
  1897. }
  1898. func TestEstimateZipSizeErrors(t *testing.T) {
  1899. u := dataprovider.User{
  1900. BaseUser: sdk.BaseUser{
  1901. Username: "u",
  1902. HomeDir: filepath.Join(os.TempDir(), "u"),
  1903. Status: 1,
  1904. Permissions: map[string][]string{
  1905. "/": {dataprovider.PermAny},
  1906. },
  1907. QuotaSize: 1000,
  1908. },
  1909. }
  1910. err := dataprovider.AddUser(&u, "", "", "")
  1911. assert.NoError(t, err)
  1912. err = os.MkdirAll(u.GetHomeDir(), os.ModePerm)
  1913. assert.NoError(t, err)
  1914. conn := NewBaseConnection("", ProtocolFTP, "", "", u)
  1915. _, err = getSizeForPath(conn, "/missing", vfs.NewFileInfo("missing", true, 0, time.Now(), false))
  1916. assert.True(t, conn.IsNotExistError(err))
  1917. if runtime.GOOS != osWindows {
  1918. err = os.MkdirAll(filepath.Join(u.HomeDir, "d1", "d2", "sub"), os.ModePerm)
  1919. assert.NoError(t, err)
  1920. err = os.WriteFile(filepath.Join(u.HomeDir, "d1", "d2", "sub", "file.txt"), []byte("data"), 0666)
  1921. assert.NoError(t, err)
  1922. err = os.Chmod(filepath.Join(u.HomeDir, "d1", "d2"), 0001)
  1923. assert.NoError(t, err)
  1924. size, err := estimateZipSize(conn, "/archive.zip", []string{"/d1"})
  1925. assert.Error(t, err, "size %d", size)
  1926. err = os.Chmod(filepath.Join(u.HomeDir, "d1", "d2"), os.ModePerm)
  1927. assert.NoError(t, err)
  1928. }
  1929. err = dataprovider.DeleteUser(u.Username, "", "", "")
  1930. assert.NoError(t, err)
  1931. err = os.RemoveAll(u.GetHomeDir())
  1932. assert.NoError(t, err)
  1933. }
  1934. func TestOnDemandRule(t *testing.T) {
  1935. a := &dataprovider.BaseEventAction{
  1936. Name: "a",
  1937. Type: dataprovider.ActionTypeBackup,
  1938. Options: dataprovider.BaseEventActionOptions{},
  1939. }
  1940. err := dataprovider.AddEventAction(a, "", "", "")
  1941. assert.NoError(t, err)
  1942. r := &dataprovider.EventRule{
  1943. Name: "test on demand rule",
  1944. Status: 1,
  1945. Trigger: dataprovider.EventTriggerOnDemand,
  1946. Actions: []dataprovider.EventAction{
  1947. {
  1948. BaseEventAction: dataprovider.BaseEventAction{
  1949. Name: a.Name,
  1950. },
  1951. },
  1952. },
  1953. }
  1954. err = dataprovider.AddEventRule(r, "", "", "")
  1955. assert.NoError(t, err)
  1956. err = RunOnDemandRule(r.Name)
  1957. assert.NoError(t, err)
  1958. r.Status = 0
  1959. err = dataprovider.UpdateEventRule(r, "", "", "")
  1960. assert.NoError(t, err)
  1961. err = RunOnDemandRule(r.Name)
  1962. assert.ErrorIs(t, err, util.ErrValidation)
  1963. assert.Contains(t, err.Error(), "is inactive")
  1964. r.Status = 1
  1965. r.Trigger = dataprovider.EventTriggerCertificate
  1966. err = dataprovider.UpdateEventRule(r, "", "", "")
  1967. assert.NoError(t, err)
  1968. err = RunOnDemandRule(r.Name)
  1969. assert.ErrorIs(t, err, util.ErrValidation)
  1970. assert.Contains(t, err.Error(), "is not defined as on-demand")
  1971. a1 := &dataprovider.BaseEventAction{
  1972. Name: "a1",
  1973. Type: dataprovider.ActionTypeEmail,
  1974. Options: dataprovider.BaseEventActionOptions{
  1975. EmailConfig: dataprovider.EventActionEmailConfig{
  1976. Recipients: []string{"example@example.org"},
  1977. Subject: "subject",
  1978. Body: "body",
  1979. Attachments: []string{"/{{VirtualPath}}"},
  1980. },
  1981. },
  1982. }
  1983. err = dataprovider.AddEventAction(a1, "", "", "")
  1984. assert.NoError(t, err)
  1985. r.Trigger = dataprovider.EventTriggerOnDemand
  1986. r.Actions = []dataprovider.EventAction{
  1987. {
  1988. BaseEventAction: dataprovider.BaseEventAction{
  1989. Name: a1.Name,
  1990. },
  1991. },
  1992. }
  1993. err = dataprovider.UpdateEventRule(r, "", "", "")
  1994. assert.NoError(t, err)
  1995. err = RunOnDemandRule(r.Name)
  1996. assert.ErrorIs(t, err, util.ErrValidation)
  1997. assert.Contains(t, err.Error(), "incosistent actions")
  1998. err = dataprovider.DeleteEventRule(r.Name, "", "", "")
  1999. assert.NoError(t, err)
  2000. err = dataprovider.DeleteEventAction(a.Name, "", "", "")
  2001. assert.NoError(t, err)
  2002. err = dataprovider.DeleteEventAction(a1.Name, "", "", "")
  2003. assert.NoError(t, err)
  2004. err = RunOnDemandRule(r.Name)
  2005. assert.ErrorIs(t, err, util.ErrNotFound)
  2006. }
  2007. func getErrorString(err error) string {
  2008. if err == nil {
  2009. return ""
  2010. }
  2011. return err.Error()
  2012. }
  2013. func TestHTTPEndpointWithPlaceholders(t *testing.T) {
  2014. c := dataprovider.EventActionHTTPConfig{
  2015. Endpoint: "http://127.0.0.1:8080/base/url/{{Name}}/{{VirtualPath}}/upload",
  2016. QueryParameters: []dataprovider.KeyValue{
  2017. {
  2018. Key: "u",
  2019. Value: "{{Name}}",
  2020. },
  2021. {
  2022. Key: "p",
  2023. Value: "{{VirtualPath}}",
  2024. },
  2025. },
  2026. }
  2027. name := "uname"
  2028. vPath := "/a dir/@ file.txt"
  2029. replacer := strings.NewReplacer("{{Name}}", name, "{{VirtualPath}}", vPath)
  2030. u, err := getHTTPRuleActionEndpoint(c, replacer)
  2031. assert.NoError(t, err)
  2032. expected := "http://127.0.0.1:8080/base/url/" + url.PathEscape(name) + "/" + url.PathEscape(vPath) +
  2033. "/upload?" + "p=" + url.QueryEscape(vPath) + "&u=" + url.QueryEscape(name)
  2034. assert.Equal(t, expected, u)
  2035. c.Endpoint = "http://127.0.0.1/upload"
  2036. u, err = getHTTPRuleActionEndpoint(c, replacer)
  2037. assert.NoError(t, err)
  2038. expected = c.Endpoint + "?p=" + url.QueryEscape(vPath) + "&u=" + url.QueryEscape(name)
  2039. assert.Equal(t, expected, u)
  2040. }