common_test.go 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529
  1. // Copyright (C) 2019-2022 Nicola Murino
  2. //
  3. // This program is free software: you can redistribute it and/or modify
  4. // it under the terms of the GNU Affero General Public License as published
  5. // by the Free Software Foundation, version 3.
  6. //
  7. // This program is distributed in the hope that it will be useful,
  8. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. // GNU Affero General Public License for more details.
  11. //
  12. // You should have received a copy of the GNU Affero General Public License
  13. // along with this program. If not, see <https://www.gnu.org/licenses/>.
  14. package common
  15. import (
  16. "crypto/tls"
  17. "encoding/json"
  18. "fmt"
  19. "net"
  20. "os"
  21. "os/exec"
  22. "path/filepath"
  23. "runtime"
  24. "strings"
  25. "sync"
  26. "testing"
  27. "time"
  28. "github.com/alexedwards/argon2id"
  29. "github.com/sftpgo/sdk"
  30. "github.com/stretchr/testify/assert"
  31. "github.com/stretchr/testify/require"
  32. "golang.org/x/crypto/bcrypt"
  33. "github.com/drakkan/sftpgo/v2/internal/dataprovider"
  34. "github.com/drakkan/sftpgo/v2/internal/kms"
  35. "github.com/drakkan/sftpgo/v2/internal/plugin"
  36. "github.com/drakkan/sftpgo/v2/internal/util"
  37. "github.com/drakkan/sftpgo/v2/internal/vfs"
  38. )
  39. const (
  40. logSenderTest = "common_test"
  41. httpAddr = "127.0.0.1:9999"
  42. osWindows = "windows"
  43. userTestUsername = "common_test_username"
  44. )
  45. var (
  46. configDir = filepath.Join(".", "..", "..")
  47. )
  48. type fakeConnection struct {
  49. *BaseConnection
  50. command string
  51. }
  52. func (c *fakeConnection) AddUser(user dataprovider.User) error {
  53. _, err := user.GetFilesystem(c.GetID())
  54. if err != nil {
  55. return err
  56. }
  57. c.BaseConnection.User = user
  58. return nil
  59. }
  60. func (c *fakeConnection) Disconnect() error {
  61. Connections.Remove(c.GetID())
  62. return nil
  63. }
  64. func (c *fakeConnection) GetClientVersion() string {
  65. return ""
  66. }
  67. func (c *fakeConnection) GetCommand() string {
  68. return c.command
  69. }
  70. func (c *fakeConnection) GetLocalAddress() string {
  71. return ""
  72. }
  73. func (c *fakeConnection) GetRemoteAddress() string {
  74. return ""
  75. }
  76. type customNetConn struct {
  77. net.Conn
  78. id string
  79. isClosed bool
  80. }
  81. func (c *customNetConn) Close() error {
  82. Connections.RemoveSSHConnection(c.id)
  83. c.isClosed = true
  84. return c.Conn.Close()
  85. }
  86. func TestConnections(t *testing.T) {
  87. c1 := &fakeConnection{
  88. BaseConnection: NewBaseConnection("id1", ProtocolSFTP, "", "", dataprovider.User{
  89. BaseUser: sdk.BaseUser{
  90. Username: userTestUsername,
  91. },
  92. }),
  93. }
  94. c2 := &fakeConnection{
  95. BaseConnection: NewBaseConnection("id2", ProtocolSFTP, "", "", dataprovider.User{
  96. BaseUser: sdk.BaseUser{
  97. Username: userTestUsername,
  98. },
  99. }),
  100. }
  101. c3 := &fakeConnection{
  102. BaseConnection: NewBaseConnection("id3", ProtocolSFTP, "", "", dataprovider.User{
  103. BaseUser: sdk.BaseUser{
  104. Username: userTestUsername,
  105. },
  106. }),
  107. }
  108. c4 := &fakeConnection{
  109. BaseConnection: NewBaseConnection("id4", ProtocolSFTP, "", "", dataprovider.User{
  110. BaseUser: sdk.BaseUser{
  111. Username: userTestUsername,
  112. },
  113. }),
  114. }
  115. assert.Equal(t, "SFTP_id1", c1.GetID())
  116. assert.Equal(t, "SFTP_id2", c2.GetID())
  117. assert.Equal(t, "SFTP_id3", c3.GetID())
  118. assert.Equal(t, "SFTP_id4", c4.GetID())
  119. err := Connections.Add(c1)
  120. assert.NoError(t, err)
  121. err = Connections.Add(c2)
  122. assert.NoError(t, err)
  123. err = Connections.Add(c3)
  124. assert.NoError(t, err)
  125. err = Connections.Add(c4)
  126. assert.NoError(t, err)
  127. Connections.RLock()
  128. assert.Len(t, Connections.connections, 4)
  129. assert.Len(t, Connections.mapping, 4)
  130. _, ok := Connections.mapping[c1.GetID()]
  131. assert.True(t, ok)
  132. assert.Equal(t, 0, Connections.mapping[c1.GetID()])
  133. assert.Equal(t, 1, Connections.mapping[c2.GetID()])
  134. assert.Equal(t, 2, Connections.mapping[c3.GetID()])
  135. assert.Equal(t, 3, Connections.mapping[c4.GetID()])
  136. Connections.RUnlock()
  137. c2 = &fakeConnection{
  138. BaseConnection: NewBaseConnection("id2", ProtocolSFTP, "", "", dataprovider.User{
  139. BaseUser: sdk.BaseUser{
  140. Username: userTestUsername + "_mod",
  141. },
  142. }),
  143. }
  144. err = Connections.Swap(c2)
  145. assert.NoError(t, err)
  146. Connections.RLock()
  147. assert.Len(t, Connections.connections, 4)
  148. assert.Len(t, Connections.mapping, 4)
  149. _, ok = Connections.mapping[c1.GetID()]
  150. assert.True(t, ok)
  151. assert.Equal(t, 0, Connections.mapping[c1.GetID()])
  152. assert.Equal(t, 1, Connections.mapping[c2.GetID()])
  153. assert.Equal(t, 2, Connections.mapping[c3.GetID()])
  154. assert.Equal(t, 3, Connections.mapping[c4.GetID()])
  155. assert.Equal(t, userTestUsername+"_mod", Connections.connections[1].GetUsername())
  156. Connections.RUnlock()
  157. Connections.Remove(c2.GetID())
  158. Connections.RLock()
  159. assert.Len(t, Connections.connections, 3)
  160. assert.Len(t, Connections.mapping, 3)
  161. _, ok = Connections.mapping[c1.GetID()]
  162. assert.True(t, ok)
  163. assert.Equal(t, 0, Connections.mapping[c1.GetID()])
  164. assert.Equal(t, 1, Connections.mapping[c4.GetID()])
  165. assert.Equal(t, 2, Connections.mapping[c3.GetID()])
  166. Connections.RUnlock()
  167. Connections.Remove(c3.GetID())
  168. Connections.RLock()
  169. assert.Len(t, Connections.connections, 2)
  170. assert.Len(t, Connections.mapping, 2)
  171. _, ok = Connections.mapping[c1.GetID()]
  172. assert.True(t, ok)
  173. assert.Equal(t, 0, Connections.mapping[c1.GetID()])
  174. assert.Equal(t, 1, Connections.mapping[c4.GetID()])
  175. Connections.RUnlock()
  176. Connections.Remove(c1.GetID())
  177. Connections.RLock()
  178. assert.Len(t, Connections.connections, 1)
  179. assert.Len(t, Connections.mapping, 1)
  180. _, ok = Connections.mapping[c4.GetID()]
  181. assert.True(t, ok)
  182. assert.Equal(t, 0, Connections.mapping[c4.GetID()])
  183. Connections.RUnlock()
  184. Connections.Remove(c4.GetID())
  185. Connections.RLock()
  186. assert.Len(t, Connections.connections, 0)
  187. assert.Len(t, Connections.mapping, 0)
  188. Connections.RUnlock()
  189. }
  190. func TestSSHConnections(t *testing.T) {
  191. conn1, conn2 := net.Pipe()
  192. now := time.Now()
  193. sshConn1 := NewSSHConnection("id1", conn1)
  194. sshConn2 := NewSSHConnection("id2", conn2)
  195. sshConn3 := NewSSHConnection("id3", conn2)
  196. assert.Equal(t, "id1", sshConn1.GetID())
  197. assert.Equal(t, "id2", sshConn2.GetID())
  198. assert.Equal(t, "id3", sshConn3.GetID())
  199. sshConn1.UpdateLastActivity()
  200. assert.GreaterOrEqual(t, sshConn1.GetLastActivity().UnixNano(), now.UnixNano())
  201. Connections.AddSSHConnection(sshConn1)
  202. Connections.AddSSHConnection(sshConn2)
  203. Connections.AddSSHConnection(sshConn3)
  204. Connections.RLock()
  205. assert.Len(t, Connections.sshConnections, 3)
  206. _, ok := Connections.sshMapping[sshConn1.GetID()]
  207. assert.True(t, ok)
  208. assert.Equal(t, 0, Connections.sshMapping[sshConn1.GetID()])
  209. assert.Equal(t, 1, Connections.sshMapping[sshConn2.GetID()])
  210. assert.Equal(t, 2, Connections.sshMapping[sshConn3.GetID()])
  211. Connections.RUnlock()
  212. Connections.RemoveSSHConnection(sshConn1.id)
  213. Connections.RLock()
  214. assert.Len(t, Connections.sshConnections, 2)
  215. assert.Equal(t, sshConn3.id, Connections.sshConnections[0].id)
  216. assert.Equal(t, sshConn2.id, Connections.sshConnections[1].id)
  217. _, ok = Connections.sshMapping[sshConn3.GetID()]
  218. assert.True(t, ok)
  219. assert.Equal(t, 0, Connections.sshMapping[sshConn3.GetID()])
  220. assert.Equal(t, 1, Connections.sshMapping[sshConn2.GetID()])
  221. Connections.RUnlock()
  222. Connections.RemoveSSHConnection(sshConn1.id)
  223. Connections.RLock()
  224. assert.Len(t, Connections.sshConnections, 2)
  225. assert.Equal(t, sshConn3.id, Connections.sshConnections[0].id)
  226. assert.Equal(t, sshConn2.id, Connections.sshConnections[1].id)
  227. _, ok = Connections.sshMapping[sshConn3.GetID()]
  228. assert.True(t, ok)
  229. assert.Equal(t, 0, Connections.sshMapping[sshConn3.GetID()])
  230. assert.Equal(t, 1, Connections.sshMapping[sshConn2.GetID()])
  231. Connections.RUnlock()
  232. Connections.RemoveSSHConnection(sshConn2.id)
  233. Connections.RLock()
  234. assert.Len(t, Connections.sshConnections, 1)
  235. assert.Equal(t, sshConn3.id, Connections.sshConnections[0].id)
  236. _, ok = Connections.sshMapping[sshConn3.GetID()]
  237. assert.True(t, ok)
  238. assert.Equal(t, 0, Connections.sshMapping[sshConn3.GetID()])
  239. Connections.RUnlock()
  240. Connections.RemoveSSHConnection(sshConn3.id)
  241. Connections.RLock()
  242. assert.Len(t, Connections.sshConnections, 0)
  243. assert.Len(t, Connections.sshMapping, 0)
  244. Connections.RUnlock()
  245. assert.NoError(t, sshConn1.Close())
  246. assert.NoError(t, sshConn2.Close())
  247. assert.NoError(t, sshConn3.Close())
  248. }
  249. func TestDefenderIntegration(t *testing.T) {
  250. // by default defender is nil
  251. configCopy := Config
  252. wdPath, err := os.Getwd()
  253. require.NoError(t, err)
  254. pluginsConfig := []plugin.Config{
  255. {
  256. Type: "ipfilter",
  257. Cmd: filepath.Join(wdPath, "..", "..", "tests", "ipfilter", "ipfilter"),
  258. AutoMTLS: true,
  259. },
  260. }
  261. if runtime.GOOS == osWindows {
  262. pluginsConfig[0].Cmd += ".exe"
  263. }
  264. err = plugin.Initialize(pluginsConfig, "debug")
  265. require.NoError(t, err)
  266. ip := "127.1.1.1"
  267. assert.Nil(t, Reload())
  268. // 192.168.1.12 is banned from the ipfilter plugin
  269. assert.True(t, IsBanned("192.168.1.12"))
  270. AddDefenderEvent(ip, HostEventNoLoginTried)
  271. assert.False(t, IsBanned(ip))
  272. banTime, err := GetDefenderBanTime(ip)
  273. assert.NoError(t, err)
  274. assert.Nil(t, banTime)
  275. assert.False(t, DeleteDefenderHost(ip))
  276. score, err := GetDefenderScore(ip)
  277. assert.NoError(t, err)
  278. assert.Equal(t, 0, score)
  279. _, err = GetDefenderHost(ip)
  280. assert.Error(t, err)
  281. hosts, err := GetDefenderHosts()
  282. assert.NoError(t, err)
  283. assert.Nil(t, hosts)
  284. Config.DefenderConfig = DefenderConfig{
  285. Enabled: true,
  286. Driver: DefenderDriverProvider,
  287. BanTime: 10,
  288. BanTimeIncrement: 50,
  289. Threshold: 0,
  290. ScoreInvalid: 2,
  291. ScoreValid: 1,
  292. ObservationTime: 15,
  293. EntriesSoftLimit: 100,
  294. EntriesHardLimit: 150,
  295. }
  296. err = Initialize(Config, 0)
  297. // ScoreInvalid cannot be greater than threshold
  298. assert.Error(t, err)
  299. Config.DefenderConfig.Driver = "unsupported"
  300. err = Initialize(Config, 0)
  301. if assert.Error(t, err) {
  302. assert.Contains(t, err.Error(), "unsupported defender driver")
  303. }
  304. Config.DefenderConfig.Driver = DefenderDriverMemory
  305. err = Initialize(Config, 0)
  306. // ScoreInvalid cannot be greater than threshold
  307. assert.Error(t, err)
  308. Config.DefenderConfig.Threshold = 3
  309. Config.DefenderConfig.SafeListFile = filepath.Join(os.TempDir(), "sl.json")
  310. err = os.WriteFile(Config.DefenderConfig.SafeListFile, []byte(`{}`), 0644)
  311. assert.NoError(t, err)
  312. defer os.Remove(Config.DefenderConfig.SafeListFile)
  313. err = Initialize(Config, 0)
  314. assert.NoError(t, err)
  315. assert.Nil(t, Reload())
  316. err = os.WriteFile(Config.DefenderConfig.SafeListFile, []byte(`{`), 0644)
  317. assert.NoError(t, err)
  318. err = Reload()
  319. assert.Error(t, err)
  320. AddDefenderEvent(ip, HostEventNoLoginTried)
  321. assert.False(t, IsBanned(ip))
  322. score, err = GetDefenderScore(ip)
  323. assert.NoError(t, err)
  324. assert.Equal(t, 2, score)
  325. entry, err := GetDefenderHost(ip)
  326. assert.NoError(t, err)
  327. asJSON, err := json.Marshal(&entry)
  328. assert.NoError(t, err)
  329. assert.Equal(t, `{"id":"3132372e312e312e31","ip":"127.1.1.1","score":2}`, string(asJSON), "entry %v", entry)
  330. assert.True(t, DeleteDefenderHost(ip))
  331. banTime, err = GetDefenderBanTime(ip)
  332. assert.NoError(t, err)
  333. assert.Nil(t, banTime)
  334. AddDefenderEvent(ip, HostEventLoginFailed)
  335. AddDefenderEvent(ip, HostEventNoLoginTried)
  336. assert.True(t, IsBanned(ip))
  337. score, err = GetDefenderScore(ip)
  338. assert.NoError(t, err)
  339. assert.Equal(t, 0, score)
  340. banTime, err = GetDefenderBanTime(ip)
  341. assert.NoError(t, err)
  342. assert.NotNil(t, banTime)
  343. hosts, err = GetDefenderHosts()
  344. assert.NoError(t, err)
  345. assert.Len(t, hosts, 1)
  346. entry, err = GetDefenderHost(ip)
  347. assert.NoError(t, err)
  348. assert.False(t, entry.BanTime.IsZero())
  349. assert.True(t, DeleteDefenderHost(ip))
  350. hosts, err = GetDefenderHosts()
  351. assert.NoError(t, err)
  352. assert.Len(t, hosts, 0)
  353. banTime, err = GetDefenderBanTime(ip)
  354. assert.NoError(t, err)
  355. assert.Nil(t, banTime)
  356. assert.False(t, DeleteDefenderHost(ip))
  357. Config = configCopy
  358. }
  359. func TestRateLimitersIntegration(t *testing.T) {
  360. // by default defender is nil
  361. configCopy := Config
  362. Config.RateLimitersConfig = []RateLimiterConfig{
  363. {
  364. Average: 100,
  365. Period: 10,
  366. Burst: 5,
  367. Type: int(rateLimiterTypeGlobal),
  368. Protocols: rateLimiterProtocolValues,
  369. },
  370. {
  371. Average: 1,
  372. Period: 1000,
  373. Burst: 1,
  374. Type: int(rateLimiterTypeSource),
  375. Protocols: []string{ProtocolWebDAV, ProtocolWebDAV, ProtocolFTP},
  376. GenerateDefenderEvents: true,
  377. EntriesSoftLimit: 100,
  378. EntriesHardLimit: 150,
  379. },
  380. }
  381. err := Initialize(Config, 0)
  382. assert.Error(t, err)
  383. Config.RateLimitersConfig[0].Period = 1000
  384. Config.RateLimitersConfig[0].AllowList = []string{"1.1.1", "1.1.1.2"}
  385. err = Initialize(Config, 0)
  386. if assert.Error(t, err) {
  387. assert.Contains(t, err.Error(), "unable to parse rate limiter allow list")
  388. }
  389. Config.RateLimitersConfig[0].AllowList = []string{"172.16.24.7"}
  390. Config.RateLimitersConfig[1].AllowList = []string{"172.16.0.0/16"}
  391. err = Initialize(Config, 0)
  392. assert.NoError(t, err)
  393. assert.Len(t, rateLimiters, 4)
  394. assert.Len(t, rateLimiters[ProtocolSSH], 1)
  395. assert.Len(t, rateLimiters[ProtocolFTP], 2)
  396. assert.Len(t, rateLimiters[ProtocolWebDAV], 2)
  397. assert.Len(t, rateLimiters[ProtocolHTTP], 1)
  398. source1 := "127.1.1.1"
  399. source2 := "127.1.1.2"
  400. source3 := "172.16.24.7" // whitelisted
  401. _, err = LimitRate(ProtocolSSH, source1)
  402. assert.NoError(t, err)
  403. _, err = LimitRate(ProtocolFTP, source1)
  404. assert.NoError(t, err)
  405. // sleep to allow the add configured burst to the token.
  406. // This sleep is not enough to add the per-source burst
  407. time.Sleep(20 * time.Millisecond)
  408. _, err = LimitRate(ProtocolWebDAV, source2)
  409. assert.NoError(t, err)
  410. _, err = LimitRate(ProtocolFTP, source1)
  411. assert.Error(t, err)
  412. _, err = LimitRate(ProtocolWebDAV, source2)
  413. assert.Error(t, err)
  414. _, err = LimitRate(ProtocolSSH, source1)
  415. assert.NoError(t, err)
  416. _, err = LimitRate(ProtocolSSH, source2)
  417. assert.NoError(t, err)
  418. for i := 0; i < 10; i++ {
  419. _, err = LimitRate(ProtocolWebDAV, source3)
  420. assert.NoError(t, err)
  421. }
  422. Config = configCopy
  423. }
  424. func TestWhitelist(t *testing.T) {
  425. configCopy := Config
  426. Config.whitelist = &whitelist{}
  427. err := Config.whitelist.reload()
  428. if assert.Error(t, err) {
  429. assert.Contains(t, err.Error(), "cannot accept a nil whitelist")
  430. }
  431. wlFile := filepath.Join(os.TempDir(), "wl.json")
  432. Config.WhiteListFile = wlFile
  433. err = os.WriteFile(wlFile, []byte(`invalid list file`), 0664)
  434. assert.NoError(t, err)
  435. err = Initialize(Config, 0)
  436. assert.Error(t, err)
  437. wl := HostListFile{
  438. IPAddresses: []string{"172.18.1.1", "172.18.1.2"},
  439. CIDRNetworks: []string{"10.8.7.0/24"},
  440. }
  441. data, err := json.Marshal(wl)
  442. assert.NoError(t, err)
  443. err = os.WriteFile(wlFile, data, 0664)
  444. assert.NoError(t, err)
  445. defer os.Remove(wlFile)
  446. err = Initialize(Config, 0)
  447. assert.NoError(t, err)
  448. assert.NoError(t, Connections.IsNewConnectionAllowed("172.18.1.1"))
  449. assert.Error(t, Connections.IsNewConnectionAllowed("172.18.1.3"))
  450. assert.NoError(t, Connections.IsNewConnectionAllowed("10.8.7.3"))
  451. assert.Error(t, Connections.IsNewConnectionAllowed("10.8.8.2"))
  452. wl.IPAddresses = append(wl.IPAddresses, "172.18.1.3")
  453. wl.CIDRNetworks = append(wl.CIDRNetworks, "10.8.8.0/24")
  454. data, err = json.Marshal(wl)
  455. assert.NoError(t, err)
  456. err = os.WriteFile(wlFile, data, 0664)
  457. assert.NoError(t, err)
  458. assert.Error(t, Connections.IsNewConnectionAllowed("10.8.8.3"))
  459. err = Reload()
  460. assert.NoError(t, err)
  461. assert.NoError(t, Connections.IsNewConnectionAllowed("10.8.8.3"))
  462. assert.NoError(t, Connections.IsNewConnectionAllowed("172.18.1.3"))
  463. assert.NoError(t, Connections.IsNewConnectionAllowed("172.18.1.2"))
  464. assert.Error(t, Connections.IsNewConnectionAllowed("172.18.1.12"))
  465. Config = configCopy
  466. }
  467. func TestUserMaxSessions(t *testing.T) {
  468. c := NewBaseConnection("id", ProtocolSFTP, "", "", dataprovider.User{
  469. BaseUser: sdk.BaseUser{
  470. Username: userTestUsername,
  471. MaxSessions: 1,
  472. },
  473. })
  474. fakeConn := &fakeConnection{
  475. BaseConnection: c,
  476. }
  477. err := Connections.Add(fakeConn)
  478. assert.NoError(t, err)
  479. err = Connections.Add(fakeConn)
  480. assert.Error(t, err)
  481. err = Connections.Swap(fakeConn)
  482. assert.NoError(t, err)
  483. Connections.Remove(fakeConn.GetID())
  484. Connections.Lock()
  485. Connections.removeUserConnection(userTestUsername)
  486. Connections.Unlock()
  487. assert.Len(t, Connections.GetStats(""), 0)
  488. }
  489. func TestMaxConnections(t *testing.T) {
  490. oldValue := Config.MaxTotalConnections
  491. perHost := Config.MaxPerHostConnections
  492. Config.MaxPerHostConnections = 0
  493. ipAddr := "192.168.7.8"
  494. assert.NoError(t, Connections.IsNewConnectionAllowed(ipAddr))
  495. Config.MaxTotalConnections = 1
  496. Config.MaxPerHostConnections = perHost
  497. assert.NoError(t, Connections.IsNewConnectionAllowed(ipAddr))
  498. c := NewBaseConnection("id", ProtocolSFTP, "", "", dataprovider.User{})
  499. fakeConn := &fakeConnection{
  500. BaseConnection: c,
  501. }
  502. err := Connections.Add(fakeConn)
  503. assert.NoError(t, err)
  504. assert.Len(t, Connections.GetStats(""), 1)
  505. assert.Error(t, Connections.IsNewConnectionAllowed(ipAddr))
  506. res := Connections.Close(fakeConn.GetID(), "")
  507. assert.True(t, res)
  508. assert.Eventually(t, func() bool { return len(Connections.GetStats("")) == 0 }, 300*time.Millisecond, 50*time.Millisecond)
  509. assert.NoError(t, Connections.IsNewConnectionAllowed(ipAddr))
  510. Connections.AddClientConnection(ipAddr)
  511. Connections.AddClientConnection(ipAddr)
  512. assert.Error(t, Connections.IsNewConnectionAllowed(ipAddr))
  513. Connections.RemoveClientConnection(ipAddr)
  514. assert.NoError(t, Connections.IsNewConnectionAllowed(ipAddr))
  515. Connections.RemoveClientConnection(ipAddr)
  516. Config.MaxTotalConnections = oldValue
  517. }
  518. func TestConnectionRoles(t *testing.T) {
  519. username := "testUsername"
  520. role1 := "testRole1"
  521. role2 := "testRole2"
  522. c := NewBaseConnection("id", ProtocolSFTP, "", "", dataprovider.User{
  523. BaseUser: sdk.BaseUser{
  524. Username: username,
  525. Role: role1,
  526. },
  527. })
  528. fakeConn := &fakeConnection{
  529. BaseConnection: c,
  530. }
  531. err := Connections.Add(fakeConn)
  532. assert.NoError(t, err)
  533. assert.Len(t, Connections.GetStats(""), 1)
  534. assert.Len(t, Connections.GetStats(role1), 1)
  535. assert.Len(t, Connections.GetStats(role2), 0)
  536. res := Connections.Close(fakeConn.GetID(), role2)
  537. assert.False(t, res)
  538. assert.Len(t, Connections.GetStats(""), 1)
  539. res = Connections.Close(fakeConn.GetID(), role1)
  540. assert.True(t, res)
  541. assert.Eventually(t, func() bool { return len(Connections.GetStats("")) == 0 }, 300*time.Millisecond, 50*time.Millisecond)
  542. }
  543. func TestMaxConnectionPerHost(t *testing.T) {
  544. oldValue := Config.MaxPerHostConnections
  545. Config.MaxPerHostConnections = 2
  546. ipAddr := "192.168.9.9"
  547. Connections.AddClientConnection(ipAddr)
  548. assert.NoError(t, Connections.IsNewConnectionAllowed(ipAddr))
  549. Connections.AddClientConnection(ipAddr)
  550. assert.NoError(t, Connections.IsNewConnectionAllowed(ipAddr))
  551. Connections.AddClientConnection(ipAddr)
  552. assert.Error(t, Connections.IsNewConnectionAllowed(ipAddr))
  553. assert.Equal(t, int32(3), Connections.GetClientConnections())
  554. Connections.RemoveClientConnection(ipAddr)
  555. Connections.RemoveClientConnection(ipAddr)
  556. Connections.RemoveClientConnection(ipAddr)
  557. assert.Equal(t, int32(0), Connections.GetClientConnections())
  558. Config.MaxPerHostConnections = oldValue
  559. }
  560. func TestIdleConnections(t *testing.T) {
  561. configCopy := Config
  562. Config.IdleTimeout = 1
  563. err := Initialize(Config, 0)
  564. assert.NoError(t, err)
  565. conn1, conn2 := net.Pipe()
  566. customConn1 := &customNetConn{
  567. Conn: conn1,
  568. id: "id1",
  569. }
  570. customConn2 := &customNetConn{
  571. Conn: conn2,
  572. id: "id2",
  573. }
  574. sshConn1 := NewSSHConnection(customConn1.id, customConn1)
  575. sshConn2 := NewSSHConnection(customConn2.id, customConn2)
  576. username := "test_user"
  577. user := dataprovider.User{
  578. BaseUser: sdk.BaseUser{
  579. Username: username,
  580. },
  581. }
  582. c := NewBaseConnection(sshConn1.id+"_1", ProtocolSFTP, "", "", user)
  583. c.lastActivity.Store(time.Now().Add(-24 * time.Hour).UnixNano())
  584. fakeConn := &fakeConnection{
  585. BaseConnection: c,
  586. }
  587. // both ssh connections are expired but they should get removed only
  588. // if there is no associated connection
  589. sshConn1.lastActivity.Store(c.lastActivity.Load())
  590. sshConn2.lastActivity.Store(c.lastActivity.Load())
  591. Connections.AddSSHConnection(sshConn1)
  592. err = Connections.Add(fakeConn)
  593. assert.NoError(t, err)
  594. assert.Equal(t, Connections.GetActiveSessions(username), 1)
  595. c = NewBaseConnection(sshConn2.id+"_1", ProtocolSSH, "", "", user)
  596. fakeConn = &fakeConnection{
  597. BaseConnection: c,
  598. }
  599. Connections.AddSSHConnection(sshConn2)
  600. err = Connections.Add(fakeConn)
  601. assert.NoError(t, err)
  602. assert.Equal(t, Connections.GetActiveSessions(username), 2)
  603. cFTP := NewBaseConnection("id2", ProtocolFTP, "", "", dataprovider.User{})
  604. cFTP.lastActivity.Store(time.Now().UnixNano())
  605. fakeConn = &fakeConnection{
  606. BaseConnection: cFTP,
  607. }
  608. err = Connections.Add(fakeConn)
  609. assert.NoError(t, err)
  610. assert.Equal(t, Connections.GetActiveSessions(username), 2)
  611. assert.Len(t, Connections.GetStats(""), 3)
  612. Connections.RLock()
  613. assert.Len(t, Connections.sshConnections, 2)
  614. Connections.RUnlock()
  615. startPeriodicChecks(100 * time.Millisecond)
  616. assert.Eventually(t, func() bool { return Connections.GetActiveSessions(username) == 1 }, 2*time.Second, 200*time.Millisecond)
  617. assert.Eventually(t, func() bool {
  618. Connections.RLock()
  619. defer Connections.RUnlock()
  620. return len(Connections.sshConnections) == 1
  621. }, 1*time.Second, 200*time.Millisecond)
  622. stopEventScheduler()
  623. assert.Len(t, Connections.GetStats(""), 2)
  624. c.lastActivity.Store(time.Now().Add(-24 * time.Hour).UnixNano())
  625. cFTP.lastActivity.Store(time.Now().Add(-24 * time.Hour).UnixNano())
  626. sshConn2.lastActivity.Store(c.lastActivity.Load())
  627. startPeriodicChecks(100 * time.Millisecond)
  628. assert.Eventually(t, func() bool { return len(Connections.GetStats("")) == 0 }, 2*time.Second, 200*time.Millisecond)
  629. assert.Eventually(t, func() bool {
  630. Connections.RLock()
  631. defer Connections.RUnlock()
  632. return len(Connections.sshConnections) == 0
  633. }, 1*time.Second, 200*time.Millisecond)
  634. assert.Equal(t, int32(0), Connections.GetClientConnections())
  635. stopEventScheduler()
  636. assert.True(t, customConn1.isClosed)
  637. assert.True(t, customConn2.isClosed)
  638. Config = configCopy
  639. }
  640. func TestCloseConnection(t *testing.T) {
  641. c := NewBaseConnection("id", ProtocolSFTP, "", "", dataprovider.User{})
  642. fakeConn := &fakeConnection{
  643. BaseConnection: c,
  644. }
  645. assert.NoError(t, Connections.IsNewConnectionAllowed("127.0.0.1"))
  646. err := Connections.Add(fakeConn)
  647. assert.NoError(t, err)
  648. assert.Len(t, Connections.GetStats(""), 1)
  649. res := Connections.Close(fakeConn.GetID(), "")
  650. assert.True(t, res)
  651. assert.Eventually(t, func() bool { return len(Connections.GetStats("")) == 0 }, 300*time.Millisecond, 50*time.Millisecond)
  652. res = Connections.Close(fakeConn.GetID(), "")
  653. assert.False(t, res)
  654. Connections.Remove(fakeConn.GetID())
  655. }
  656. func TestSwapConnection(t *testing.T) {
  657. c := NewBaseConnection("id", ProtocolFTP, "", "", dataprovider.User{})
  658. fakeConn := &fakeConnection{
  659. BaseConnection: c,
  660. }
  661. err := Connections.Add(fakeConn)
  662. assert.NoError(t, err)
  663. if assert.Len(t, Connections.GetStats(""), 1) {
  664. assert.Equal(t, "", Connections.GetStats("")[0].Username)
  665. }
  666. c = NewBaseConnection("id", ProtocolFTP, "", "", dataprovider.User{
  667. BaseUser: sdk.BaseUser{
  668. Username: userTestUsername,
  669. MaxSessions: 1,
  670. },
  671. })
  672. fakeConn = &fakeConnection{
  673. BaseConnection: c,
  674. }
  675. c1 := NewBaseConnection("id1", ProtocolFTP, "", "", dataprovider.User{
  676. BaseUser: sdk.BaseUser{
  677. Username: userTestUsername,
  678. },
  679. })
  680. fakeConn1 := &fakeConnection{
  681. BaseConnection: c1,
  682. }
  683. err = Connections.Add(fakeConn1)
  684. assert.NoError(t, err)
  685. err = Connections.Swap(fakeConn)
  686. assert.Error(t, err)
  687. Connections.Remove(fakeConn1.ID)
  688. err = Connections.Swap(fakeConn)
  689. assert.NoError(t, err)
  690. if assert.Len(t, Connections.GetStats(""), 1) {
  691. assert.Equal(t, userTestUsername, Connections.GetStats("")[0].Username)
  692. }
  693. res := Connections.Close(fakeConn.GetID(), "")
  694. assert.True(t, res)
  695. assert.Eventually(t, func() bool { return len(Connections.GetStats("")) == 0 }, 300*time.Millisecond, 50*time.Millisecond)
  696. err = Connections.Swap(fakeConn)
  697. assert.Error(t, err)
  698. }
  699. func TestAtomicUpload(t *testing.T) {
  700. configCopy := Config
  701. Config.UploadMode = UploadModeStandard
  702. assert.False(t, Config.IsAtomicUploadEnabled())
  703. Config.UploadMode = UploadModeAtomic
  704. assert.True(t, Config.IsAtomicUploadEnabled())
  705. Config.UploadMode = UploadModeAtomicWithResume
  706. assert.True(t, Config.IsAtomicUploadEnabled())
  707. Config = configCopy
  708. }
  709. func TestConnectionStatus(t *testing.T) {
  710. username := "test_user"
  711. user := dataprovider.User{
  712. BaseUser: sdk.BaseUser{
  713. Username: username,
  714. },
  715. }
  716. fs := vfs.NewOsFs("", os.TempDir(), "")
  717. c1 := NewBaseConnection("id1", ProtocolSFTP, "", "", user)
  718. fakeConn1 := &fakeConnection{
  719. BaseConnection: c1,
  720. }
  721. t1 := NewBaseTransfer(nil, c1, nil, "/p1", "/p1", "/r1", TransferUpload, 0, 0, 0, 0, true, fs, dataprovider.TransferQuota{})
  722. t1.BytesReceived.Store(123)
  723. t2 := NewBaseTransfer(nil, c1, nil, "/p2", "/p2", "/r2", TransferDownload, 0, 0, 0, 0, true, fs, dataprovider.TransferQuota{})
  724. t2.BytesSent.Store(456)
  725. c2 := NewBaseConnection("id2", ProtocolSSH, "", "", user)
  726. fakeConn2 := &fakeConnection{
  727. BaseConnection: c2,
  728. command: "md5sum",
  729. }
  730. c3 := NewBaseConnection("id3", ProtocolWebDAV, "", "", user)
  731. fakeConn3 := &fakeConnection{
  732. BaseConnection: c3,
  733. command: "PROPFIND",
  734. }
  735. t3 := NewBaseTransfer(nil, c3, nil, "/p2", "/p2", "/r2", TransferDownload, 0, 0, 0, 0, true, fs, dataprovider.TransferQuota{})
  736. err := Connections.Add(fakeConn1)
  737. assert.NoError(t, err)
  738. err = Connections.Add(fakeConn2)
  739. assert.NoError(t, err)
  740. err = Connections.Add(fakeConn3)
  741. assert.NoError(t, err)
  742. stats := Connections.GetStats("")
  743. assert.Len(t, stats, 3)
  744. for _, stat := range stats {
  745. assert.Equal(t, stat.Username, username)
  746. assert.True(t, strings.HasPrefix(stat.GetConnectionInfo(), stat.Protocol))
  747. assert.True(t, strings.HasPrefix(stat.GetConnectionDuration(), "00:"))
  748. if stat.ConnectionID == "SFTP_id1" {
  749. assert.Len(t, stat.Transfers, 2)
  750. assert.Greater(t, len(stat.GetTransfersAsString()), 0)
  751. for _, tr := range stat.Transfers {
  752. if tr.OperationType == operationDownload {
  753. assert.True(t, strings.HasPrefix(tr.getConnectionTransferAsString(), "DL"))
  754. } else if tr.OperationType == operationUpload {
  755. assert.True(t, strings.HasPrefix(tr.getConnectionTransferAsString(), "UL"))
  756. }
  757. }
  758. } else if stat.ConnectionID == "DAV_id3" {
  759. assert.Len(t, stat.Transfers, 1)
  760. assert.Greater(t, len(stat.GetTransfersAsString()), 0)
  761. } else {
  762. assert.Equal(t, 0, len(stat.GetTransfersAsString()))
  763. }
  764. }
  765. err = t1.Close()
  766. assert.NoError(t, err)
  767. err = t2.Close()
  768. assert.NoError(t, err)
  769. err = fakeConn3.SignalTransfersAbort()
  770. assert.NoError(t, err)
  771. assert.True(t, t3.AbortTransfer.Load())
  772. err = t3.Close()
  773. assert.NoError(t, err)
  774. err = fakeConn3.SignalTransfersAbort()
  775. assert.Error(t, err)
  776. Connections.Remove(fakeConn1.GetID())
  777. stats = Connections.GetStats("")
  778. assert.Len(t, stats, 2)
  779. assert.Equal(t, fakeConn3.GetID(), stats[0].ConnectionID)
  780. assert.Equal(t, fakeConn2.GetID(), stats[1].ConnectionID)
  781. Connections.Remove(fakeConn2.GetID())
  782. stats = Connections.GetStats("")
  783. assert.Len(t, stats, 1)
  784. assert.Equal(t, fakeConn3.GetID(), stats[0].ConnectionID)
  785. Connections.Remove(fakeConn3.GetID())
  786. stats = Connections.GetStats("")
  787. assert.Len(t, stats, 0)
  788. }
  789. func TestQuotaScans(t *testing.T) {
  790. username := "username"
  791. assert.True(t, QuotaScans.AddUserQuotaScan(username, ""))
  792. assert.False(t, QuotaScans.AddUserQuotaScan(username, ""))
  793. usersScans := QuotaScans.GetUsersQuotaScans("")
  794. if assert.Len(t, usersScans, 1) {
  795. assert.Equal(t, usersScans[0].Username, username)
  796. assert.Equal(t, QuotaScans.UserScans[0].StartTime, usersScans[0].StartTime)
  797. QuotaScans.UserScans[0].StartTime = 0
  798. assert.NotEqual(t, QuotaScans.UserScans[0].StartTime, usersScans[0].StartTime)
  799. }
  800. assert.True(t, QuotaScans.RemoveUserQuotaScan(username))
  801. assert.False(t, QuotaScans.RemoveUserQuotaScan(username))
  802. assert.Len(t, QuotaScans.GetUsersQuotaScans(""), 0)
  803. assert.Len(t, usersScans, 1)
  804. folderName := "folder"
  805. assert.True(t, QuotaScans.AddVFolderQuotaScan(folderName))
  806. assert.False(t, QuotaScans.AddVFolderQuotaScan(folderName))
  807. if assert.Len(t, QuotaScans.GetVFoldersQuotaScans(), 1) {
  808. assert.Equal(t, QuotaScans.GetVFoldersQuotaScans()[0].Name, folderName)
  809. }
  810. assert.True(t, QuotaScans.RemoveVFolderQuotaScan(folderName))
  811. assert.False(t, QuotaScans.RemoveVFolderQuotaScan(folderName))
  812. assert.Len(t, QuotaScans.GetVFoldersQuotaScans(), 0)
  813. }
  814. func TestQuotaScansRole(t *testing.T) {
  815. username := "u"
  816. role1 := "r1"
  817. role2 := "r2"
  818. assert.True(t, QuotaScans.AddUserQuotaScan(username, role1))
  819. assert.False(t, QuotaScans.AddUserQuotaScan(username, ""))
  820. usersScans := QuotaScans.GetUsersQuotaScans("")
  821. assert.Len(t, usersScans, 1)
  822. assert.Empty(t, usersScans[0].Role)
  823. usersScans = QuotaScans.GetUsersQuotaScans(role1)
  824. assert.Len(t, usersScans, 1)
  825. usersScans = QuotaScans.GetUsersQuotaScans(role2)
  826. assert.Len(t, usersScans, 0)
  827. assert.True(t, QuotaScans.RemoveUserQuotaScan(username))
  828. assert.False(t, QuotaScans.RemoveUserQuotaScan(username))
  829. assert.Len(t, QuotaScans.GetUsersQuotaScans(""), 0)
  830. }
  831. func TestProxyProtocolVersion(t *testing.T) {
  832. c := Configuration{
  833. ProxyProtocol: 0,
  834. }
  835. _, err := c.GetProxyListener(nil)
  836. if assert.Error(t, err) {
  837. assert.Contains(t, err.Error(), "proxy protocol not configured")
  838. }
  839. c.ProxyProtocol = 1
  840. proxyListener, err := c.GetProxyListener(nil)
  841. assert.NoError(t, err)
  842. assert.Nil(t, proxyListener.Policy)
  843. c.ProxyProtocol = 2
  844. proxyListener, err = c.GetProxyListener(nil)
  845. assert.NoError(t, err)
  846. assert.NotNil(t, proxyListener.Policy)
  847. c.ProxyProtocol = 1
  848. c.ProxyAllowed = []string{"invalid"}
  849. _, err = c.GetProxyListener(nil)
  850. assert.Error(t, err)
  851. c.ProxyProtocol = 2
  852. _, err = c.GetProxyListener(nil)
  853. assert.Error(t, err)
  854. }
  855. func TestStartupHook(t *testing.T) {
  856. Config.StartupHook = ""
  857. assert.NoError(t, Config.ExecuteStartupHook())
  858. Config.StartupHook = "http://foo\x7f.com/startup"
  859. assert.Error(t, Config.ExecuteStartupHook())
  860. Config.StartupHook = "http://invalid:5678/"
  861. assert.Error(t, Config.ExecuteStartupHook())
  862. Config.StartupHook = fmt.Sprintf("http://%v", httpAddr)
  863. assert.NoError(t, Config.ExecuteStartupHook())
  864. Config.StartupHook = "invalidhook"
  865. assert.Error(t, Config.ExecuteStartupHook())
  866. if runtime.GOOS != osWindows {
  867. hookCmd, err := exec.LookPath("true")
  868. assert.NoError(t, err)
  869. Config.StartupHook = hookCmd
  870. assert.NoError(t, Config.ExecuteStartupHook())
  871. }
  872. Config.StartupHook = ""
  873. }
  874. func TestPostDisconnectHook(t *testing.T) {
  875. Config.PostDisconnectHook = "http://127.0.0.1/"
  876. remoteAddr := "127.0.0.1:80"
  877. Config.checkPostDisconnectHook(remoteAddr, ProtocolHTTP, "", "", time.Now())
  878. Config.checkPostDisconnectHook(remoteAddr, ProtocolSFTP, "", "", time.Now())
  879. Config.PostDisconnectHook = "http://bar\x7f.com/"
  880. Config.executePostDisconnectHook(remoteAddr, ProtocolSFTP, "", "", time.Now())
  881. Config.PostDisconnectHook = fmt.Sprintf("http://%v", httpAddr)
  882. Config.executePostDisconnectHook(remoteAddr, ProtocolSFTP, "", "", time.Now())
  883. Config.PostDisconnectHook = "relativePath"
  884. Config.executePostDisconnectHook(remoteAddr, ProtocolSFTP, "", "", time.Now())
  885. if runtime.GOOS == osWindows {
  886. Config.PostDisconnectHook = "C:\\a\\bad\\command"
  887. Config.executePostDisconnectHook(remoteAddr, ProtocolSFTP, "", "", time.Now())
  888. } else {
  889. Config.PostDisconnectHook = "/invalid/path"
  890. Config.executePostDisconnectHook(remoteAddr, ProtocolSFTP, "", "", time.Now())
  891. hookCmd, err := exec.LookPath("true")
  892. assert.NoError(t, err)
  893. Config.PostDisconnectHook = hookCmd
  894. Config.executePostDisconnectHook(remoteAddr, ProtocolSFTP, "", "", time.Now())
  895. }
  896. Config.PostDisconnectHook = ""
  897. }
  898. func TestPostConnectHook(t *testing.T) {
  899. Config.PostConnectHook = ""
  900. ipAddr := "127.0.0.1"
  901. assert.NoError(t, Config.ExecutePostConnectHook(ipAddr, ProtocolFTP))
  902. Config.PostConnectHook = "http://foo\x7f.com/"
  903. assert.Error(t, Config.ExecutePostConnectHook(ipAddr, ProtocolSFTP))
  904. Config.PostConnectHook = "http://invalid:1234/"
  905. assert.Error(t, Config.ExecutePostConnectHook(ipAddr, ProtocolSFTP))
  906. Config.PostConnectHook = fmt.Sprintf("http://%v/404", httpAddr)
  907. assert.Error(t, Config.ExecutePostConnectHook(ipAddr, ProtocolFTP))
  908. Config.PostConnectHook = fmt.Sprintf("http://%v", httpAddr)
  909. assert.NoError(t, Config.ExecutePostConnectHook(ipAddr, ProtocolFTP))
  910. Config.PostConnectHook = "invalid"
  911. assert.Error(t, Config.ExecutePostConnectHook(ipAddr, ProtocolFTP))
  912. if runtime.GOOS == osWindows {
  913. Config.PostConnectHook = "C:\\bad\\command"
  914. assert.Error(t, Config.ExecutePostConnectHook(ipAddr, ProtocolSFTP))
  915. } else {
  916. Config.PostConnectHook = "/invalid/path"
  917. assert.Error(t, Config.ExecutePostConnectHook(ipAddr, ProtocolSFTP))
  918. hookCmd, err := exec.LookPath("true")
  919. assert.NoError(t, err)
  920. Config.PostConnectHook = hookCmd
  921. assert.NoError(t, Config.ExecutePostConnectHook(ipAddr, ProtocolSFTP))
  922. }
  923. Config.PostConnectHook = ""
  924. }
  925. func TestCryptoConvertFileInfo(t *testing.T) {
  926. name := "name"
  927. fs, err := vfs.NewCryptFs("connID1", os.TempDir(), "", vfs.CryptFsConfig{
  928. Passphrase: kms.NewPlainSecret("secret"),
  929. })
  930. require.NoError(t, err)
  931. cryptFs := fs.(*vfs.CryptFs)
  932. info := vfs.NewFileInfo(name, true, 48, time.Now(), false)
  933. assert.Equal(t, info, cryptFs.ConvertFileInfo(info))
  934. info = vfs.NewFileInfo(name, false, 48, time.Now(), false)
  935. assert.NotEqual(t, info.Size(), cryptFs.ConvertFileInfo(info).Size())
  936. info = vfs.NewFileInfo(name, false, 33, time.Now(), false)
  937. assert.Equal(t, int64(0), cryptFs.ConvertFileInfo(info).Size())
  938. info = vfs.NewFileInfo(name, false, 1, time.Now(), false)
  939. assert.Equal(t, int64(0), cryptFs.ConvertFileInfo(info).Size())
  940. }
  941. func TestFolderCopy(t *testing.T) {
  942. folder := vfs.BaseVirtualFolder{
  943. ID: 1,
  944. Name: "name",
  945. MappedPath: filepath.Clean(os.TempDir()),
  946. UsedQuotaSize: 4096,
  947. UsedQuotaFiles: 2,
  948. LastQuotaUpdate: util.GetTimeAsMsSinceEpoch(time.Now()),
  949. Users: []string{"user1", "user2"},
  950. }
  951. folderCopy := folder.GetACopy()
  952. folder.ID = 2
  953. folder.Users = []string{"user3"}
  954. require.Len(t, folderCopy.Users, 2)
  955. require.True(t, util.Contains(folderCopy.Users, "user1"))
  956. require.True(t, util.Contains(folderCopy.Users, "user2"))
  957. require.Equal(t, int64(1), folderCopy.ID)
  958. require.Equal(t, folder.Name, folderCopy.Name)
  959. require.Equal(t, folder.MappedPath, folderCopy.MappedPath)
  960. require.Equal(t, folder.UsedQuotaSize, folderCopy.UsedQuotaSize)
  961. require.Equal(t, folder.UsedQuotaFiles, folderCopy.UsedQuotaFiles)
  962. require.Equal(t, folder.LastQuotaUpdate, folderCopy.LastQuotaUpdate)
  963. folder.FsConfig = vfs.Filesystem{
  964. CryptConfig: vfs.CryptFsConfig{
  965. Passphrase: kms.NewPlainSecret("crypto secret"),
  966. },
  967. }
  968. folderCopy = folder.GetACopy()
  969. folder.FsConfig.CryptConfig.Passphrase = kms.NewEmptySecret()
  970. require.Len(t, folderCopy.Users, 1)
  971. require.True(t, util.Contains(folderCopy.Users, "user3"))
  972. require.Equal(t, int64(2), folderCopy.ID)
  973. require.Equal(t, folder.Name, folderCopy.Name)
  974. require.Equal(t, folder.MappedPath, folderCopy.MappedPath)
  975. require.Equal(t, folder.UsedQuotaSize, folderCopy.UsedQuotaSize)
  976. require.Equal(t, folder.UsedQuotaFiles, folderCopy.UsedQuotaFiles)
  977. require.Equal(t, folder.LastQuotaUpdate, folderCopy.LastQuotaUpdate)
  978. require.Equal(t, "crypto secret", folderCopy.FsConfig.CryptConfig.Passphrase.GetPayload())
  979. }
  980. func TestCachedFs(t *testing.T) {
  981. user := dataprovider.User{
  982. BaseUser: sdk.BaseUser{
  983. HomeDir: filepath.Clean(os.TempDir()),
  984. },
  985. }
  986. conn := NewBaseConnection("id", ProtocolSFTP, "", "", user)
  987. // changing the user should not affect the connection
  988. user.HomeDir = filepath.Join(os.TempDir(), "temp")
  989. err := os.Mkdir(user.HomeDir, os.ModePerm)
  990. assert.NoError(t, err)
  991. fs, err := user.GetFilesystem("")
  992. assert.NoError(t, err)
  993. p, err := fs.ResolvePath("/")
  994. assert.NoError(t, err)
  995. assert.Equal(t, user.GetHomeDir(), p)
  996. _, p, err = conn.GetFsAndResolvedPath("/")
  997. assert.NoError(t, err)
  998. assert.Equal(t, filepath.Clean(os.TempDir()), p)
  999. // the filesystem is cached changing the provider will not affect the connection
  1000. conn.User.FsConfig.Provider = sdk.S3FilesystemProvider
  1001. _, p, err = conn.GetFsAndResolvedPath("/")
  1002. assert.NoError(t, err)
  1003. assert.Equal(t, filepath.Clean(os.TempDir()), p)
  1004. user = dataprovider.User{}
  1005. user.HomeDir = filepath.Join(os.TempDir(), "temp")
  1006. user.FsConfig.Provider = sdk.S3FilesystemProvider
  1007. _, err = user.GetFilesystem("")
  1008. assert.Error(t, err)
  1009. err = os.Remove(user.HomeDir)
  1010. assert.NoError(t, err)
  1011. }
  1012. func TestParseAllowedIPAndRanges(t *testing.T) {
  1013. _, err := util.ParseAllowedIPAndRanges([]string{"1.1.1.1", "not an ip"})
  1014. assert.Error(t, err)
  1015. _, err = util.ParseAllowedIPAndRanges([]string{"1.1.1.5", "192.168.1.0/240"})
  1016. assert.Error(t, err)
  1017. allow, err := util.ParseAllowedIPAndRanges([]string{"192.168.1.2", "172.16.0.0/24"})
  1018. assert.NoError(t, err)
  1019. assert.True(t, allow[0](net.ParseIP("192.168.1.2")))
  1020. assert.False(t, allow[0](net.ParseIP("192.168.2.2")))
  1021. assert.True(t, allow[1](net.ParseIP("172.16.0.1")))
  1022. assert.False(t, allow[1](net.ParseIP("172.16.1.1")))
  1023. }
  1024. func TestHideConfidentialData(t *testing.T) {
  1025. for _, provider := range []sdk.FilesystemProvider{sdk.LocalFilesystemProvider,
  1026. sdk.CryptedFilesystemProvider, sdk.S3FilesystemProvider, sdk.GCSFilesystemProvider,
  1027. sdk.AzureBlobFilesystemProvider, sdk.SFTPFilesystemProvider,
  1028. } {
  1029. u := dataprovider.User{
  1030. FsConfig: vfs.Filesystem{
  1031. Provider: provider,
  1032. },
  1033. }
  1034. u.PrepareForRendering()
  1035. f := vfs.BaseVirtualFolder{
  1036. FsConfig: vfs.Filesystem{
  1037. Provider: provider,
  1038. },
  1039. }
  1040. f.PrepareForRendering()
  1041. }
  1042. a := dataprovider.Admin{}
  1043. a.HideConfidentialData()
  1044. }
  1045. func TestUserPerms(t *testing.T) {
  1046. u := dataprovider.User{}
  1047. u.Permissions = make(map[string][]string)
  1048. u.Permissions["/"] = []string{dataprovider.PermUpload, dataprovider.PermDelete}
  1049. assert.True(t, u.HasAnyPerm([]string{dataprovider.PermRename, dataprovider.PermDelete}, "/"))
  1050. assert.False(t, u.HasAnyPerm([]string{dataprovider.PermRename, dataprovider.PermCreateDirs}, "/"))
  1051. u.Permissions["/"] = []string{dataprovider.PermDelete, dataprovider.PermCreateDirs}
  1052. assert.True(t, u.HasPermsDeleteAll("/"))
  1053. assert.False(t, u.HasPermsRenameAll("/"))
  1054. u.Permissions["/"] = []string{dataprovider.PermDeleteDirs, dataprovider.PermDeleteFiles, dataprovider.PermRenameDirs}
  1055. assert.True(t, u.HasPermsDeleteAll("/"))
  1056. assert.False(t, u.HasPermsRenameAll("/"))
  1057. u.Permissions["/"] = []string{dataprovider.PermDeleteDirs, dataprovider.PermRenameFiles, dataprovider.PermRenameDirs}
  1058. assert.False(t, u.HasPermsDeleteAll("/"))
  1059. assert.True(t, u.HasPermsRenameAll("/"))
  1060. }
  1061. func TestGetTLSVersion(t *testing.T) {
  1062. tlsVer := util.GetTLSVersion(0)
  1063. assert.Equal(t, uint16(tls.VersionTLS12), tlsVer)
  1064. tlsVer = util.GetTLSVersion(12)
  1065. assert.Equal(t, uint16(tls.VersionTLS12), tlsVer)
  1066. tlsVer = util.GetTLSVersion(2)
  1067. assert.Equal(t, uint16(tls.VersionTLS12), tlsVer)
  1068. tlsVer = util.GetTLSVersion(13)
  1069. assert.Equal(t, uint16(tls.VersionTLS13), tlsVer)
  1070. }
  1071. func TestCleanPath(t *testing.T) {
  1072. assert.Equal(t, "/", util.CleanPath("/"))
  1073. assert.Equal(t, "/", util.CleanPath("."))
  1074. assert.Equal(t, "/", util.CleanPath(""))
  1075. assert.Equal(t, "/", util.CleanPath("/."))
  1076. assert.Equal(t, "/", util.CleanPath("/a/.."))
  1077. assert.Equal(t, "/a", util.CleanPath("/a/"))
  1078. assert.Equal(t, "/a", util.CleanPath("a/"))
  1079. // filepath.ToSlash does not touch \ as char on unix systems
  1080. // so os.PathSeparator is used for windows compatible tests
  1081. bslash := string(os.PathSeparator)
  1082. assert.Equal(t, "/", util.CleanPath(bslash))
  1083. assert.Equal(t, "/", util.CleanPath(bslash+bslash))
  1084. assert.Equal(t, "/a", util.CleanPath(bslash+"a"+bslash))
  1085. assert.Equal(t, "/a", util.CleanPath("a"+bslash))
  1086. assert.Equal(t, "/a/b/c", util.CleanPath(bslash+"a"+bslash+bslash+"b"+bslash+bslash+"c"+bslash))
  1087. assert.Equal(t, "/C:/a", util.CleanPath("C:"+bslash+"a"))
  1088. }
  1089. func TestUserRecentActivity(t *testing.T) {
  1090. u := dataprovider.User{}
  1091. res := u.HasRecentActivity()
  1092. assert.False(t, res)
  1093. u.LastLogin = util.GetTimeAsMsSinceEpoch(time.Now())
  1094. res = u.HasRecentActivity()
  1095. assert.True(t, res)
  1096. u.LastLogin = util.GetTimeAsMsSinceEpoch(time.Now().Add(1 * time.Minute))
  1097. res = u.HasRecentActivity()
  1098. assert.False(t, res)
  1099. u.LastLogin = util.GetTimeAsMsSinceEpoch(time.Now().Add(1 * time.Second))
  1100. res = u.HasRecentActivity()
  1101. assert.True(t, res)
  1102. }
  1103. func TestVfsSameResource(t *testing.T) {
  1104. fs := vfs.Filesystem{}
  1105. other := vfs.Filesystem{}
  1106. res := fs.IsSameResource(other)
  1107. assert.True(t, res)
  1108. fs = vfs.Filesystem{
  1109. Provider: sdk.S3FilesystemProvider,
  1110. S3Config: vfs.S3FsConfig{
  1111. BaseS3FsConfig: sdk.BaseS3FsConfig{
  1112. Bucket: "a",
  1113. Region: "b",
  1114. },
  1115. },
  1116. }
  1117. other = vfs.Filesystem{
  1118. Provider: sdk.S3FilesystemProvider,
  1119. S3Config: vfs.S3FsConfig{
  1120. BaseS3FsConfig: sdk.BaseS3FsConfig{
  1121. Bucket: "a",
  1122. Region: "c",
  1123. },
  1124. },
  1125. }
  1126. res = fs.IsSameResource(other)
  1127. assert.False(t, res)
  1128. other = vfs.Filesystem{
  1129. Provider: sdk.S3FilesystemProvider,
  1130. S3Config: vfs.S3FsConfig{
  1131. BaseS3FsConfig: sdk.BaseS3FsConfig{
  1132. Bucket: "a",
  1133. Region: "b",
  1134. },
  1135. },
  1136. }
  1137. res = fs.IsSameResource(other)
  1138. assert.True(t, res)
  1139. fs = vfs.Filesystem{
  1140. Provider: sdk.GCSFilesystemProvider,
  1141. GCSConfig: vfs.GCSFsConfig{
  1142. BaseGCSFsConfig: sdk.BaseGCSFsConfig{
  1143. Bucket: "b",
  1144. },
  1145. },
  1146. }
  1147. other = vfs.Filesystem{
  1148. Provider: sdk.GCSFilesystemProvider,
  1149. GCSConfig: vfs.GCSFsConfig{
  1150. BaseGCSFsConfig: sdk.BaseGCSFsConfig{
  1151. Bucket: "c",
  1152. },
  1153. },
  1154. }
  1155. res = fs.IsSameResource(other)
  1156. assert.False(t, res)
  1157. other = vfs.Filesystem{
  1158. Provider: sdk.GCSFilesystemProvider,
  1159. GCSConfig: vfs.GCSFsConfig{
  1160. BaseGCSFsConfig: sdk.BaseGCSFsConfig{
  1161. Bucket: "b",
  1162. },
  1163. },
  1164. }
  1165. res = fs.IsSameResource(other)
  1166. assert.True(t, res)
  1167. sasURL := kms.NewPlainSecret("http://127.0.0.1/sasurl")
  1168. fs = vfs.Filesystem{
  1169. Provider: sdk.AzureBlobFilesystemProvider,
  1170. AzBlobConfig: vfs.AzBlobFsConfig{
  1171. BaseAzBlobFsConfig: sdk.BaseAzBlobFsConfig{
  1172. AccountName: "a",
  1173. },
  1174. SASURL: sasURL,
  1175. },
  1176. }
  1177. err := fs.Validate("data1")
  1178. assert.NoError(t, err)
  1179. other = vfs.Filesystem{
  1180. Provider: sdk.AzureBlobFilesystemProvider,
  1181. AzBlobConfig: vfs.AzBlobFsConfig{
  1182. BaseAzBlobFsConfig: sdk.BaseAzBlobFsConfig{
  1183. AccountName: "a",
  1184. },
  1185. SASURL: sasURL,
  1186. },
  1187. }
  1188. err = other.Validate("data2")
  1189. assert.NoError(t, err)
  1190. err = fs.AzBlobConfig.SASURL.TryDecrypt()
  1191. assert.NoError(t, err)
  1192. err = other.AzBlobConfig.SASURL.TryDecrypt()
  1193. assert.NoError(t, err)
  1194. res = fs.IsSameResource(other)
  1195. assert.True(t, res)
  1196. fs.AzBlobConfig.AccountName = "b"
  1197. res = fs.IsSameResource(other)
  1198. assert.False(t, res)
  1199. fs.AzBlobConfig.AccountName = "a"
  1200. other.AzBlobConfig.SASURL = kms.NewPlainSecret("http://127.1.1.1/sasurl")
  1201. err = other.Validate("data2")
  1202. assert.NoError(t, err)
  1203. err = other.AzBlobConfig.SASURL.TryDecrypt()
  1204. assert.NoError(t, err)
  1205. res = fs.IsSameResource(other)
  1206. assert.False(t, res)
  1207. fs = vfs.Filesystem{
  1208. Provider: sdk.HTTPFilesystemProvider,
  1209. HTTPConfig: vfs.HTTPFsConfig{
  1210. BaseHTTPFsConfig: sdk.BaseHTTPFsConfig{
  1211. Endpoint: "http://127.0.0.1/httpfs",
  1212. Username: "a",
  1213. },
  1214. },
  1215. }
  1216. other = vfs.Filesystem{
  1217. Provider: sdk.HTTPFilesystemProvider,
  1218. HTTPConfig: vfs.HTTPFsConfig{
  1219. BaseHTTPFsConfig: sdk.BaseHTTPFsConfig{
  1220. Endpoint: "http://127.0.0.1/httpfs",
  1221. Username: "b",
  1222. },
  1223. },
  1224. }
  1225. res = fs.IsSameResource(other)
  1226. assert.True(t, res)
  1227. fs.HTTPConfig.EqualityCheckMode = 1
  1228. res = fs.IsSameResource(other)
  1229. assert.False(t, res)
  1230. }
  1231. func TestUpdateTransferTimestamps(t *testing.T) {
  1232. username := "user_test_timestamps"
  1233. user := &dataprovider.User{
  1234. BaseUser: sdk.BaseUser{
  1235. Username: username,
  1236. HomeDir: filepath.Join(os.TempDir(), username),
  1237. Status: 1,
  1238. Permissions: map[string][]string{
  1239. "/": {dataprovider.PermAny},
  1240. },
  1241. },
  1242. }
  1243. err := dataprovider.AddUser(user, "", "", "")
  1244. assert.NoError(t, err)
  1245. assert.Equal(t, int64(0), user.FirstUpload)
  1246. assert.Equal(t, int64(0), user.FirstDownload)
  1247. err = dataprovider.UpdateUserTransferTimestamps(username, true)
  1248. assert.NoError(t, err)
  1249. userGet, err := dataprovider.UserExists(username, "")
  1250. assert.NoError(t, err)
  1251. assert.Greater(t, userGet.FirstUpload, int64(0))
  1252. assert.Equal(t, int64(0), user.FirstDownload)
  1253. err = dataprovider.UpdateUserTransferTimestamps(username, false)
  1254. assert.NoError(t, err)
  1255. userGet, err = dataprovider.UserExists(username, "")
  1256. assert.NoError(t, err)
  1257. assert.Greater(t, userGet.FirstUpload, int64(0))
  1258. assert.Greater(t, userGet.FirstDownload, int64(0))
  1259. // updating again must fail
  1260. err = dataprovider.UpdateUserTransferTimestamps(username, true)
  1261. assert.Error(t, err)
  1262. err = dataprovider.UpdateUserTransferTimestamps(username, false)
  1263. assert.Error(t, err)
  1264. // cleanup
  1265. err = dataprovider.DeleteUser(username, "", "", "")
  1266. assert.NoError(t, err)
  1267. }
  1268. func TestMetadataAPI(t *testing.T) {
  1269. username := "metadatauser"
  1270. require.False(t, ActiveMetadataChecks.Remove(username))
  1271. require.True(t, ActiveMetadataChecks.Add(username, ""))
  1272. require.False(t, ActiveMetadataChecks.Add(username, ""))
  1273. checks := ActiveMetadataChecks.Get("")
  1274. require.Len(t, checks, 1)
  1275. checks[0].Username = username + "a"
  1276. checks = ActiveMetadataChecks.Get("")
  1277. require.Len(t, checks, 1)
  1278. require.Equal(t, username, checks[0].Username)
  1279. require.True(t, ActiveMetadataChecks.Remove(username))
  1280. require.Len(t, ActiveMetadataChecks.Get(""), 0)
  1281. }
  1282. func TestMetadataAPIRole(t *testing.T) {
  1283. username := "muser"
  1284. role1 := "r1"
  1285. role2 := "r2"
  1286. require.True(t, ActiveMetadataChecks.Add(username, role2))
  1287. require.False(t, ActiveMetadataChecks.Add(username, ""))
  1288. checks := ActiveMetadataChecks.Get("")
  1289. require.Len(t, checks, 1)
  1290. assert.Empty(t, checks[0].Role)
  1291. checks = ActiveMetadataChecks.Get(role1)
  1292. require.Len(t, checks, 0)
  1293. checks = ActiveMetadataChecks.Get(role2)
  1294. require.Len(t, checks, 1)
  1295. require.True(t, ActiveMetadataChecks.Remove(username))
  1296. require.Len(t, ActiveMetadataChecks.Get(""), 0)
  1297. }
  1298. func BenchmarkBcryptHashing(b *testing.B) {
  1299. bcryptPassword := "bcryptpassword"
  1300. for i := 0; i < b.N; i++ {
  1301. _, err := bcrypt.GenerateFromPassword([]byte(bcryptPassword), 10)
  1302. if err != nil {
  1303. panic(err)
  1304. }
  1305. }
  1306. }
  1307. func BenchmarkCompareBcryptPassword(b *testing.B) {
  1308. bcryptPassword := "$2a$10$lPDdnDimJZ7d5/GwL6xDuOqoZVRXok6OHHhivCnanWUtcgN0Zafki"
  1309. for i := 0; i < b.N; i++ {
  1310. err := bcrypt.CompareHashAndPassword([]byte(bcryptPassword), []byte("password"))
  1311. if err != nil {
  1312. panic(err)
  1313. }
  1314. }
  1315. }
  1316. func BenchmarkArgon2Hashing(b *testing.B) {
  1317. argonPassword := "argon2password"
  1318. for i := 0; i < b.N; i++ {
  1319. _, err := argon2id.CreateHash(argonPassword, argon2id.DefaultParams)
  1320. if err != nil {
  1321. panic(err)
  1322. }
  1323. }
  1324. }
  1325. func BenchmarkCompareArgon2Password(b *testing.B) {
  1326. argon2Password := "$argon2id$v=19$m=65536,t=1,p=2$aOoAOdAwvzhOgi7wUFjXlw$wn/y37dBWdKHtPXHR03nNaKHWKPXyNuVXOknaU+YZ+s"
  1327. for i := 0; i < b.N; i++ {
  1328. _, err := argon2id.ComparePasswordAndHash("password", argon2Password)
  1329. if err != nil {
  1330. panic(err)
  1331. }
  1332. }
  1333. }
  1334. func BenchmarkAddRemoveConnections(b *testing.B) {
  1335. var conns []ActiveConnection
  1336. for i := 0; i < 100; i++ {
  1337. conns = append(conns, &fakeConnection{
  1338. BaseConnection: NewBaseConnection(fmt.Sprintf("id%d", i), ProtocolSFTP, "", "", dataprovider.User{
  1339. BaseUser: sdk.BaseUser{
  1340. Username: userTestUsername,
  1341. },
  1342. }),
  1343. })
  1344. }
  1345. b.ResetTimer()
  1346. for i := 0; i < b.N; i++ {
  1347. for _, c := range conns {
  1348. if err := Connections.Add(c); err != nil {
  1349. panic(err)
  1350. }
  1351. }
  1352. var wg sync.WaitGroup
  1353. for idx := len(conns) - 1; idx >= 0; idx-- {
  1354. wg.Add(1)
  1355. go func(index int) {
  1356. defer wg.Done()
  1357. Connections.Remove(conns[index].GetID())
  1358. }(idx)
  1359. }
  1360. wg.Wait()
  1361. }
  1362. }
  1363. func BenchmarkAddRemoveSSHConnections(b *testing.B) {
  1364. conn1, conn2 := net.Pipe()
  1365. var conns []*SSHConnection
  1366. for i := 0; i < 2000; i++ {
  1367. conns = append(conns, NewSSHConnection(fmt.Sprintf("id%d", i), conn1))
  1368. }
  1369. b.ResetTimer()
  1370. for i := 0; i < b.N; i++ {
  1371. for _, c := range conns {
  1372. Connections.AddSSHConnection(c)
  1373. }
  1374. for idx := len(conns) - 1; idx >= 0; idx-- {
  1375. Connections.RemoveSSHConnection(conns[idx].GetID())
  1376. }
  1377. }
  1378. conn1.Close()
  1379. conn2.Close()
  1380. }