common_test.go 28 KB

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