common_test.go 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956
  1. package common
  2. import (
  3. "crypto/tls"
  4. "encoding/json"
  5. "fmt"
  6. "net"
  7. "os"
  8. "os/exec"
  9. "path/filepath"
  10. "runtime"
  11. "strings"
  12. "sync/atomic"
  13. "testing"
  14. "time"
  15. "github.com/alexedwards/argon2id"
  16. "github.com/sftpgo/sdk"
  17. "github.com/stretchr/testify/assert"
  18. "github.com/stretchr/testify/require"
  19. "golang.org/x/crypto/bcrypt"
  20. "github.com/drakkan/sftpgo/v2/dataprovider"
  21. "github.com/drakkan/sftpgo/v2/kms"
  22. "github.com/drakkan/sftpgo/v2/util"
  23. "github.com/drakkan/sftpgo/v2/vfs"
  24. )
  25. const (
  26. logSenderTest = "common_test"
  27. httpAddr = "127.0.0.1:9999"
  28. configDir = ".."
  29. osWindows = "windows"
  30. userTestUsername = "common_test_username"
  31. )
  32. type fakeConnection struct {
  33. *BaseConnection
  34. command string
  35. }
  36. func (c *fakeConnection) AddUser(user dataprovider.User) error {
  37. _, err := user.GetFilesystem(c.GetID())
  38. if err != nil {
  39. return err
  40. }
  41. c.BaseConnection.User = user
  42. return nil
  43. }
  44. func (c *fakeConnection) Disconnect() error {
  45. Connections.Remove(c.GetID())
  46. return nil
  47. }
  48. func (c *fakeConnection) GetClientVersion() string {
  49. return ""
  50. }
  51. func (c *fakeConnection) GetCommand() string {
  52. return c.command
  53. }
  54. func (c *fakeConnection) GetLocalAddress() string {
  55. return ""
  56. }
  57. func (c *fakeConnection) GetRemoteAddress() string {
  58. return ""
  59. }
  60. type customNetConn struct {
  61. net.Conn
  62. id string
  63. isClosed bool
  64. }
  65. func (c *customNetConn) Close() error {
  66. Connections.RemoveSSHConnection(c.id)
  67. c.isClosed = true
  68. return c.Conn.Close()
  69. }
  70. func TestSSHConnections(t *testing.T) {
  71. conn1, conn2 := net.Pipe()
  72. now := time.Now()
  73. sshConn1 := NewSSHConnection("id1", conn1)
  74. sshConn2 := NewSSHConnection("id2", conn2)
  75. sshConn3 := NewSSHConnection("id3", conn2)
  76. assert.Equal(t, "id1", sshConn1.GetID())
  77. assert.Equal(t, "id2", sshConn2.GetID())
  78. assert.Equal(t, "id3", sshConn3.GetID())
  79. sshConn1.UpdateLastActivity()
  80. assert.GreaterOrEqual(t, sshConn1.GetLastActivity().UnixNano(), now.UnixNano())
  81. Connections.AddSSHConnection(sshConn1)
  82. Connections.AddSSHConnection(sshConn2)
  83. Connections.AddSSHConnection(sshConn3)
  84. Connections.RLock()
  85. assert.Len(t, Connections.sshConnections, 3)
  86. Connections.RUnlock()
  87. Connections.RemoveSSHConnection(sshConn1.id)
  88. Connections.RLock()
  89. assert.Len(t, Connections.sshConnections, 2)
  90. assert.Equal(t, sshConn3.id, Connections.sshConnections[0].id)
  91. assert.Equal(t, sshConn2.id, Connections.sshConnections[1].id)
  92. Connections.RUnlock()
  93. Connections.RemoveSSHConnection(sshConn1.id)
  94. Connections.RLock()
  95. assert.Len(t, Connections.sshConnections, 2)
  96. assert.Equal(t, sshConn3.id, Connections.sshConnections[0].id)
  97. assert.Equal(t, sshConn2.id, Connections.sshConnections[1].id)
  98. Connections.RUnlock()
  99. Connections.RemoveSSHConnection(sshConn2.id)
  100. Connections.RLock()
  101. assert.Len(t, Connections.sshConnections, 1)
  102. assert.Equal(t, sshConn3.id, Connections.sshConnections[0].id)
  103. Connections.RUnlock()
  104. Connections.RemoveSSHConnection(sshConn3.id)
  105. Connections.RLock()
  106. assert.Len(t, Connections.sshConnections, 0)
  107. Connections.RUnlock()
  108. assert.NoError(t, sshConn1.Close())
  109. assert.NoError(t, sshConn2.Close())
  110. assert.NoError(t, sshConn3.Close())
  111. }
  112. func TestDefenderIntegration(t *testing.T) {
  113. // by default defender is nil
  114. configCopy := Config
  115. ip := "127.1.1.1"
  116. assert.Nil(t, ReloadDefender())
  117. AddDefenderEvent(ip, HostEventNoLoginTried)
  118. assert.False(t, IsBanned(ip))
  119. banTime, err := GetDefenderBanTime(ip)
  120. assert.NoError(t, err)
  121. assert.Nil(t, banTime)
  122. assert.False(t, DeleteDefenderHost(ip))
  123. score, err := GetDefenderScore(ip)
  124. assert.NoError(t, err)
  125. assert.Equal(t, 0, score)
  126. _, err = GetDefenderHost(ip)
  127. assert.Error(t, err)
  128. hosts, err := GetDefenderHosts()
  129. assert.NoError(t, err)
  130. assert.Nil(t, hosts)
  131. Config.DefenderConfig = DefenderConfig{
  132. Enabled: true,
  133. Driver: DefenderDriverProvider,
  134. BanTime: 10,
  135. BanTimeIncrement: 50,
  136. Threshold: 0,
  137. ScoreInvalid: 2,
  138. ScoreValid: 1,
  139. ObservationTime: 15,
  140. EntriesSoftLimit: 100,
  141. EntriesHardLimit: 150,
  142. }
  143. err = Initialize(Config, 0)
  144. // ScoreInvalid cannot be greater than threshold
  145. assert.Error(t, err)
  146. Config.DefenderConfig.Driver = "unsupported"
  147. err = Initialize(Config, 0)
  148. if assert.Error(t, err) {
  149. assert.Contains(t, err.Error(), "unsupported defender driver")
  150. }
  151. Config.DefenderConfig.Driver = DefenderDriverMemory
  152. err = Initialize(Config, 0)
  153. // ScoreInvalid cannot be greater than threshold
  154. assert.Error(t, err)
  155. Config.DefenderConfig.Threshold = 3
  156. err = Initialize(Config, 0)
  157. assert.NoError(t, err)
  158. assert.Nil(t, ReloadDefender())
  159. AddDefenderEvent(ip, HostEventNoLoginTried)
  160. assert.False(t, IsBanned(ip))
  161. score, err = GetDefenderScore(ip)
  162. assert.NoError(t, err)
  163. assert.Equal(t, 2, score)
  164. entry, err := GetDefenderHost(ip)
  165. assert.NoError(t, err)
  166. asJSON, err := json.Marshal(&entry)
  167. assert.NoError(t, err)
  168. assert.Equal(t, `{"id":"3132372e312e312e31","ip":"127.1.1.1","score":2}`, string(asJSON), "entry %v", entry)
  169. assert.True(t, DeleteDefenderHost(ip))
  170. banTime, err = GetDefenderBanTime(ip)
  171. assert.NoError(t, err)
  172. assert.Nil(t, banTime)
  173. AddDefenderEvent(ip, HostEventLoginFailed)
  174. AddDefenderEvent(ip, HostEventNoLoginTried)
  175. assert.True(t, IsBanned(ip))
  176. score, err = GetDefenderScore(ip)
  177. assert.NoError(t, err)
  178. assert.Equal(t, 0, score)
  179. banTime, err = GetDefenderBanTime(ip)
  180. assert.NoError(t, err)
  181. assert.NotNil(t, banTime)
  182. hosts, err = GetDefenderHosts()
  183. assert.NoError(t, err)
  184. assert.Len(t, hosts, 1)
  185. entry, err = GetDefenderHost(ip)
  186. assert.NoError(t, err)
  187. assert.False(t, entry.BanTime.IsZero())
  188. assert.True(t, DeleteDefenderHost(ip))
  189. hosts, err = GetDefenderHosts()
  190. assert.NoError(t, err)
  191. assert.Len(t, hosts, 0)
  192. banTime, err = GetDefenderBanTime(ip)
  193. assert.NoError(t, err)
  194. assert.Nil(t, banTime)
  195. assert.False(t, DeleteDefenderHost(ip))
  196. Config = configCopy
  197. }
  198. func TestRateLimitersIntegration(t *testing.T) {
  199. // by default defender is nil
  200. configCopy := Config
  201. Config.RateLimitersConfig = []RateLimiterConfig{
  202. {
  203. Average: 100,
  204. Period: 10,
  205. Burst: 5,
  206. Type: int(rateLimiterTypeGlobal),
  207. Protocols: rateLimiterProtocolValues,
  208. },
  209. {
  210. Average: 1,
  211. Period: 1000,
  212. Burst: 1,
  213. Type: int(rateLimiterTypeSource),
  214. Protocols: []string{ProtocolWebDAV, ProtocolWebDAV, ProtocolFTP},
  215. GenerateDefenderEvents: true,
  216. EntriesSoftLimit: 100,
  217. EntriesHardLimit: 150,
  218. },
  219. }
  220. err := Initialize(Config, 0)
  221. assert.Error(t, err)
  222. Config.RateLimitersConfig[0].Period = 1000
  223. Config.RateLimitersConfig[0].AllowList = []string{"1.1.1", "1.1.1.2"}
  224. err = Initialize(Config, 0)
  225. if assert.Error(t, err) {
  226. assert.Contains(t, err.Error(), "unable to parse rate limiter allow list")
  227. }
  228. Config.RateLimitersConfig[0].AllowList = []string{"172.16.24.7"}
  229. Config.RateLimitersConfig[1].AllowList = []string{"172.16.0.0/16"}
  230. err = Initialize(Config, 0)
  231. assert.NoError(t, err)
  232. assert.Len(t, rateLimiters, 4)
  233. assert.Len(t, rateLimiters[ProtocolSSH], 1)
  234. assert.Len(t, rateLimiters[ProtocolFTP], 2)
  235. assert.Len(t, rateLimiters[ProtocolWebDAV], 2)
  236. assert.Len(t, rateLimiters[ProtocolHTTP], 1)
  237. source1 := "127.1.1.1"
  238. source2 := "127.1.1.2"
  239. source3 := "172.16.24.7" // whitelisted
  240. _, err = LimitRate(ProtocolSSH, source1)
  241. assert.NoError(t, err)
  242. _, err = LimitRate(ProtocolFTP, source1)
  243. assert.NoError(t, err)
  244. // sleep to allow the add configured burst to the token.
  245. // This sleep is not enough to add the per-source burst
  246. time.Sleep(20 * time.Millisecond)
  247. _, err = LimitRate(ProtocolWebDAV, source2)
  248. assert.NoError(t, err)
  249. _, err = LimitRate(ProtocolFTP, source1)
  250. assert.Error(t, err)
  251. _, err = LimitRate(ProtocolWebDAV, source2)
  252. assert.Error(t, err)
  253. _, err = LimitRate(ProtocolSSH, source1)
  254. assert.NoError(t, err)
  255. _, err = LimitRate(ProtocolSSH, source2)
  256. assert.NoError(t, err)
  257. for i := 0; i < 10; i++ {
  258. _, err = LimitRate(ProtocolWebDAV, source3)
  259. assert.NoError(t, err)
  260. }
  261. Config = configCopy
  262. }
  263. func TestMaxConnections(t *testing.T) {
  264. oldValue := Config.MaxTotalConnections
  265. perHost := Config.MaxPerHostConnections
  266. Config.MaxPerHostConnections = 0
  267. ipAddr := "192.168.7.8"
  268. assert.True(t, Connections.IsNewConnectionAllowed(ipAddr))
  269. Config.MaxTotalConnections = 1
  270. Config.MaxPerHostConnections = perHost
  271. assert.True(t, Connections.IsNewConnectionAllowed(ipAddr))
  272. c := NewBaseConnection("id", ProtocolSFTP, "", "", dataprovider.User{})
  273. fakeConn := &fakeConnection{
  274. BaseConnection: c,
  275. }
  276. Connections.Add(fakeConn)
  277. assert.Len(t, Connections.GetStats(), 1)
  278. assert.False(t, Connections.IsNewConnectionAllowed(ipAddr))
  279. res := Connections.Close(fakeConn.GetID())
  280. assert.True(t, res)
  281. assert.Eventually(t, func() bool { return len(Connections.GetStats()) == 0 }, 300*time.Millisecond, 50*time.Millisecond)
  282. assert.True(t, Connections.IsNewConnectionAllowed(ipAddr))
  283. Connections.AddClientConnection(ipAddr)
  284. Connections.AddClientConnection(ipAddr)
  285. assert.False(t, Connections.IsNewConnectionAllowed(ipAddr))
  286. Connections.RemoveClientConnection(ipAddr)
  287. assert.True(t, Connections.IsNewConnectionAllowed(ipAddr))
  288. Connections.RemoveClientConnection(ipAddr)
  289. Config.MaxTotalConnections = oldValue
  290. }
  291. func TestMaxConnectionPerHost(t *testing.T) {
  292. oldValue := Config.MaxPerHostConnections
  293. Config.MaxPerHostConnections = 2
  294. ipAddr := "192.168.9.9"
  295. Connections.AddClientConnection(ipAddr)
  296. assert.True(t, Connections.IsNewConnectionAllowed(ipAddr))
  297. Connections.AddClientConnection(ipAddr)
  298. assert.True(t, Connections.IsNewConnectionAllowed(ipAddr))
  299. Connections.AddClientConnection(ipAddr)
  300. assert.False(t, Connections.IsNewConnectionAllowed(ipAddr))
  301. assert.Equal(t, int32(3), Connections.GetClientConnections())
  302. Connections.RemoveClientConnection(ipAddr)
  303. Connections.RemoveClientConnection(ipAddr)
  304. Connections.RemoveClientConnection(ipAddr)
  305. assert.Equal(t, int32(0), Connections.GetClientConnections())
  306. Config.MaxPerHostConnections = oldValue
  307. }
  308. func TestIdleConnections(t *testing.T) {
  309. configCopy := Config
  310. Config.IdleTimeout = 1
  311. err := Initialize(Config, 0)
  312. assert.NoError(t, err)
  313. conn1, conn2 := net.Pipe()
  314. customConn1 := &customNetConn{
  315. Conn: conn1,
  316. id: "id1",
  317. }
  318. customConn2 := &customNetConn{
  319. Conn: conn2,
  320. id: "id2",
  321. }
  322. sshConn1 := NewSSHConnection(customConn1.id, customConn1)
  323. sshConn2 := NewSSHConnection(customConn2.id, customConn2)
  324. username := "test_user"
  325. user := dataprovider.User{
  326. BaseUser: sdk.BaseUser{
  327. Username: username,
  328. },
  329. }
  330. c := NewBaseConnection(sshConn1.id+"_1", ProtocolSFTP, "", "", user)
  331. c.lastActivity = time.Now().Add(-24 * time.Hour).UnixNano()
  332. fakeConn := &fakeConnection{
  333. BaseConnection: c,
  334. }
  335. // both ssh connections are expired but they should get removed only
  336. // if there is no associated connection
  337. sshConn1.lastActivity = c.lastActivity
  338. sshConn2.lastActivity = c.lastActivity
  339. Connections.AddSSHConnection(sshConn1)
  340. Connections.Add(fakeConn)
  341. assert.Equal(t, Connections.GetActiveSessions(username), 1)
  342. c = NewBaseConnection(sshConn2.id+"_1", ProtocolSSH, "", "", user)
  343. fakeConn = &fakeConnection{
  344. BaseConnection: c,
  345. }
  346. Connections.AddSSHConnection(sshConn2)
  347. Connections.Add(fakeConn)
  348. assert.Equal(t, Connections.GetActiveSessions(username), 2)
  349. cFTP := NewBaseConnection("id2", ProtocolFTP, "", "", dataprovider.User{})
  350. cFTP.lastActivity = time.Now().UnixNano()
  351. fakeConn = &fakeConnection{
  352. BaseConnection: cFTP,
  353. }
  354. Connections.Add(fakeConn)
  355. assert.Equal(t, Connections.GetActiveSessions(username), 2)
  356. assert.Len(t, Connections.GetStats(), 3)
  357. Connections.RLock()
  358. assert.Len(t, Connections.sshConnections, 2)
  359. Connections.RUnlock()
  360. startPeriodicTimeoutTicker(100 * time.Millisecond)
  361. assert.Eventually(t, func() bool { return Connections.GetActiveSessions(username) == 1 }, 1*time.Second, 200*time.Millisecond)
  362. assert.Eventually(t, func() bool {
  363. Connections.RLock()
  364. defer Connections.RUnlock()
  365. return len(Connections.sshConnections) == 1
  366. }, 1*time.Second, 200*time.Millisecond)
  367. stopPeriodicTimeoutTicker()
  368. assert.Len(t, Connections.GetStats(), 2)
  369. c.lastActivity = time.Now().Add(-24 * time.Hour).UnixNano()
  370. cFTP.lastActivity = time.Now().Add(-24 * time.Hour).UnixNano()
  371. sshConn2.lastActivity = c.lastActivity
  372. startPeriodicTimeoutTicker(100 * time.Millisecond)
  373. assert.Eventually(t, func() bool { return len(Connections.GetStats()) == 0 }, 1*time.Second, 200*time.Millisecond)
  374. assert.Eventually(t, func() bool {
  375. Connections.RLock()
  376. defer Connections.RUnlock()
  377. return len(Connections.sshConnections) == 0
  378. }, 1*time.Second, 200*time.Millisecond)
  379. assert.Equal(t, int32(0), Connections.GetClientConnections())
  380. stopPeriodicTimeoutTicker()
  381. assert.True(t, customConn1.isClosed)
  382. assert.True(t, customConn2.isClosed)
  383. Config = configCopy
  384. }
  385. func TestCloseConnection(t *testing.T) {
  386. c := NewBaseConnection("id", ProtocolSFTP, "", "", dataprovider.User{})
  387. fakeConn := &fakeConnection{
  388. BaseConnection: c,
  389. }
  390. assert.True(t, Connections.IsNewConnectionAllowed("127.0.0.1"))
  391. Connections.Add(fakeConn)
  392. assert.Len(t, Connections.GetStats(), 1)
  393. res := Connections.Close(fakeConn.GetID())
  394. assert.True(t, res)
  395. assert.Eventually(t, func() bool { return len(Connections.GetStats()) == 0 }, 300*time.Millisecond, 50*time.Millisecond)
  396. res = Connections.Close(fakeConn.GetID())
  397. assert.False(t, res)
  398. Connections.Remove(fakeConn.GetID())
  399. }
  400. func TestSwapConnection(t *testing.T) {
  401. c := NewBaseConnection("id", ProtocolFTP, "", "", dataprovider.User{})
  402. fakeConn := &fakeConnection{
  403. BaseConnection: c,
  404. }
  405. Connections.Add(fakeConn)
  406. if assert.Len(t, Connections.GetStats(), 1) {
  407. assert.Equal(t, "", Connections.GetStats()[0].Username)
  408. }
  409. c = NewBaseConnection("id", ProtocolFTP, "", "", dataprovider.User{
  410. BaseUser: sdk.BaseUser{
  411. Username: userTestUsername,
  412. },
  413. })
  414. fakeConn = &fakeConnection{
  415. BaseConnection: c,
  416. }
  417. err := Connections.Swap(fakeConn)
  418. assert.NoError(t, err)
  419. if assert.Len(t, Connections.GetStats(), 1) {
  420. assert.Equal(t, userTestUsername, Connections.GetStats()[0].Username)
  421. }
  422. res := Connections.Close(fakeConn.GetID())
  423. assert.True(t, res)
  424. assert.Eventually(t, func() bool { return len(Connections.GetStats()) == 0 }, 300*time.Millisecond, 50*time.Millisecond)
  425. err = Connections.Swap(fakeConn)
  426. assert.Error(t, err)
  427. }
  428. func TestAtomicUpload(t *testing.T) {
  429. configCopy := Config
  430. Config.UploadMode = UploadModeStandard
  431. assert.False(t, Config.IsAtomicUploadEnabled())
  432. Config.UploadMode = UploadModeAtomic
  433. assert.True(t, Config.IsAtomicUploadEnabled())
  434. Config.UploadMode = UploadModeAtomicWithResume
  435. assert.True(t, Config.IsAtomicUploadEnabled())
  436. Config = configCopy
  437. }
  438. func TestConnectionStatus(t *testing.T) {
  439. username := "test_user"
  440. user := dataprovider.User{
  441. BaseUser: sdk.BaseUser{
  442. Username: username,
  443. },
  444. }
  445. fs := vfs.NewOsFs("", os.TempDir(), "")
  446. c1 := NewBaseConnection("id1", ProtocolSFTP, "", "", user)
  447. fakeConn1 := &fakeConnection{
  448. BaseConnection: c1,
  449. }
  450. t1 := NewBaseTransfer(nil, c1, nil, "/p1", "/p1", "/r1", TransferUpload, 0, 0, 0, 0, true, fs, dataprovider.TransferQuota{})
  451. t1.BytesReceived = 123
  452. t2 := NewBaseTransfer(nil, c1, nil, "/p2", "/p2", "/r2", TransferDownload, 0, 0, 0, 0, true, fs, dataprovider.TransferQuota{})
  453. t2.BytesSent = 456
  454. c2 := NewBaseConnection("id2", ProtocolSSH, "", "", user)
  455. fakeConn2 := &fakeConnection{
  456. BaseConnection: c2,
  457. command: "md5sum",
  458. }
  459. c3 := NewBaseConnection("id3", ProtocolWebDAV, "", "", user)
  460. fakeConn3 := &fakeConnection{
  461. BaseConnection: c3,
  462. command: "PROPFIND",
  463. }
  464. t3 := NewBaseTransfer(nil, c3, nil, "/p2", "/p2", "/r2", TransferDownload, 0, 0, 0, 0, true, fs, dataprovider.TransferQuota{})
  465. Connections.Add(fakeConn1)
  466. Connections.Add(fakeConn2)
  467. Connections.Add(fakeConn3)
  468. stats := Connections.GetStats()
  469. assert.Len(t, stats, 3)
  470. for _, stat := range stats {
  471. assert.Equal(t, stat.Username, username)
  472. assert.True(t, strings.HasPrefix(stat.GetConnectionInfo(), stat.Protocol))
  473. assert.True(t, strings.HasPrefix(stat.GetConnectionDuration(), "00:"))
  474. if stat.ConnectionID == "SFTP_id1" {
  475. assert.Len(t, stat.Transfers, 2)
  476. assert.Greater(t, len(stat.GetTransfersAsString()), 0)
  477. for _, tr := range stat.Transfers {
  478. if tr.OperationType == operationDownload {
  479. assert.True(t, strings.HasPrefix(tr.getConnectionTransferAsString(), "DL"))
  480. } else if tr.OperationType == operationUpload {
  481. assert.True(t, strings.HasPrefix(tr.getConnectionTransferAsString(), "UL"))
  482. }
  483. }
  484. } else if stat.ConnectionID == "DAV_id3" {
  485. assert.Len(t, stat.Transfers, 1)
  486. assert.Greater(t, len(stat.GetTransfersAsString()), 0)
  487. } else {
  488. assert.Equal(t, 0, len(stat.GetTransfersAsString()))
  489. }
  490. }
  491. err := t1.Close()
  492. assert.NoError(t, err)
  493. err = t2.Close()
  494. assert.NoError(t, err)
  495. err = fakeConn3.SignalTransfersAbort()
  496. assert.NoError(t, err)
  497. assert.Equal(t, int32(1), atomic.LoadInt32(&t3.AbortTransfer))
  498. err = t3.Close()
  499. assert.NoError(t, err)
  500. err = fakeConn3.SignalTransfersAbort()
  501. assert.Error(t, err)
  502. Connections.Remove(fakeConn1.GetID())
  503. stats = Connections.GetStats()
  504. assert.Len(t, stats, 2)
  505. assert.Equal(t, fakeConn3.GetID(), stats[0].ConnectionID)
  506. assert.Equal(t, fakeConn2.GetID(), stats[1].ConnectionID)
  507. Connections.Remove(fakeConn2.GetID())
  508. stats = Connections.GetStats()
  509. assert.Len(t, stats, 1)
  510. assert.Equal(t, fakeConn3.GetID(), stats[0].ConnectionID)
  511. Connections.Remove(fakeConn3.GetID())
  512. stats = Connections.GetStats()
  513. assert.Len(t, stats, 0)
  514. }
  515. func TestQuotaScans(t *testing.T) {
  516. username := "username"
  517. assert.True(t, QuotaScans.AddUserQuotaScan(username))
  518. assert.False(t, QuotaScans.AddUserQuotaScan(username))
  519. usersScans := QuotaScans.GetUsersQuotaScans()
  520. if assert.Len(t, usersScans, 1) {
  521. assert.Equal(t, usersScans[0].Username, username)
  522. assert.Equal(t, QuotaScans.UserScans[0].StartTime, usersScans[0].StartTime)
  523. QuotaScans.UserScans[0].StartTime = 0
  524. assert.NotEqual(t, QuotaScans.UserScans[0].StartTime, usersScans[0].StartTime)
  525. }
  526. assert.True(t, QuotaScans.RemoveUserQuotaScan(username))
  527. assert.False(t, QuotaScans.RemoveUserQuotaScan(username))
  528. assert.Len(t, QuotaScans.GetUsersQuotaScans(), 0)
  529. assert.Len(t, usersScans, 1)
  530. folderName := "folder"
  531. assert.True(t, QuotaScans.AddVFolderQuotaScan(folderName))
  532. assert.False(t, QuotaScans.AddVFolderQuotaScan(folderName))
  533. if assert.Len(t, QuotaScans.GetVFoldersQuotaScans(), 1) {
  534. assert.Equal(t, QuotaScans.GetVFoldersQuotaScans()[0].Name, folderName)
  535. }
  536. assert.True(t, QuotaScans.RemoveVFolderQuotaScan(folderName))
  537. assert.False(t, QuotaScans.RemoveVFolderQuotaScan(folderName))
  538. assert.Len(t, QuotaScans.GetVFoldersQuotaScans(), 0)
  539. }
  540. func TestProxyProtocolVersion(t *testing.T) {
  541. c := Configuration{
  542. ProxyProtocol: 0,
  543. }
  544. _, err := c.GetProxyListener(nil)
  545. if assert.Error(t, err) {
  546. assert.Contains(t, err.Error(), "proxy protocol not configured")
  547. }
  548. c.ProxyProtocol = 1
  549. proxyListener, err := c.GetProxyListener(nil)
  550. assert.NoError(t, err)
  551. assert.Nil(t, proxyListener.Policy)
  552. c.ProxyProtocol = 2
  553. proxyListener, err = c.GetProxyListener(nil)
  554. assert.NoError(t, err)
  555. assert.NotNil(t, proxyListener.Policy)
  556. c.ProxyProtocol = 1
  557. c.ProxyAllowed = []string{"invalid"}
  558. _, err = c.GetProxyListener(nil)
  559. assert.Error(t, err)
  560. c.ProxyProtocol = 2
  561. _, err = c.GetProxyListener(nil)
  562. assert.Error(t, err)
  563. }
  564. func TestStartupHook(t *testing.T) {
  565. Config.StartupHook = ""
  566. assert.NoError(t, Config.ExecuteStartupHook())
  567. Config.StartupHook = "http://foo\x7f.com/startup"
  568. assert.Error(t, Config.ExecuteStartupHook())
  569. Config.StartupHook = "http://invalid:5678/"
  570. assert.Error(t, Config.ExecuteStartupHook())
  571. Config.StartupHook = fmt.Sprintf("http://%v", httpAddr)
  572. assert.NoError(t, Config.ExecuteStartupHook())
  573. Config.StartupHook = "invalidhook"
  574. assert.Error(t, Config.ExecuteStartupHook())
  575. if runtime.GOOS != osWindows {
  576. hookCmd, err := exec.LookPath("true")
  577. assert.NoError(t, err)
  578. Config.StartupHook = hookCmd
  579. assert.NoError(t, Config.ExecuteStartupHook())
  580. }
  581. Config.StartupHook = ""
  582. }
  583. func TestPostDisconnectHook(t *testing.T) {
  584. Config.PostDisconnectHook = "http://127.0.0.1/"
  585. remoteAddr := "127.0.0.1:80"
  586. Config.checkPostDisconnectHook(remoteAddr, ProtocolHTTP, "", "", time.Now())
  587. Config.checkPostDisconnectHook(remoteAddr, ProtocolSFTP, "", "", time.Now())
  588. Config.PostDisconnectHook = "http://bar\x7f.com/"
  589. Config.executePostDisconnectHook(remoteAddr, ProtocolSFTP, "", "", time.Now())
  590. Config.PostDisconnectHook = fmt.Sprintf("http://%v", httpAddr)
  591. Config.executePostDisconnectHook(remoteAddr, ProtocolSFTP, "", "", time.Now())
  592. Config.PostDisconnectHook = "relativePath"
  593. Config.executePostDisconnectHook(remoteAddr, ProtocolSFTP, "", "", time.Now())
  594. if runtime.GOOS == osWindows {
  595. Config.PostDisconnectHook = "C:\\a\\bad\\command"
  596. Config.executePostDisconnectHook(remoteAddr, ProtocolSFTP, "", "", time.Now())
  597. } else {
  598. Config.PostDisconnectHook = "/invalid/path"
  599. Config.executePostDisconnectHook(remoteAddr, ProtocolSFTP, "", "", time.Now())
  600. hookCmd, err := exec.LookPath("true")
  601. assert.NoError(t, err)
  602. Config.PostDisconnectHook = hookCmd
  603. Config.executePostDisconnectHook(remoteAddr, ProtocolSFTP, "", "", time.Now())
  604. }
  605. Config.PostDisconnectHook = ""
  606. }
  607. func TestPostConnectHook(t *testing.T) {
  608. Config.PostConnectHook = ""
  609. ipAddr := "127.0.0.1"
  610. assert.NoError(t, Config.ExecutePostConnectHook(ipAddr, ProtocolFTP))
  611. Config.PostConnectHook = "http://foo\x7f.com/"
  612. assert.Error(t, Config.ExecutePostConnectHook(ipAddr, ProtocolSFTP))
  613. Config.PostConnectHook = "http://invalid:1234/"
  614. assert.Error(t, Config.ExecutePostConnectHook(ipAddr, ProtocolSFTP))
  615. Config.PostConnectHook = fmt.Sprintf("http://%v/404", httpAddr)
  616. assert.Error(t, Config.ExecutePostConnectHook(ipAddr, ProtocolFTP))
  617. Config.PostConnectHook = fmt.Sprintf("http://%v", httpAddr)
  618. assert.NoError(t, Config.ExecutePostConnectHook(ipAddr, ProtocolFTP))
  619. Config.PostConnectHook = "invalid"
  620. assert.Error(t, Config.ExecutePostConnectHook(ipAddr, ProtocolFTP))
  621. if runtime.GOOS == osWindows {
  622. Config.PostConnectHook = "C:\\bad\\command"
  623. assert.Error(t, Config.ExecutePostConnectHook(ipAddr, ProtocolSFTP))
  624. } else {
  625. Config.PostConnectHook = "/invalid/path"
  626. assert.Error(t, Config.ExecutePostConnectHook(ipAddr, ProtocolSFTP))
  627. hookCmd, err := exec.LookPath("true")
  628. assert.NoError(t, err)
  629. Config.PostConnectHook = hookCmd
  630. assert.NoError(t, Config.ExecutePostConnectHook(ipAddr, ProtocolSFTP))
  631. }
  632. Config.PostConnectHook = ""
  633. }
  634. func TestCryptoConvertFileInfo(t *testing.T) {
  635. name := "name"
  636. fs, err := vfs.NewCryptFs("connID1", os.TempDir(), "", vfs.CryptFsConfig{
  637. Passphrase: kms.NewPlainSecret("secret"),
  638. })
  639. require.NoError(t, err)
  640. cryptFs := fs.(*vfs.CryptFs)
  641. info := vfs.NewFileInfo(name, true, 48, time.Now(), false)
  642. assert.Equal(t, info, cryptFs.ConvertFileInfo(info))
  643. info = vfs.NewFileInfo(name, false, 48, time.Now(), false)
  644. assert.NotEqual(t, info.Size(), cryptFs.ConvertFileInfo(info).Size())
  645. info = vfs.NewFileInfo(name, false, 33, time.Now(), false)
  646. assert.Equal(t, int64(0), cryptFs.ConvertFileInfo(info).Size())
  647. info = vfs.NewFileInfo(name, false, 1, time.Now(), false)
  648. assert.Equal(t, int64(0), cryptFs.ConvertFileInfo(info).Size())
  649. }
  650. func TestFolderCopy(t *testing.T) {
  651. folder := vfs.BaseVirtualFolder{
  652. ID: 1,
  653. Name: "name",
  654. MappedPath: filepath.Clean(os.TempDir()),
  655. UsedQuotaSize: 4096,
  656. UsedQuotaFiles: 2,
  657. LastQuotaUpdate: util.GetTimeAsMsSinceEpoch(time.Now()),
  658. Users: []string{"user1", "user2"},
  659. }
  660. folderCopy := folder.GetACopy()
  661. folder.ID = 2
  662. folder.Users = []string{"user3"}
  663. require.Len(t, folderCopy.Users, 2)
  664. require.True(t, util.IsStringInSlice("user1", folderCopy.Users))
  665. require.True(t, util.IsStringInSlice("user2", folderCopy.Users))
  666. require.Equal(t, int64(1), folderCopy.ID)
  667. require.Equal(t, folder.Name, folderCopy.Name)
  668. require.Equal(t, folder.MappedPath, folderCopy.MappedPath)
  669. require.Equal(t, folder.UsedQuotaSize, folderCopy.UsedQuotaSize)
  670. require.Equal(t, folder.UsedQuotaFiles, folderCopy.UsedQuotaFiles)
  671. require.Equal(t, folder.LastQuotaUpdate, folderCopy.LastQuotaUpdate)
  672. folder.FsConfig = vfs.Filesystem{
  673. CryptConfig: vfs.CryptFsConfig{
  674. Passphrase: kms.NewPlainSecret("crypto secret"),
  675. },
  676. }
  677. folderCopy = folder.GetACopy()
  678. folder.FsConfig.CryptConfig.Passphrase = kms.NewEmptySecret()
  679. require.Len(t, folderCopy.Users, 1)
  680. require.True(t, util.IsStringInSlice("user3", folderCopy.Users))
  681. require.Equal(t, int64(2), folderCopy.ID)
  682. require.Equal(t, folder.Name, folderCopy.Name)
  683. require.Equal(t, folder.MappedPath, folderCopy.MappedPath)
  684. require.Equal(t, folder.UsedQuotaSize, folderCopy.UsedQuotaSize)
  685. require.Equal(t, folder.UsedQuotaFiles, folderCopy.UsedQuotaFiles)
  686. require.Equal(t, folder.LastQuotaUpdate, folderCopy.LastQuotaUpdate)
  687. require.Equal(t, "crypto secret", folderCopy.FsConfig.CryptConfig.Passphrase.GetPayload())
  688. }
  689. func TestCachedFs(t *testing.T) {
  690. user := dataprovider.User{
  691. BaseUser: sdk.BaseUser{
  692. HomeDir: filepath.Clean(os.TempDir()),
  693. },
  694. }
  695. conn := NewBaseConnection("id", ProtocolSFTP, "", "", user)
  696. // changing the user should not affect the connection
  697. user.HomeDir = filepath.Join(os.TempDir(), "temp")
  698. err := os.Mkdir(user.HomeDir, os.ModePerm)
  699. assert.NoError(t, err)
  700. fs, err := user.GetFilesystem("")
  701. assert.NoError(t, err)
  702. p, err := fs.ResolvePath("/")
  703. assert.NoError(t, err)
  704. assert.Equal(t, user.GetHomeDir(), p)
  705. _, p, err = conn.GetFsAndResolvedPath("/")
  706. assert.NoError(t, err)
  707. assert.Equal(t, filepath.Clean(os.TempDir()), p)
  708. user.FsConfig.Provider = sdk.S3FilesystemProvider
  709. _, err = user.GetFilesystem("")
  710. assert.Error(t, err)
  711. conn.User.FsConfig.Provider = sdk.S3FilesystemProvider
  712. _, p, err = conn.GetFsAndResolvedPath("/")
  713. assert.NoError(t, err)
  714. assert.Equal(t, filepath.Clean(os.TempDir()), p)
  715. err = os.Remove(user.HomeDir)
  716. assert.NoError(t, err)
  717. }
  718. func TestParseAllowedIPAndRanges(t *testing.T) {
  719. _, err := util.ParseAllowedIPAndRanges([]string{"1.1.1.1", "not an ip"})
  720. assert.Error(t, err)
  721. _, err = util.ParseAllowedIPAndRanges([]string{"1.1.1.5", "192.168.1.0/240"})
  722. assert.Error(t, err)
  723. allow, err := util.ParseAllowedIPAndRanges([]string{"192.168.1.2", "172.16.0.0/24"})
  724. assert.NoError(t, err)
  725. assert.True(t, allow[0](net.ParseIP("192.168.1.2")))
  726. assert.False(t, allow[0](net.ParseIP("192.168.2.2")))
  727. assert.True(t, allow[1](net.ParseIP("172.16.0.1")))
  728. assert.False(t, allow[1](net.ParseIP("172.16.1.1")))
  729. }
  730. func TestHideConfidentialData(t *testing.T) {
  731. for _, provider := range []sdk.FilesystemProvider{sdk.LocalFilesystemProvider,
  732. sdk.CryptedFilesystemProvider, sdk.S3FilesystemProvider, sdk.GCSFilesystemProvider,
  733. sdk.AzureBlobFilesystemProvider, sdk.SFTPFilesystemProvider,
  734. } {
  735. u := dataprovider.User{
  736. FsConfig: vfs.Filesystem{
  737. Provider: provider,
  738. },
  739. }
  740. u.PrepareForRendering()
  741. f := vfs.BaseVirtualFolder{
  742. FsConfig: vfs.Filesystem{
  743. Provider: provider,
  744. },
  745. }
  746. f.PrepareForRendering()
  747. }
  748. a := dataprovider.Admin{}
  749. a.HideConfidentialData()
  750. }
  751. func TestUserPerms(t *testing.T) {
  752. u := dataprovider.User{}
  753. u.Permissions = make(map[string][]string)
  754. u.Permissions["/"] = []string{dataprovider.PermUpload, dataprovider.PermDelete}
  755. assert.True(t, u.HasAnyPerm([]string{dataprovider.PermRename, dataprovider.PermDelete}, "/"))
  756. assert.False(t, u.HasAnyPerm([]string{dataprovider.PermRename, dataprovider.PermCreateDirs}, "/"))
  757. u.Permissions["/"] = []string{dataprovider.PermDelete, dataprovider.PermCreateDirs}
  758. assert.True(t, u.HasPermsDeleteAll("/"))
  759. assert.False(t, u.HasPermsRenameAll("/"))
  760. u.Permissions["/"] = []string{dataprovider.PermDeleteDirs, dataprovider.PermDeleteFiles, dataprovider.PermRenameDirs}
  761. assert.True(t, u.HasPermsDeleteAll("/"))
  762. assert.False(t, u.HasPermsRenameAll("/"))
  763. u.Permissions["/"] = []string{dataprovider.PermDeleteDirs, dataprovider.PermRenameFiles, dataprovider.PermRenameDirs}
  764. assert.False(t, u.HasPermsDeleteAll("/"))
  765. assert.True(t, u.HasPermsRenameAll("/"))
  766. }
  767. func TestGetTLSVersion(t *testing.T) {
  768. tlsVer := util.GetTLSVersion(0)
  769. assert.Equal(t, uint16(tls.VersionTLS12), tlsVer)
  770. tlsVer = util.GetTLSVersion(12)
  771. assert.Equal(t, uint16(tls.VersionTLS12), tlsVer)
  772. tlsVer = util.GetTLSVersion(2)
  773. assert.Equal(t, uint16(tls.VersionTLS12), tlsVer)
  774. tlsVer = util.GetTLSVersion(13)
  775. assert.Equal(t, uint16(tls.VersionTLS13), tlsVer)
  776. }
  777. func TestCleanPath(t *testing.T) {
  778. assert.Equal(t, "/", util.CleanPath("/"))
  779. assert.Equal(t, "/", util.CleanPath("."))
  780. assert.Equal(t, "/", util.CleanPath(""))
  781. assert.Equal(t, "/", util.CleanPath("/."))
  782. assert.Equal(t, "/", util.CleanPath("/a/.."))
  783. assert.Equal(t, "/a", util.CleanPath("/a/"))
  784. assert.Equal(t, "/a", util.CleanPath("a/"))
  785. // filepath.ToSlash does not touch \ as char on unix systems
  786. // so os.PathSeparator is used for windows compatible tests
  787. bslash := string(os.PathSeparator)
  788. assert.Equal(t, "/", util.CleanPath(bslash))
  789. assert.Equal(t, "/", util.CleanPath(bslash+bslash))
  790. assert.Equal(t, "/a", util.CleanPath(bslash+"a"+bslash))
  791. assert.Equal(t, "/a", util.CleanPath("a"+bslash))
  792. assert.Equal(t, "/a/b/c", util.CleanPath(bslash+"a"+bslash+bslash+"b"+bslash+bslash+"c"+bslash))
  793. assert.Equal(t, "/C:/a", util.CleanPath("C:"+bslash+"a"))
  794. }
  795. func TestUserRecentActivity(t *testing.T) {
  796. u := dataprovider.User{}
  797. res := u.HasRecentActivity()
  798. assert.False(t, res)
  799. u.LastLogin = util.GetTimeAsMsSinceEpoch(time.Now())
  800. res = u.HasRecentActivity()
  801. assert.True(t, res)
  802. u.LastLogin = util.GetTimeAsMsSinceEpoch(time.Now().Add(1 * time.Minute))
  803. res = u.HasRecentActivity()
  804. assert.False(t, res)
  805. u.LastLogin = util.GetTimeAsMsSinceEpoch(time.Now().Add(1 * time.Second))
  806. res = u.HasRecentActivity()
  807. assert.True(t, res)
  808. }
  809. func BenchmarkBcryptHashing(b *testing.B) {
  810. bcryptPassword := "bcryptpassword"
  811. for i := 0; i < b.N; i++ {
  812. _, err := bcrypt.GenerateFromPassword([]byte(bcryptPassword), 10)
  813. if err != nil {
  814. panic(err)
  815. }
  816. }
  817. }
  818. func BenchmarkCompareBcryptPassword(b *testing.B) {
  819. bcryptPassword := "$2a$10$lPDdnDimJZ7d5/GwL6xDuOqoZVRXok6OHHhivCnanWUtcgN0Zafki"
  820. for i := 0; i < b.N; i++ {
  821. err := bcrypt.CompareHashAndPassword([]byte(bcryptPassword), []byte("password"))
  822. if err != nil {
  823. panic(err)
  824. }
  825. }
  826. }
  827. func BenchmarkArgon2Hashing(b *testing.B) {
  828. argonPassword := "argon2password"
  829. for i := 0; i < b.N; i++ {
  830. _, err := argon2id.CreateHash(argonPassword, argon2id.DefaultParams)
  831. if err != nil {
  832. panic(err)
  833. }
  834. }
  835. }
  836. func BenchmarkCompareArgon2Password(b *testing.B) {
  837. argon2Password := "$argon2id$v=19$m=65536,t=1,p=2$aOoAOdAwvzhOgi7wUFjXlw$wn/y37dBWdKHtPXHR03nNaKHWKPXyNuVXOknaU+YZ+s"
  838. for i := 0; i < b.N; i++ {
  839. _, err := argon2id.ComparePasswordAndHash("password", argon2Password)
  840. if err != nil {
  841. panic(err)
  842. }
  843. }
  844. }