common_test.go 32 KB

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