internal_test.go 53 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844
  1. // Copyright (C) 2019 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 sftpd
  15. import (
  16. "bytes"
  17. "errors"
  18. "fmt"
  19. "io"
  20. "io/fs"
  21. "net"
  22. "os"
  23. "path/filepath"
  24. "runtime"
  25. "slices"
  26. "testing"
  27. "time"
  28. "github.com/eikenb/pipeat"
  29. "github.com/pkg/sftp"
  30. "github.com/rs/xid"
  31. "github.com/sftpgo/sdk"
  32. "github.com/stretchr/testify/assert"
  33. "github.com/stretchr/testify/require"
  34. "golang.org/x/crypto/ssh"
  35. "github.com/drakkan/sftpgo/v2/internal/common"
  36. "github.com/drakkan/sftpgo/v2/internal/dataprovider"
  37. "github.com/drakkan/sftpgo/v2/internal/kms"
  38. "github.com/drakkan/sftpgo/v2/internal/util"
  39. "github.com/drakkan/sftpgo/v2/internal/vfs"
  40. )
  41. const (
  42. osWindows = "windows"
  43. )
  44. var (
  45. configDir = filepath.Join(".", "..", "..")
  46. )
  47. type MockChannel struct {
  48. Buffer *bytes.Buffer
  49. StdErrBuffer *bytes.Buffer
  50. ReadError error
  51. WriteError error
  52. ShortWriteErr bool
  53. }
  54. func (c *MockChannel) Read(data []byte) (int, error) {
  55. if c.ReadError != nil {
  56. return 0, c.ReadError
  57. }
  58. return c.Buffer.Read(data)
  59. }
  60. func (c *MockChannel) Write(data []byte) (int, error) {
  61. if c.WriteError != nil {
  62. return 0, c.WriteError
  63. }
  64. if c.ShortWriteErr {
  65. return 0, nil
  66. }
  67. return c.Buffer.Write(data)
  68. }
  69. func (c *MockChannel) Close() error {
  70. return nil
  71. }
  72. func (c *MockChannel) CloseWrite() error {
  73. return nil
  74. }
  75. func (c *MockChannel) SendRequest(_ string, _ bool, _ []byte) (bool, error) {
  76. return true, nil
  77. }
  78. func (c *MockChannel) Stderr() io.ReadWriter {
  79. return c.StdErrBuffer
  80. }
  81. // MockOsFs mockable OsFs
  82. type MockOsFs struct {
  83. vfs.Fs
  84. err error
  85. statErr error
  86. isAtomicUploadSupported bool
  87. }
  88. // Name returns the name for the Fs implementation
  89. func (fs MockOsFs) Name() string {
  90. return "mockOsFs"
  91. }
  92. // IsUploadResumeSupported returns true if resuming uploads is supported
  93. func (MockOsFs) IsUploadResumeSupported() bool {
  94. return false
  95. }
  96. // IsConditionalUploadResumeSupported returns if resuming uploads is supported
  97. // for the specified size
  98. func (MockOsFs) IsConditionalUploadResumeSupported(_ int64) bool {
  99. return false
  100. }
  101. // IsAtomicUploadSupported returns true if atomic upload is supported
  102. func (fs MockOsFs) IsAtomicUploadSupported() bool {
  103. return fs.isAtomicUploadSupported
  104. }
  105. // Stat returns a FileInfo describing the named file
  106. func (fs MockOsFs) Stat(name string) (os.FileInfo, error) {
  107. if fs.statErr != nil {
  108. return nil, fs.statErr
  109. }
  110. return os.Stat(name)
  111. }
  112. // Lstat returns a FileInfo describing the named file
  113. func (fs MockOsFs) Lstat(name string) (os.FileInfo, error) {
  114. if fs.statErr != nil {
  115. return nil, fs.statErr
  116. }
  117. return os.Lstat(name)
  118. }
  119. // Remove removes the named file or (empty) directory.
  120. func (fs MockOsFs) Remove(name string, _ bool) error {
  121. if fs.err != nil {
  122. return fs.err
  123. }
  124. return os.Remove(name)
  125. }
  126. // Rename renames (moves) source to target
  127. func (fs MockOsFs) Rename(source, target string, _ int) (int, int64, error) {
  128. if fs.err != nil {
  129. return -1, -1, fs.err
  130. }
  131. err := os.Rename(source, target)
  132. return -1, -1, err
  133. }
  134. func newMockOsFs(err, statErr error, atomicUpload bool, connectionID, rootDir string) vfs.Fs {
  135. return &MockOsFs{
  136. Fs: vfs.NewOsFs(connectionID, rootDir, "", nil),
  137. err: err,
  138. statErr: statErr,
  139. isAtomicUploadSupported: atomicUpload,
  140. }
  141. }
  142. func TestRemoveNonexistentQuotaScan(t *testing.T) {
  143. assert.False(t, common.QuotaScans.RemoveUserQuotaScan("username"))
  144. }
  145. func TestGetOSOpenFlags(t *testing.T) {
  146. var flags sftp.FileOpenFlags
  147. flags.Write = true
  148. flags.Excl = true
  149. osFlags := getOSOpenFlags(flags)
  150. assert.NotEqual(t, 0, osFlags&os.O_WRONLY)
  151. assert.NotEqual(t, 0, osFlags&os.O_EXCL)
  152. flags.Append = true
  153. // append flag should be ignored to allow resume
  154. assert.NotEqual(t, 0, osFlags&os.O_WRONLY)
  155. assert.NotEqual(t, 0, osFlags&os.O_EXCL)
  156. }
  157. func TestUploadResumeInvalidOffset(t *testing.T) {
  158. testfile := "testfile" //nolint:goconst
  159. file, err := os.Create(testfile)
  160. assert.NoError(t, err)
  161. user := dataprovider.User{
  162. BaseUser: sdk.BaseUser{
  163. Username: "testuser",
  164. },
  165. }
  166. fs := vfs.NewOsFs("", os.TempDir(), "", nil)
  167. conn := common.NewBaseConnection("", common.ProtocolSFTP, "", "", user)
  168. baseTransfer := common.NewBaseTransfer(file, conn, nil, file.Name(), file.Name(), testfile,
  169. common.TransferUpload, 10, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
  170. transfer := newTransfer(baseTransfer, nil, nil, nil)
  171. _, err = transfer.WriteAt([]byte("test"), 0)
  172. assert.Error(t, err, "upload with invalid offset must fail")
  173. if assert.Error(t, transfer.ErrTransfer) {
  174. assert.EqualError(t, err, transfer.ErrTransfer.Error())
  175. assert.Contains(t, transfer.ErrTransfer.Error(), "invalid write offset")
  176. }
  177. err = transfer.Close()
  178. if assert.Error(t, err) {
  179. assert.ErrorIs(t, err, sftp.ErrSSHFxFailure)
  180. }
  181. err = os.Remove(testfile)
  182. assert.NoError(t, err)
  183. }
  184. func TestReadWriteErrors(t *testing.T) {
  185. testfile := "testfile"
  186. file, err := os.Create(testfile)
  187. assert.NoError(t, err)
  188. user := dataprovider.User{
  189. BaseUser: sdk.BaseUser{
  190. Username: "testuser",
  191. },
  192. }
  193. fs := vfs.NewOsFs("", os.TempDir(), "", nil)
  194. conn := common.NewBaseConnection("", common.ProtocolSFTP, "", "", user)
  195. baseTransfer := common.NewBaseTransfer(file, conn, nil, file.Name(), file.Name(), testfile, common.TransferDownload,
  196. 0, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
  197. transfer := newTransfer(baseTransfer, nil, nil, nil)
  198. err = file.Close()
  199. assert.NoError(t, err)
  200. _, err = transfer.WriteAt([]byte("test"), 0)
  201. assert.Error(t, err, "writing to closed file must fail")
  202. buf := make([]byte, 32768)
  203. _, err = transfer.ReadAt(buf, 0)
  204. assert.Error(t, err, "reading from a closed file must fail")
  205. err = transfer.Close()
  206. assert.Error(t, err)
  207. r, _, err := pipeat.Pipe()
  208. assert.NoError(t, err)
  209. baseTransfer = common.NewBaseTransfer(nil, conn, nil, file.Name(), file.Name(), testfile, common.TransferDownload,
  210. 0, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
  211. transfer = newTransfer(baseTransfer, nil, vfs.NewPipeReader(r), nil)
  212. err = transfer.Close()
  213. assert.NoError(t, err)
  214. _, err = transfer.ReadAt(buf, 0)
  215. assert.Error(t, err, "reading from a closed pipe must fail")
  216. r, w, err := pipeat.Pipe()
  217. assert.NoError(t, err)
  218. pipeWriter := vfs.NewPipeWriter(w)
  219. baseTransfer = common.NewBaseTransfer(nil, conn, nil, file.Name(), file.Name(), testfile, common.TransferDownload,
  220. 0, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
  221. transfer = newTransfer(baseTransfer, pipeWriter, nil, nil)
  222. err = r.Close()
  223. assert.NoError(t, err)
  224. errFake := fmt.Errorf("fake upload error")
  225. go func() {
  226. time.Sleep(100 * time.Millisecond)
  227. pipeWriter.Done(errFake)
  228. }()
  229. err = transfer.closeIO()
  230. assert.EqualError(t, err, errFake.Error())
  231. _, err = transfer.WriteAt([]byte("test"), 0)
  232. assert.Error(t, err, "writing to closed pipe must fail")
  233. err = transfer.BaseTransfer.Close()
  234. assert.EqualError(t, err, errFake.Error())
  235. err = os.Remove(testfile)
  236. assert.NoError(t, err)
  237. assert.Len(t, conn.GetTransfers(), 0)
  238. assert.Equal(t, int32(0), common.Connections.GetTotalTransfers())
  239. }
  240. func TestUnsupportedListOP(t *testing.T) {
  241. conn := common.NewBaseConnection("", common.ProtocolSFTP, "", "", dataprovider.User{})
  242. sftpConn := Connection{
  243. BaseConnection: conn,
  244. }
  245. request := sftp.NewRequest("Unsupported", "")
  246. _, err := sftpConn.Filelist(request)
  247. assert.EqualError(t, err, sftp.ErrSSHFxOpUnsupported.Error())
  248. }
  249. func TestTransferCancelFn(t *testing.T) {
  250. testfile := "testfile"
  251. file, err := os.Create(testfile)
  252. assert.NoError(t, err)
  253. isCancelled := false
  254. cancelFn := func() {
  255. isCancelled = true
  256. }
  257. user := dataprovider.User{
  258. BaseUser: sdk.BaseUser{
  259. Username: "testuser",
  260. },
  261. }
  262. fs := vfs.NewOsFs("", os.TempDir(), "", nil)
  263. conn := common.NewBaseConnection("", common.ProtocolSFTP, "", "", user)
  264. baseTransfer := common.NewBaseTransfer(file, conn, cancelFn, file.Name(), file.Name(), testfile, common.TransferDownload,
  265. 0, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
  266. transfer := newTransfer(baseTransfer, nil, nil, nil)
  267. errFake := errors.New("fake error, this will trigger cancelFn")
  268. transfer.TransferError(errFake)
  269. err = transfer.Close()
  270. if assert.Error(t, err) {
  271. assert.ErrorIs(t, err, sftp.ErrSSHFxFailure)
  272. }
  273. if assert.Error(t, transfer.ErrTransfer) {
  274. assert.EqualError(t, transfer.ErrTransfer, errFake.Error())
  275. }
  276. assert.True(t, isCancelled, "cancelFn not called!")
  277. err = os.Remove(testfile)
  278. assert.NoError(t, err)
  279. }
  280. func TestUploadFiles(t *testing.T) {
  281. common.Config.UploadMode = common.UploadModeAtomic
  282. fs := vfs.NewOsFs("123", os.TempDir(), "", nil)
  283. u := dataprovider.User{}
  284. c := Connection{
  285. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", u),
  286. }
  287. var flags sftp.FileOpenFlags
  288. flags.Write = true
  289. flags.Trunc = true
  290. _, err := c.handleSFTPUploadToExistingFile(fs, flags, "missing_path", "other_missing_path", 0, "/missing_path", nil)
  291. assert.Error(t, err, "upload to existing file must fail if one or both paths are invalid")
  292. common.Config.UploadMode = common.UploadModeStandard
  293. _, err = c.handleSFTPUploadToExistingFile(fs, flags, "missing_path", "other_missing_path", 0, "/missing_path", nil)
  294. assert.Error(t, err, "upload to existing file must fail if one or both paths are invalid")
  295. missingFile := "missing/relative/file.txt"
  296. if runtime.GOOS == osWindows {
  297. missingFile = "missing\\relative\\file.txt"
  298. }
  299. _, err = c.handleSFTPUploadToNewFile(fs, flags, ".", missingFile, "/missing", nil)
  300. assert.Error(t, err, "upload new file in missing path must fail")
  301. fs = newMockOsFs(nil, nil, false, "123", os.TempDir())
  302. f, err := os.CreateTemp("", "temp")
  303. assert.NoError(t, err)
  304. err = f.Close()
  305. assert.NoError(t, err)
  306. tr, err := c.handleSFTPUploadToExistingFile(fs, flags, f.Name(), f.Name(), 123, f.Name(), nil)
  307. if assert.NoError(t, err) {
  308. transfer := tr.(*transfer)
  309. transfers := c.GetTransfers()
  310. if assert.Equal(t, 1, len(transfers)) {
  311. assert.Equal(t, transfers[0].ID, transfer.GetID())
  312. assert.Equal(t, int64(123), transfer.InitialSize)
  313. err = transfer.Close()
  314. assert.NoError(t, err)
  315. assert.Equal(t, 0, len(c.GetTransfers()))
  316. }
  317. }
  318. err = os.Remove(f.Name())
  319. assert.NoError(t, err)
  320. common.Config.UploadMode = common.UploadModeAtomicWithResume
  321. }
  322. func TestWithInvalidHome(t *testing.T) {
  323. u := dataprovider.User{}
  324. u.HomeDir = "home_rel_path" //nolint:goconst
  325. _, err := loginUser(&u, dataprovider.LoginMethodPassword, "", nil)
  326. assert.Error(t, err, "login a user with an invalid home_dir must fail")
  327. u.HomeDir = os.TempDir()
  328. fs, err := u.GetFilesystem("123")
  329. assert.NoError(t, err)
  330. c := Connection{
  331. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", u),
  332. }
  333. _, err = fs.ResolvePath("../upper_path")
  334. assert.Error(t, err, "tested path is not a home subdir")
  335. _, err = c.StatVFS(&sftp.Request{
  336. Method: "StatVFS",
  337. Filepath: "../unresolvable-path",
  338. })
  339. assert.Error(t, err)
  340. }
  341. func TestResolveWithRootDir(t *testing.T) {
  342. u := dataprovider.User{}
  343. if runtime.GOOS == osWindows {
  344. u.HomeDir = "C:\\"
  345. } else {
  346. u.HomeDir = "/"
  347. }
  348. fs, err := u.GetFilesystem("")
  349. assert.NoError(t, err)
  350. rel, err := filepath.Rel(u.HomeDir, os.TempDir())
  351. assert.NoError(t, err)
  352. p, err := fs.ResolvePath(rel)
  353. assert.NoError(t, err, "path %v", p)
  354. }
  355. func TestSFTPGetUsedQuota(t *testing.T) {
  356. u := dataprovider.User{}
  357. u.HomeDir = "home_rel_path"
  358. u.Username = "test_invalid_user"
  359. u.QuotaSize = 4096
  360. u.QuotaFiles = 1
  361. u.Permissions = make(map[string][]string)
  362. u.Permissions["/"] = []string{dataprovider.PermAny}
  363. connection := Connection{
  364. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", u),
  365. }
  366. quotaResult, _ := connection.HasSpace(false, false, "/")
  367. assert.False(t, quotaResult.HasSpace)
  368. }
  369. func TestSupportedSSHCommands(t *testing.T) {
  370. cmds := GetSupportedSSHCommands()
  371. assert.Equal(t, len(supportedSSHCommands), len(cmds))
  372. for _, c := range cmds {
  373. assert.True(t, slices.Contains(supportedSSHCommands, c))
  374. }
  375. }
  376. func TestSSHCommandPath(t *testing.T) {
  377. buf := make([]byte, 65535)
  378. stdErrBuf := make([]byte, 65535)
  379. mockSSHChannel := MockChannel{
  380. Buffer: bytes.NewBuffer(buf),
  381. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  382. ReadError: nil,
  383. }
  384. connection := &Connection{
  385. channel: &mockSSHChannel,
  386. BaseConnection: common.NewBaseConnection("", common.ProtocolSSH, "", "", dataprovider.User{}),
  387. }
  388. sshCommand := sshCommand{
  389. command: "test",
  390. connection: connection,
  391. args: []string{},
  392. }
  393. assert.Equal(t, "", sshCommand.getDestPath())
  394. sshCommand.args = []string{"-t", "/tmp/../path"}
  395. assert.Equal(t, "/path", sshCommand.getDestPath())
  396. sshCommand.args = []string{"-t", "/tmp/"}
  397. assert.Equal(t, "/tmp/", sshCommand.getDestPath())
  398. sshCommand.args = []string{"-t", "tmp/"}
  399. assert.Equal(t, "/tmp/", sshCommand.getDestPath())
  400. sshCommand.args = []string{"-t", "/tmp/../../../path"}
  401. assert.Equal(t, "/path", sshCommand.getDestPath())
  402. sshCommand.args = []string{"-t", ".."}
  403. assert.Equal(t, "/", sshCommand.getDestPath())
  404. sshCommand.args = []string{"-t", "."}
  405. assert.Equal(t, "/", sshCommand.getDestPath())
  406. sshCommand.args = []string{"-t", "//"}
  407. assert.Equal(t, "/", sshCommand.getDestPath())
  408. sshCommand.args = []string{"-t", "../.."}
  409. assert.Equal(t, "/", sshCommand.getDestPath())
  410. sshCommand.args = []string{"-t", "/.."}
  411. assert.Equal(t, "/", sshCommand.getDestPath())
  412. sshCommand.args = []string{"-f", "/a space.txt"}
  413. assert.Equal(t, "/a space.txt", sshCommand.getDestPath())
  414. }
  415. func TestSSHParseCommandPayload(t *testing.T) {
  416. cmd := "command -a -f /ab\\ à/some\\ spaces\\ \\ \\(\\).txt"
  417. name, args, _ := parseCommandPayload(cmd)
  418. assert.Equal(t, "command", name)
  419. assert.Equal(t, 3, len(args))
  420. assert.Equal(t, "/ab à/some spaces ().txt", args[2])
  421. _, _, err := parseCommandPayload("")
  422. assert.Error(t, err, "parsing invalid command must fail")
  423. }
  424. func TestSSHCommandErrors(t *testing.T) {
  425. buf := make([]byte, 65535)
  426. stdErrBuf := make([]byte, 65535)
  427. readErr := fmt.Errorf("test read error")
  428. mockSSHChannel := MockChannel{
  429. Buffer: bytes.NewBuffer(buf),
  430. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  431. ReadError: readErr,
  432. }
  433. server, client := net.Pipe()
  434. defer func() {
  435. err := server.Close()
  436. assert.NoError(t, err)
  437. }()
  438. defer func() {
  439. err := client.Close()
  440. assert.NoError(t, err)
  441. }()
  442. user := dataprovider.User{}
  443. user.Permissions = map[string][]string{
  444. "/": {dataprovider.PermAny},
  445. }
  446. connection := Connection{
  447. BaseConnection: common.NewBaseConnection("", common.ProtocolSSH, "", "", user),
  448. channel: &mockSSHChannel,
  449. }
  450. cmd := sshCommand{
  451. command: "md5sum",
  452. connection: &connection,
  453. args: []string{},
  454. }
  455. err := cmd.handle()
  456. assert.Error(t, err, "ssh command must fail, we are sending a fake error")
  457. cmd = sshCommand{
  458. command: "md5sum",
  459. connection: &connection,
  460. args: []string{"/../../test_file_ftp.dat"},
  461. }
  462. err = cmd.handle()
  463. assert.Error(t, err, "ssh command must fail, we are requesting an invalid path")
  464. user = dataprovider.User{}
  465. user.Permissions = map[string][]string{
  466. "/": {dataprovider.PermAny},
  467. }
  468. user.HomeDir = filepath.Clean(os.TempDir())
  469. user.QuotaFiles = 1
  470. user.UsedQuotaFiles = 2
  471. cmd.connection.User = user
  472. _, err = cmd.connection.User.GetFilesystem("123")
  473. assert.NoError(t, err)
  474. cmd = sshCommand{
  475. command: "sftpgo-remove",
  476. connection: &connection,
  477. args: []string{"/../../src"},
  478. }
  479. err = cmd.handle()
  480. assert.Error(t, err, "ssh command must fail, we are requesting an invalid path")
  481. cmd = sshCommand{
  482. command: "sftpgo-copy",
  483. connection: &connection,
  484. args: []string{"/../../test_src", "."},
  485. }
  486. err = cmd.handle()
  487. assert.Error(t, err, "ssh command must fail, we are requesting an invalid path")
  488. err = common.Initialize(common.Config, 0)
  489. assert.NoError(t, err)
  490. }
  491. func TestCommandsWithExtensionsFilter(t *testing.T) {
  492. buf := make([]byte, 65535)
  493. stdErrBuf := make([]byte, 65535)
  494. mockSSHChannel := MockChannel{
  495. Buffer: bytes.NewBuffer(buf),
  496. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  497. }
  498. server, client := net.Pipe()
  499. defer server.Close()
  500. defer client.Close()
  501. user := dataprovider.User{
  502. BaseUser: sdk.BaseUser{
  503. Username: "test",
  504. HomeDir: os.TempDir(),
  505. Status: 1,
  506. },
  507. }
  508. user.Filters.FilePatterns = []sdk.PatternsFilter{
  509. {
  510. Path: "/subdir",
  511. AllowedPatterns: []string{".jpg"},
  512. DeniedPatterns: []string{},
  513. },
  514. }
  515. connection := &Connection{
  516. BaseConnection: common.NewBaseConnection("", common.ProtocolSSH, "", "", user),
  517. channel: &mockSSHChannel,
  518. }
  519. cmd := sshCommand{
  520. command: "md5sum",
  521. connection: connection,
  522. args: []string{"subdir/test.png"},
  523. }
  524. err := cmd.handleHashCommands()
  525. assert.EqualError(t, err, common.ErrPermissionDenied.Error())
  526. }
  527. func TestSSHCommandsRemoteFs(t *testing.T) {
  528. buf := make([]byte, 65535)
  529. stdErrBuf := make([]byte, 65535)
  530. mockSSHChannel := MockChannel{
  531. Buffer: bytes.NewBuffer(buf),
  532. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  533. }
  534. user := dataprovider.User{}
  535. user.FsConfig = vfs.Filesystem{
  536. Provider: sdk.S3FilesystemProvider,
  537. S3Config: vfs.S3FsConfig{
  538. BaseS3FsConfig: sdk.BaseS3FsConfig{
  539. Bucket: "s3bucket",
  540. Endpoint: "endpoint",
  541. Region: "eu-west-1",
  542. },
  543. },
  544. }
  545. connection := &Connection{
  546. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
  547. channel: &mockSSHChannel,
  548. }
  549. cmd := sshCommand{
  550. command: "md5sum",
  551. connection: connection,
  552. args: []string{},
  553. }
  554. err := cmd.handleSFTPGoCopy()
  555. assert.Error(t, err)
  556. cmd = sshCommand{
  557. command: "sftpgo-remove",
  558. connection: connection,
  559. args: []string{},
  560. }
  561. err = cmd.handleSFTPGoRemove()
  562. assert.Error(t, err)
  563. }
  564. func TestSSHCmdGetFsErrors(t *testing.T) {
  565. buf := make([]byte, 65535)
  566. stdErrBuf := make([]byte, 65535)
  567. mockSSHChannel := MockChannel{
  568. Buffer: bytes.NewBuffer(buf),
  569. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  570. }
  571. user := dataprovider.User{
  572. BaseUser: sdk.BaseUser{
  573. HomeDir: "relative path",
  574. },
  575. }
  576. user.Permissions = map[string][]string{}
  577. user.Permissions["/"] = []string{dataprovider.PermAny}
  578. connection := &Connection{
  579. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
  580. channel: &mockSSHChannel,
  581. }
  582. cmd := sshCommand{
  583. command: "sftpgo-remove",
  584. connection: connection,
  585. args: []string{"path"},
  586. }
  587. err := cmd.handleSFTPGoRemove()
  588. assert.Error(t, err)
  589. cmd = sshCommand{
  590. command: "sftpgo-copy",
  591. connection: connection,
  592. args: []string{"path1", "path2"},
  593. }
  594. err = cmd.handleSFTPGoCopy()
  595. assert.Error(t, err)
  596. err = os.RemoveAll(user.GetHomeDir())
  597. assert.NoError(t, err)
  598. }
  599. func TestCommandGetFsError(t *testing.T) {
  600. user := dataprovider.User{
  601. FsConfig: vfs.Filesystem{
  602. Provider: sdk.CryptedFilesystemProvider,
  603. },
  604. }
  605. buf := make([]byte, 65535)
  606. stdErrBuf := make([]byte, 65535)
  607. mockSSHChannel := MockChannel{
  608. Buffer: bytes.NewBuffer(buf),
  609. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  610. ReadError: nil,
  611. }
  612. conn := &Connection{
  613. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", user),
  614. channel: &mockSSHChannel,
  615. }
  616. scpCommand := scpCommand{
  617. sshCommand: sshCommand{
  618. command: "scp",
  619. connection: conn,
  620. args: []string{"-t", "/tmp"},
  621. },
  622. }
  623. err := scpCommand.handleRecursiveUpload()
  624. assert.Error(t, err)
  625. err = scpCommand.handleDownload("")
  626. assert.Error(t, err)
  627. }
  628. func TestSCPFileMode(t *testing.T) {
  629. mode := getFileModeAsString(0, true)
  630. assert.Equal(t, "0755", mode)
  631. mode = getFileModeAsString(0700, true)
  632. assert.Equal(t, "0700", mode)
  633. mode = getFileModeAsString(0750, true)
  634. assert.Equal(t, "0750", mode)
  635. mode = getFileModeAsString(0777, true)
  636. assert.Equal(t, "0777", mode)
  637. mode = getFileModeAsString(0640, false)
  638. assert.Equal(t, "0640", mode)
  639. mode = getFileModeAsString(0600, false)
  640. assert.Equal(t, "0600", mode)
  641. mode = getFileModeAsString(0, false)
  642. assert.Equal(t, "0644", mode)
  643. fileMode := uint32(0777)
  644. fileMode = fileMode | uint32(os.ModeSetgid)
  645. fileMode = fileMode | uint32(os.ModeSetuid)
  646. fileMode = fileMode | uint32(os.ModeSticky)
  647. mode = getFileModeAsString(os.FileMode(fileMode), false)
  648. assert.Equal(t, "7777", mode)
  649. fileMode = uint32(0644)
  650. fileMode = fileMode | uint32(os.ModeSetgid)
  651. mode = getFileModeAsString(os.FileMode(fileMode), false)
  652. assert.Equal(t, "4644", mode)
  653. fileMode = uint32(0600)
  654. fileMode = fileMode | uint32(os.ModeSetuid)
  655. mode = getFileModeAsString(os.FileMode(fileMode), false)
  656. assert.Equal(t, "2600", mode)
  657. fileMode = uint32(0044)
  658. fileMode = fileMode | uint32(os.ModeSticky)
  659. mode = getFileModeAsString(os.FileMode(fileMode), false)
  660. assert.Equal(t, "1044", mode)
  661. }
  662. func TestSCPUploadError(t *testing.T) {
  663. buf := make([]byte, 65535)
  664. stdErrBuf := make([]byte, 65535)
  665. writeErr := fmt.Errorf("test write error")
  666. mockSSHChannel := MockChannel{
  667. Buffer: bytes.NewBuffer(buf),
  668. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  669. ReadError: nil,
  670. WriteError: writeErr,
  671. }
  672. user := dataprovider.User{
  673. BaseUser: sdk.BaseUser{
  674. HomeDir: filepath.Join(os.TempDir()),
  675. Permissions: make(map[string][]string),
  676. },
  677. }
  678. user.Permissions["/"] = []string{dataprovider.PermAny}
  679. connection := &Connection{
  680. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
  681. channel: &mockSSHChannel,
  682. }
  683. scpCommand := scpCommand{
  684. sshCommand: sshCommand{
  685. command: "scp",
  686. connection: connection,
  687. args: []string{"-t", "/"},
  688. },
  689. }
  690. err := scpCommand.handle()
  691. assert.EqualError(t, err, writeErr.Error())
  692. mockSSHChannel = MockChannel{
  693. Buffer: bytes.NewBuffer([]byte("D0755 0 testdir\n")),
  694. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  695. ReadError: nil,
  696. WriteError: writeErr,
  697. }
  698. err = scpCommand.handleRecursiveUpload()
  699. assert.EqualError(t, err, writeErr.Error())
  700. mockSSHChannel = MockChannel{
  701. Buffer: bytes.NewBuffer([]byte("D0755 a testdir\n")),
  702. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  703. ReadError: nil,
  704. WriteError: nil,
  705. }
  706. err = scpCommand.handleRecursiveUpload()
  707. assert.Error(t, err)
  708. }
  709. func TestSCPInvalidEndDir(t *testing.T) {
  710. stdErrBuf := make([]byte, 65535)
  711. mockSSHChannel := MockChannel{
  712. Buffer: bytes.NewBuffer([]byte("E\n")),
  713. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  714. }
  715. connection := &Connection{
  716. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", dataprovider.User{
  717. BaseUser: sdk.BaseUser{
  718. HomeDir: os.TempDir(),
  719. },
  720. }),
  721. channel: &mockSSHChannel,
  722. }
  723. scpCommand := scpCommand{
  724. sshCommand: sshCommand{
  725. command: "scp",
  726. connection: connection,
  727. args: []string{"-t", "/tmp"},
  728. },
  729. }
  730. err := scpCommand.handleRecursiveUpload()
  731. assert.EqualError(t, err, "unacceptable end dir command")
  732. }
  733. func TestSCPParseUploadMessage(t *testing.T) {
  734. buf := make([]byte, 65535)
  735. stdErrBuf := make([]byte, 65535)
  736. mockSSHChannel := MockChannel{
  737. Buffer: bytes.NewBuffer(buf),
  738. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  739. ReadError: nil,
  740. }
  741. fs := vfs.NewOsFs("", os.TempDir(), "", nil)
  742. connection := &Connection{
  743. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", dataprovider.User{
  744. BaseUser: sdk.BaseUser{
  745. HomeDir: os.TempDir(),
  746. },
  747. }),
  748. channel: &mockSSHChannel,
  749. }
  750. scpCommand := scpCommand{
  751. sshCommand: sshCommand{
  752. command: "scp",
  753. connection: connection,
  754. args: []string{"-t", "/tmp"},
  755. },
  756. }
  757. _, _, err := scpCommand.parseUploadMessage(fs, "invalid")
  758. assert.Error(t, err, "parsing invalid upload message must fail")
  759. _, _, err = scpCommand.parseUploadMessage(fs, "D0755 0")
  760. assert.Error(t, err, "parsing incomplete upload message must fail")
  761. _, _, err = scpCommand.parseUploadMessage(fs, "D0755 invalidsize testdir")
  762. assert.Error(t, err, "parsing upload message with invalid size must fail")
  763. _, _, err = scpCommand.parseUploadMessage(fs, "D0755 0 ")
  764. assert.Error(t, err, "parsing upload message with invalid name must fail")
  765. }
  766. func TestSCPProtocolMessages(t *testing.T) {
  767. buf := make([]byte, 65535)
  768. stdErrBuf := make([]byte, 65535)
  769. readErr := fmt.Errorf("test read error")
  770. writeErr := fmt.Errorf("test write error")
  771. mockSSHChannel := MockChannel{
  772. Buffer: bytes.NewBuffer(buf),
  773. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  774. ReadError: readErr,
  775. WriteError: writeErr,
  776. }
  777. connection := &Connection{
  778. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", dataprovider.User{}),
  779. channel: &mockSSHChannel,
  780. }
  781. scpCommand := scpCommand{
  782. sshCommand: sshCommand{
  783. command: "scp",
  784. connection: connection,
  785. args: []string{"-t", "/tmp"},
  786. },
  787. }
  788. _, err := scpCommand.readProtocolMessage()
  789. assert.EqualError(t, err, readErr.Error())
  790. err = scpCommand.sendConfirmationMessage()
  791. assert.EqualError(t, err, writeErr.Error())
  792. err = scpCommand.sendProtocolMessage("E\n")
  793. assert.EqualError(t, err, writeErr.Error())
  794. _, err = scpCommand.getNextUploadProtocolMessage()
  795. assert.EqualError(t, err, readErr.Error())
  796. mockSSHChannel = MockChannel{
  797. Buffer: bytes.NewBuffer([]byte("T1183832947 0 1183833773 0\n")),
  798. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  799. ReadError: nil,
  800. WriteError: writeErr,
  801. }
  802. scpCommand.connection.channel = &mockSSHChannel
  803. _, err = scpCommand.getNextUploadProtocolMessage()
  804. assert.EqualError(t, err, writeErr.Error())
  805. respBuffer := []byte{0x02}
  806. protocolErrorMsg := "protocol error msg"
  807. respBuffer = append(respBuffer, protocolErrorMsg...)
  808. respBuffer = append(respBuffer, 0x0A)
  809. mockSSHChannel = MockChannel{
  810. Buffer: bytes.NewBuffer(respBuffer),
  811. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  812. ReadError: nil,
  813. WriteError: nil,
  814. }
  815. scpCommand.connection.channel = &mockSSHChannel
  816. err = scpCommand.readConfirmationMessage()
  817. if assert.Error(t, err) {
  818. assert.Equal(t, protocolErrorMsg, err.Error())
  819. }
  820. mockSSHChannel = MockChannel{
  821. Buffer: bytes.NewBuffer(respBuffer),
  822. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  823. ReadError: nil,
  824. WriteError: writeErr,
  825. }
  826. scpCommand.connection.channel = &mockSSHChannel
  827. err = scpCommand.downloadDirs(nil, nil)
  828. assert.ErrorIs(t, err, writeErr)
  829. }
  830. func TestSCPTestDownloadProtocolMessages(t *testing.T) {
  831. buf := make([]byte, 65535)
  832. stdErrBuf := make([]byte, 65535)
  833. readErr := fmt.Errorf("test read error")
  834. writeErr := fmt.Errorf("test write error")
  835. mockSSHChannel := MockChannel{
  836. Buffer: bytes.NewBuffer(buf),
  837. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  838. ReadError: readErr,
  839. WriteError: writeErr,
  840. }
  841. connection := &Connection{
  842. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", dataprovider.User{}),
  843. channel: &mockSSHChannel,
  844. }
  845. scpCommand := scpCommand{
  846. sshCommand: sshCommand{
  847. command: "scp",
  848. connection: connection,
  849. args: []string{"-f", "-p", "/tmp"},
  850. },
  851. }
  852. path := "testDir"
  853. err := os.Mkdir(path, os.ModePerm)
  854. assert.NoError(t, err)
  855. stat, err := os.Stat(path)
  856. assert.NoError(t, err)
  857. err = scpCommand.sendDownloadProtocolMessages(path, stat)
  858. assert.EqualError(t, err, writeErr.Error())
  859. mockSSHChannel = MockChannel{
  860. Buffer: bytes.NewBuffer(buf),
  861. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  862. ReadError: readErr,
  863. WriteError: nil,
  864. }
  865. err = scpCommand.sendDownloadProtocolMessages(path, stat)
  866. assert.EqualError(t, err, readErr.Error())
  867. mockSSHChannel = MockChannel{
  868. Buffer: bytes.NewBuffer(buf),
  869. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  870. ReadError: readErr,
  871. WriteError: writeErr,
  872. }
  873. scpCommand.args = []string{"-f", "/tmp"}
  874. scpCommand.connection.channel = &mockSSHChannel
  875. err = scpCommand.sendDownloadProtocolMessages(path, stat)
  876. assert.EqualError(t, err, writeErr.Error())
  877. mockSSHChannel = MockChannel{
  878. Buffer: bytes.NewBuffer(buf),
  879. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  880. ReadError: readErr,
  881. WriteError: nil,
  882. }
  883. scpCommand.connection.channel = &mockSSHChannel
  884. err = scpCommand.sendDownloadProtocolMessages(path, stat)
  885. assert.EqualError(t, err, readErr.Error())
  886. err = os.Remove(path)
  887. assert.NoError(t, err)
  888. }
  889. func TestSCPCommandHandleErrors(t *testing.T) {
  890. buf := make([]byte, 65535)
  891. stdErrBuf := make([]byte, 65535)
  892. readErr := fmt.Errorf("test read error")
  893. writeErr := fmt.Errorf("test write error")
  894. mockSSHChannel := MockChannel{
  895. Buffer: bytes.NewBuffer(buf),
  896. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  897. ReadError: readErr,
  898. WriteError: writeErr,
  899. }
  900. server, client := net.Pipe()
  901. defer func() {
  902. err := server.Close()
  903. assert.NoError(t, err)
  904. }()
  905. defer func() {
  906. err := client.Close()
  907. assert.NoError(t, err)
  908. }()
  909. connection := &Connection{
  910. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", dataprovider.User{}),
  911. channel: &mockSSHChannel,
  912. }
  913. scpCommand := scpCommand{
  914. sshCommand: sshCommand{
  915. command: "scp",
  916. connection: connection,
  917. args: []string{"-f", "/tmp"},
  918. },
  919. }
  920. err := scpCommand.handle()
  921. assert.EqualError(t, err, readErr.Error())
  922. scpCommand.args = []string{"-i", "/tmp"}
  923. err = scpCommand.handle()
  924. assert.Error(t, err, "invalid scp command must fail")
  925. }
  926. func TestSCPErrorsMockFs(t *testing.T) {
  927. errFake := errors.New("fake error")
  928. u := dataprovider.User{}
  929. u.Username = "test"
  930. u.Permissions = make(map[string][]string)
  931. u.Permissions["/"] = []string{dataprovider.PermAny}
  932. u.HomeDir = os.TempDir()
  933. buf := make([]byte, 65535)
  934. stdErrBuf := make([]byte, 65535)
  935. mockSSHChannel := MockChannel{
  936. Buffer: bytes.NewBuffer(buf),
  937. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  938. }
  939. server, client := net.Pipe()
  940. defer func() {
  941. err := server.Close()
  942. assert.NoError(t, err)
  943. }()
  944. defer func() {
  945. err := client.Close()
  946. assert.NoError(t, err)
  947. }()
  948. connection := &Connection{
  949. channel: &mockSSHChannel,
  950. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", u),
  951. }
  952. scpCommand := scpCommand{
  953. sshCommand: sshCommand{
  954. command: "scp",
  955. connection: connection,
  956. args: []string{"-r", "-t", "/tmp"},
  957. },
  958. }
  959. testfile := filepath.Join(u.HomeDir, "testfile")
  960. err := os.WriteFile(testfile, []byte("test"), os.ModePerm)
  961. assert.NoError(t, err)
  962. fs := newMockOsFs(errFake, nil, true, "123", os.TempDir())
  963. err = scpCommand.handleUploadFile(fs, testfile, testfile, 0, false, 4, "/testfile")
  964. assert.NoError(t, err)
  965. err = os.Remove(testfile)
  966. assert.NoError(t, err)
  967. }
  968. func TestSCPRecursiveDownloadErrors(t *testing.T) {
  969. buf := make([]byte, 65535)
  970. stdErrBuf := make([]byte, 65535)
  971. readErr := fmt.Errorf("test read error")
  972. writeErr := fmt.Errorf("test write error")
  973. mockSSHChannel := MockChannel{
  974. Buffer: bytes.NewBuffer(buf),
  975. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  976. ReadError: readErr,
  977. WriteError: writeErr,
  978. }
  979. server, client := net.Pipe()
  980. defer func() {
  981. err := server.Close()
  982. assert.NoError(t, err)
  983. }()
  984. defer func() {
  985. err := client.Close()
  986. assert.NoError(t, err)
  987. }()
  988. fs := vfs.NewOsFs("123", os.TempDir(), "", nil)
  989. connection := &Connection{
  990. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", dataprovider.User{
  991. BaseUser: sdk.BaseUser{
  992. HomeDir: os.TempDir(),
  993. },
  994. }),
  995. channel: &mockSSHChannel,
  996. }
  997. scpCommand := scpCommand{
  998. sshCommand: sshCommand{
  999. command: "scp",
  1000. connection: connection,
  1001. args: []string{"-r", "-f", "/tmp"},
  1002. },
  1003. }
  1004. path := "testDir"
  1005. err := os.Mkdir(path, os.ModePerm)
  1006. assert.NoError(t, err)
  1007. stat, err := os.Stat(path)
  1008. assert.NoError(t, err)
  1009. err = scpCommand.handleRecursiveDownload(fs, "invalid_dir", "invalid_dir", stat)
  1010. assert.EqualError(t, err, writeErr.Error())
  1011. mockSSHChannel = MockChannel{
  1012. Buffer: bytes.NewBuffer(buf),
  1013. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1014. ReadError: nil,
  1015. WriteError: nil,
  1016. }
  1017. scpCommand.connection.channel = &mockSSHChannel
  1018. err = scpCommand.handleRecursiveDownload(fs, "invalid_dir", "invalid_dir", stat)
  1019. assert.Error(t, err, "recursive upload download must fail for a non existing dir")
  1020. err = os.Remove(path)
  1021. assert.NoError(t, err)
  1022. }
  1023. func TestSCPRecursiveUploadErrors(t *testing.T) {
  1024. buf := make([]byte, 65535)
  1025. stdErrBuf := make([]byte, 65535)
  1026. readErr := fmt.Errorf("test read error")
  1027. writeErr := fmt.Errorf("test write error")
  1028. mockSSHChannel := MockChannel{
  1029. Buffer: bytes.NewBuffer(buf),
  1030. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1031. ReadError: readErr,
  1032. WriteError: writeErr,
  1033. }
  1034. connection := &Connection{
  1035. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", dataprovider.User{}),
  1036. channel: &mockSSHChannel,
  1037. }
  1038. scpCommand := scpCommand{
  1039. sshCommand: sshCommand{
  1040. command: "scp",
  1041. connection: connection,
  1042. args: []string{"-r", "-t", "/tmp"},
  1043. },
  1044. }
  1045. err := scpCommand.handleRecursiveUpload()
  1046. assert.Error(t, err, "recursive upload must fail, we send a fake error message")
  1047. mockSSHChannel = MockChannel{
  1048. Buffer: bytes.NewBuffer(buf),
  1049. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1050. ReadError: readErr,
  1051. WriteError: nil,
  1052. }
  1053. scpCommand.connection.channel = &mockSSHChannel
  1054. err = scpCommand.handleRecursiveUpload()
  1055. assert.Error(t, err, "recursive upload must fail, we send a fake error message")
  1056. }
  1057. func TestSCPCreateDirs(t *testing.T) {
  1058. buf := make([]byte, 65535)
  1059. stdErrBuf := make([]byte, 65535)
  1060. u := dataprovider.User{}
  1061. u.HomeDir = "home_rel_path"
  1062. u.Username = "test"
  1063. u.Permissions = make(map[string][]string)
  1064. u.Permissions["/"] = []string{dataprovider.PermAny}
  1065. mockSSHChannel := MockChannel{
  1066. Buffer: bytes.NewBuffer(buf),
  1067. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1068. ReadError: nil,
  1069. WriteError: nil,
  1070. }
  1071. fs, err := u.GetFilesystem("123")
  1072. assert.NoError(t, err)
  1073. connection := &Connection{
  1074. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", u),
  1075. channel: &mockSSHChannel,
  1076. }
  1077. scpCommand := scpCommand{
  1078. sshCommand: sshCommand{
  1079. command: "scp",
  1080. connection: connection,
  1081. args: []string{"-r", "-t", "/tmp"},
  1082. },
  1083. }
  1084. err = scpCommand.handleCreateDir(fs, "invalid_dir")
  1085. assert.Error(t, err, "create invalid dir must fail")
  1086. }
  1087. func TestSCPDownloadFileData(t *testing.T) {
  1088. testfile := "testfile"
  1089. buf := make([]byte, 65535)
  1090. readErr := fmt.Errorf("test read error")
  1091. writeErr := fmt.Errorf("test write error")
  1092. stdErrBuf := make([]byte, 65535)
  1093. mockSSHChannelReadErr := MockChannel{
  1094. Buffer: bytes.NewBuffer(buf),
  1095. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1096. ReadError: readErr,
  1097. WriteError: nil,
  1098. }
  1099. mockSSHChannelWriteErr := MockChannel{
  1100. Buffer: bytes.NewBuffer(buf),
  1101. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1102. ReadError: nil,
  1103. WriteError: writeErr,
  1104. }
  1105. fs := vfs.NewOsFs("", os.TempDir(), "", nil)
  1106. connection := &Connection{
  1107. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", dataprovider.User{BaseUser: sdk.BaseUser{HomeDir: os.TempDir()}}),
  1108. channel: &mockSSHChannelReadErr,
  1109. }
  1110. scpCommand := scpCommand{
  1111. sshCommand: sshCommand{
  1112. command: "scp",
  1113. connection: connection,
  1114. args: []string{"-r", "-f", "/tmp"},
  1115. },
  1116. }
  1117. err := os.WriteFile(testfile, []byte("test"), os.ModePerm)
  1118. assert.NoError(t, err)
  1119. stat, err := os.Stat(testfile)
  1120. assert.NoError(t, err)
  1121. err = scpCommand.sendDownloadFileData(fs, testfile, stat, nil)
  1122. assert.EqualError(t, err, readErr.Error())
  1123. scpCommand.connection.channel = &mockSSHChannelWriteErr
  1124. err = scpCommand.sendDownloadFileData(fs, testfile, stat, nil)
  1125. assert.EqualError(t, err, writeErr.Error())
  1126. scpCommand.args = []string{"-r", "-p", "-f", "/tmp"}
  1127. err = scpCommand.sendDownloadFileData(fs, testfile, stat, nil)
  1128. assert.EqualError(t, err, writeErr.Error())
  1129. scpCommand.connection.channel = &mockSSHChannelReadErr
  1130. err = scpCommand.sendDownloadFileData(fs, testfile, stat, nil)
  1131. assert.EqualError(t, err, readErr.Error())
  1132. err = os.Remove(testfile)
  1133. assert.NoError(t, err)
  1134. }
  1135. func TestSCPUploadFiledata(t *testing.T) {
  1136. testfile := "testfile"
  1137. buf := make([]byte, 65535)
  1138. stdErrBuf := make([]byte, 65535)
  1139. readErr := fmt.Errorf("test read error")
  1140. writeErr := fmt.Errorf("test write error")
  1141. mockSSHChannel := MockChannel{
  1142. Buffer: bytes.NewBuffer(buf),
  1143. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1144. ReadError: readErr,
  1145. WriteError: writeErr,
  1146. }
  1147. user := dataprovider.User{
  1148. BaseUser: sdk.BaseUser{
  1149. Username: "testuser",
  1150. },
  1151. }
  1152. fs := vfs.NewOsFs("", os.TempDir(), "", nil)
  1153. connection := &Connection{
  1154. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", user),
  1155. channel: &mockSSHChannel,
  1156. }
  1157. scpCommand := scpCommand{
  1158. sshCommand: sshCommand{
  1159. command: "scp",
  1160. connection: connection,
  1161. args: []string{"-r", "-t", "/tmp"},
  1162. },
  1163. }
  1164. file, err := os.Create(testfile)
  1165. assert.NoError(t, err)
  1166. baseTransfer := common.NewBaseTransfer(file, scpCommand.connection.BaseConnection, nil, file.Name(), file.Name(),
  1167. "/"+testfile, common.TransferDownload, 0, 0, 0, 0, true, fs, dataprovider.TransferQuota{})
  1168. transfer := newTransfer(baseTransfer, nil, nil, nil)
  1169. err = scpCommand.getUploadFileData(2, transfer)
  1170. assert.Error(t, err, "upload must fail, we send a fake write error message")
  1171. mockSSHChannel = MockChannel{
  1172. Buffer: bytes.NewBuffer(buf),
  1173. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1174. ReadError: readErr,
  1175. WriteError: nil,
  1176. }
  1177. scpCommand.connection.channel = &mockSSHChannel
  1178. file, err = os.Create(testfile)
  1179. assert.NoError(t, err)
  1180. transfer.File = file
  1181. transfer.isFinished = false
  1182. transfer.Connection.AddTransfer(transfer)
  1183. err = scpCommand.getUploadFileData(2, transfer)
  1184. assert.Error(t, err, "upload must fail, we send a fake read error message")
  1185. respBuffer := []byte("12")
  1186. respBuffer = append(respBuffer, 0x02)
  1187. mockSSHChannel = MockChannel{
  1188. Buffer: bytes.NewBuffer(respBuffer),
  1189. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1190. ReadError: nil,
  1191. WriteError: nil,
  1192. }
  1193. scpCommand.connection.channel = &mockSSHChannel
  1194. file, err = os.Create(testfile)
  1195. assert.NoError(t, err)
  1196. baseTransfer.File = file
  1197. transfer = newTransfer(baseTransfer, nil, nil, nil)
  1198. transfer.Connection.AddTransfer(transfer)
  1199. err = scpCommand.getUploadFileData(2, transfer)
  1200. assert.Error(t, err, "upload must fail, we have not enough data to read")
  1201. // the file is already closed so we have an error on trasfer closing
  1202. mockSSHChannel = MockChannel{
  1203. Buffer: bytes.NewBuffer(buf),
  1204. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1205. ReadError: nil,
  1206. WriteError: nil,
  1207. }
  1208. transfer.Connection.AddTransfer(transfer)
  1209. err = scpCommand.getUploadFileData(0, transfer)
  1210. if assert.Error(t, err) {
  1211. assert.EqualError(t, err, common.ErrTransferClosed.Error())
  1212. }
  1213. transfer.Connection.RemoveTransfer(transfer)
  1214. mockSSHChannel = MockChannel{
  1215. Buffer: bytes.NewBuffer(buf),
  1216. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1217. ReadError: nil,
  1218. WriteError: nil,
  1219. }
  1220. transfer.Connection.AddTransfer(transfer)
  1221. err = scpCommand.getUploadFileData(2, transfer)
  1222. assert.ErrorContains(t, err, os.ErrClosed.Error())
  1223. transfer.Connection.RemoveTransfer(transfer)
  1224. err = os.Remove(testfile)
  1225. assert.NoError(t, err)
  1226. assert.Equal(t, int32(0), common.Connections.GetTotalTransfers())
  1227. }
  1228. func TestUploadError(t *testing.T) {
  1229. common.Config.UploadMode = common.UploadModeAtomic
  1230. user := dataprovider.User{
  1231. BaseUser: sdk.BaseUser{
  1232. Username: "testuser",
  1233. },
  1234. }
  1235. fs := vfs.NewOsFs("", os.TempDir(), "", nil)
  1236. connection := &Connection{
  1237. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", user),
  1238. }
  1239. testfile := "testfile"
  1240. fileTempName := "temptestfile"
  1241. file, err := os.Create(fileTempName)
  1242. assert.NoError(t, err)
  1243. baseTransfer := common.NewBaseTransfer(file, connection.BaseConnection, nil, testfile, file.Name(),
  1244. testfile, common.TransferUpload, 0, 0, 0, 0, true, fs, dataprovider.TransferQuota{})
  1245. transfer := newTransfer(baseTransfer, nil, nil, nil)
  1246. errFake := errors.New("fake error")
  1247. transfer.TransferError(errFake)
  1248. err = transfer.Close()
  1249. if assert.Error(t, err) {
  1250. assert.EqualError(t, err, common.ErrGenericFailure.Error())
  1251. }
  1252. if assert.Error(t, transfer.ErrTransfer) {
  1253. assert.EqualError(t, transfer.ErrTransfer, errFake.Error())
  1254. }
  1255. assert.Equal(t, int64(0), transfer.BytesReceived.Load())
  1256. assert.NoFileExists(t, testfile)
  1257. assert.NoFileExists(t, fileTempName)
  1258. common.Config.UploadMode = common.UploadModeAtomicWithResume
  1259. }
  1260. func TestTransferFailingReader(t *testing.T) {
  1261. user := dataprovider.User{
  1262. BaseUser: sdk.BaseUser{
  1263. Username: "testuser",
  1264. HomeDir: os.TempDir(),
  1265. },
  1266. FsConfig: vfs.Filesystem{
  1267. Provider: sdk.CryptedFilesystemProvider,
  1268. CryptConfig: vfs.CryptFsConfig{
  1269. Passphrase: kms.NewPlainSecret("crypt secret"),
  1270. },
  1271. },
  1272. }
  1273. user.Permissions = make(map[string][]string)
  1274. user.Permissions["/"] = []string{dataprovider.PermAny}
  1275. fs := newMockOsFs(nil, nil, true, "", os.TempDir())
  1276. connection := &Connection{
  1277. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
  1278. }
  1279. request := sftp.NewRequest("Open", "afile.txt")
  1280. request.Flags = 27 // read,write,create,truncate
  1281. transfer, err := connection.handleFilewrite(request)
  1282. require.NoError(t, err)
  1283. buf := make([]byte, 32)
  1284. _, err = transfer.ReadAt(buf, 0)
  1285. assert.ErrorIs(t, err, sftp.ErrSSHFxOpUnsupported)
  1286. if c, ok := transfer.(io.Closer); ok {
  1287. err = c.Close()
  1288. assert.NoError(t, err)
  1289. }
  1290. fsPath := filepath.Join(os.TempDir(), "afile.txt")
  1291. r, _, err := pipeat.Pipe()
  1292. assert.NoError(t, err)
  1293. baseTransfer := common.NewBaseTransfer(nil, connection.BaseConnection, nil, fsPath, fsPath, filepath.Base(fsPath),
  1294. common.TransferUpload, 0, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
  1295. errRead := errors.New("read is not allowed")
  1296. tr := newTransfer(baseTransfer, nil, vfs.NewPipeReader(r), errRead)
  1297. _, err = tr.ReadAt(buf, 0)
  1298. assert.ErrorIs(t, err, sftp.ErrSSHFxFailure)
  1299. err = tr.Close()
  1300. assert.NoError(t, err)
  1301. tr = newTransfer(baseTransfer, nil, nil, errRead)
  1302. _, err = tr.ReadAt(buf, 0)
  1303. assert.ErrorIs(t, err, sftp.ErrSSHFxFailure)
  1304. err = tr.Close()
  1305. assert.NoError(t, err)
  1306. err = os.Remove(fsPath)
  1307. assert.NoError(t, err)
  1308. assert.Len(t, connection.GetTransfers(), 0)
  1309. }
  1310. func TestConfigsFromProvider(t *testing.T) {
  1311. err := dataprovider.UpdateConfigs(nil, "", "", "")
  1312. assert.NoError(t, err)
  1313. c := Configuration{}
  1314. err = c.loadFromProvider()
  1315. assert.NoError(t, err)
  1316. assert.Len(t, c.HostKeyAlgorithms, 0)
  1317. assert.Len(t, c.KexAlgorithms, 0)
  1318. assert.Len(t, c.Ciphers, 0)
  1319. assert.Len(t, c.MACs, 0)
  1320. assert.Len(t, c.PublicKeyAlgorithms, 0)
  1321. configs := dataprovider.Configs{
  1322. SFTPD: &dataprovider.SFTPDConfigs{
  1323. HostKeyAlgos: []string{ssh.KeyAlgoRSA},
  1324. KexAlgorithms: []string{ssh.InsecureKeyExchangeDHGEXSHA1},
  1325. Ciphers: []string{ssh.InsecureCipherAES128CBC},
  1326. MACs: []string{ssh.HMACSHA512ETM},
  1327. PublicKeyAlgos: []string{ssh.InsecureKeyAlgoDSA}, //nolint:staticcheck
  1328. },
  1329. }
  1330. err = dataprovider.UpdateConfigs(&configs, "", "", "")
  1331. assert.NoError(t, err)
  1332. err = c.loadFromProvider()
  1333. assert.NoError(t, err)
  1334. expectedHostKeyAlgos := append(preferredHostKeyAlgos, configs.SFTPD.HostKeyAlgos...)
  1335. expectedKEXs := append(preferredKexAlgos, configs.SFTPD.KexAlgorithms...)
  1336. expectedCiphers := append(preferredCiphers, configs.SFTPD.Ciphers...)
  1337. expectedMACs := append(preferredMACs, configs.SFTPD.MACs...)
  1338. expectedPublicKeyAlgos := append(preferredPublicKeyAlgos, configs.SFTPD.PublicKeyAlgos...)
  1339. assert.Equal(t, expectedHostKeyAlgos, c.HostKeyAlgorithms)
  1340. assert.Equal(t, expectedKEXs, c.KexAlgorithms)
  1341. assert.Equal(t, expectedCiphers, c.Ciphers)
  1342. assert.Equal(t, expectedMACs, c.MACs)
  1343. assert.Equal(t, expectedPublicKeyAlgos, c.PublicKeyAlgorithms)
  1344. err = dataprovider.UpdateConfigs(nil, "", "", "")
  1345. assert.NoError(t, err)
  1346. }
  1347. func TestSupportedSecurityOptions(t *testing.T) {
  1348. c := Configuration{
  1349. KexAlgorithms: supportedKexAlgos,
  1350. MACs: supportedMACs,
  1351. Ciphers: supportedCiphers,
  1352. }
  1353. var defaultKexs []string
  1354. for _, k := range supportedKexAlgos {
  1355. defaultKexs = append(defaultKexs, k)
  1356. if k == ssh.KeyExchangeCurve25519 {
  1357. defaultKexs = append(defaultKexs, keyExchangeCurve25519SHA256LibSSH)
  1358. }
  1359. }
  1360. serverConfig := &ssh.ServerConfig{}
  1361. err := c.configureSecurityOptions(serverConfig)
  1362. assert.NoError(t, err)
  1363. assert.Equal(t, supportedCiphers, serverConfig.Ciphers)
  1364. assert.Equal(t, supportedMACs, serverConfig.MACs)
  1365. assert.Equal(t, defaultKexs, serverConfig.KeyExchanges)
  1366. c.KexAlgorithms = append(c.KexAlgorithms, "not a kex")
  1367. err = c.configureSecurityOptions(serverConfig)
  1368. assert.Error(t, err)
  1369. c.KexAlgorithms = append(supportedKexAlgos, "diffie-hellman-group18-sha512")
  1370. c.MACs = []string{
  1371. " [email protected] ", " [email protected]",
  1372. "hmac-sha2-256", "hmac-sha2-512 ",
  1373. "hmac-sha1 ", " hmac-sha1-96",
  1374. }
  1375. err = c.configureSecurityOptions(serverConfig)
  1376. assert.NoError(t, err)
  1377. assert.Equal(t, supportedCiphers, serverConfig.Ciphers)
  1378. assert.Equal(t, supportedMACs, serverConfig.MACs)
  1379. assert.Equal(t, defaultKexs, serverConfig.KeyExchanges)
  1380. }
  1381. func TestLoadHostKeys(t *testing.T) {
  1382. serverConfig := &ssh.ServerConfig{}
  1383. c := Configuration{}
  1384. c.HostKeys = []string{".", "missing file"}
  1385. err := c.checkAndLoadHostKeys(configDir, serverConfig)
  1386. assert.Error(t, err)
  1387. testfile := filepath.Join(os.TempDir(), "invalidkey")
  1388. err = os.WriteFile(testfile, []byte("some bytes"), os.ModePerm)
  1389. assert.NoError(t, err)
  1390. c.HostKeys = []string{testfile}
  1391. err = c.checkAndLoadHostKeys(configDir, serverConfig)
  1392. assert.Error(t, err)
  1393. err = os.Remove(testfile)
  1394. assert.NoError(t, err)
  1395. keysDir := filepath.Join(os.TempDir(), "keys")
  1396. err = os.MkdirAll(keysDir, os.ModePerm)
  1397. assert.NoError(t, err)
  1398. rsaKeyName := filepath.Join(keysDir, defaultPrivateRSAKeyName)
  1399. ecdsaKeyName := filepath.Join(keysDir, defaultPrivateECDSAKeyName)
  1400. ed25519KeyName := filepath.Join(keysDir, defaultPrivateEd25519KeyName)
  1401. nonDefaultKeyName := filepath.Join(keysDir, "akey")
  1402. c.HostKeys = []string{nonDefaultKeyName, rsaKeyName, ecdsaKeyName, ed25519KeyName}
  1403. err = c.checkAndLoadHostKeys(configDir, serverConfig)
  1404. assert.Error(t, err)
  1405. c.HostKeyAlgorithms = []string{ssh.KeyAlgoRSASHA256}
  1406. c.HostKeys = []string{ecdsaKeyName}
  1407. err = c.checkAndLoadHostKeys(configDir, serverConfig)
  1408. assert.Error(t, err)
  1409. c.HostKeyAlgorithms = preferredHostKeyAlgos
  1410. err = c.checkAndLoadHostKeys(configDir, serverConfig)
  1411. assert.NoError(t, err)
  1412. assert.FileExists(t, rsaKeyName)
  1413. assert.FileExists(t, ecdsaKeyName)
  1414. assert.FileExists(t, ed25519KeyName)
  1415. assert.NoFileExists(t, nonDefaultKeyName)
  1416. err = os.Remove(rsaKeyName)
  1417. assert.NoError(t, err)
  1418. err = os.Remove(ecdsaKeyName)
  1419. assert.NoError(t, err)
  1420. err = os.Remove(ed25519KeyName)
  1421. assert.NoError(t, err)
  1422. if runtime.GOOS != osWindows {
  1423. err = os.Chmod(keysDir, 0551)
  1424. assert.NoError(t, err)
  1425. c.HostKeys = nil
  1426. err = c.checkAndLoadHostKeys(keysDir, serverConfig)
  1427. assert.Error(t, err)
  1428. c.HostKeys = []string{rsaKeyName, ecdsaKeyName}
  1429. err = c.checkAndLoadHostKeys(configDir, serverConfig)
  1430. assert.Error(t, err)
  1431. c.HostKeys = []string{ecdsaKeyName, rsaKeyName}
  1432. err = c.checkAndLoadHostKeys(configDir, serverConfig)
  1433. assert.Error(t, err)
  1434. c.HostKeys = []string{ed25519KeyName}
  1435. err = c.checkAndLoadHostKeys(configDir, serverConfig)
  1436. assert.Error(t, err)
  1437. err = os.Chmod(keysDir, 0755)
  1438. assert.NoError(t, err)
  1439. }
  1440. err = os.RemoveAll(keysDir)
  1441. assert.NoError(t, err)
  1442. }
  1443. func TestCertCheckerInitErrors(t *testing.T) {
  1444. c := Configuration{}
  1445. c.TrustedUserCAKeys = []string{".", "missing file"}
  1446. err := c.initializeCertChecker("")
  1447. assert.Error(t, err)
  1448. testfile := filepath.Join(os.TempDir(), "invalidkey")
  1449. err = os.WriteFile(testfile, []byte("some bytes"), os.ModePerm)
  1450. assert.NoError(t, err)
  1451. c.TrustedUserCAKeys = []string{testfile}
  1452. err = c.initializeCertChecker("")
  1453. assert.Error(t, err)
  1454. err = os.Remove(testfile)
  1455. assert.NoError(t, err)
  1456. }
  1457. func TestRecoverer(t *testing.T) {
  1458. c := Configuration{}
  1459. c.AcceptInboundConnection(nil, nil)
  1460. connID := "connectionID"
  1461. connection := &Connection{
  1462. BaseConnection: common.NewBaseConnection(connID, common.ProtocolSFTP, "", "", dataprovider.User{}),
  1463. }
  1464. c.handleSftpConnection(nil, connection)
  1465. sshCmd := sshCommand{
  1466. command: "cd",
  1467. connection: connection,
  1468. }
  1469. err := sshCmd.handle()
  1470. assert.EqualError(t, err, common.ErrGenericFailure.Error())
  1471. scpCmd := scpCommand{
  1472. sshCommand: sshCommand{
  1473. command: "scp",
  1474. connection: connection,
  1475. },
  1476. }
  1477. err = scpCmd.handle()
  1478. assert.EqualError(t, err, common.ErrGenericFailure.Error())
  1479. assert.Len(t, common.Connections.GetStats(""), 0)
  1480. assert.Equal(t, int32(0), common.Connections.GetTotalTransfers())
  1481. }
  1482. func TestListernerAcceptErrors(t *testing.T) {
  1483. errFake := errors.New("a fake error")
  1484. listener := newFakeListener(errFake)
  1485. c := Configuration{}
  1486. err := c.serve(listener, nil)
  1487. require.EqualError(t, err, errFake.Error())
  1488. err = listener.Close()
  1489. require.NoError(t, err)
  1490. errNetFake := &fakeNetError{error: errFake}
  1491. listener = newFakeListener(errNetFake)
  1492. err = c.serve(listener, nil)
  1493. require.EqualError(t, err, errFake.Error())
  1494. err = listener.Close()
  1495. require.NoError(t, err)
  1496. }
  1497. type fakeNetError struct {
  1498. error
  1499. count int
  1500. }
  1501. func (e *fakeNetError) Timeout() bool {
  1502. return false
  1503. }
  1504. func (e *fakeNetError) Temporary() bool {
  1505. e.count++
  1506. return e.count < 10
  1507. }
  1508. func (e *fakeNetError) Error() string {
  1509. return e.error.Error()
  1510. }
  1511. type fakeListener struct {
  1512. server net.Conn
  1513. client net.Conn
  1514. err error
  1515. }
  1516. func (l *fakeListener) Accept() (net.Conn, error) {
  1517. return l.client, l.err
  1518. }
  1519. func (l *fakeListener) Close() error {
  1520. errClient := l.client.Close()
  1521. errServer := l.server.Close()
  1522. if errServer != nil {
  1523. return errServer
  1524. }
  1525. return errClient
  1526. }
  1527. func (l *fakeListener) Addr() net.Addr {
  1528. return l.server.LocalAddr()
  1529. }
  1530. func newFakeListener(err error) net.Listener {
  1531. server, client := net.Pipe()
  1532. return &fakeListener{
  1533. server: server,
  1534. client: client,
  1535. err: err,
  1536. }
  1537. }
  1538. func TestLoadRevokedUserCertsFile(t *testing.T) {
  1539. r := revokedCertificates{
  1540. certs: map[string]bool{},
  1541. }
  1542. err := r.load()
  1543. assert.NoError(t, err)
  1544. r.filePath = filepath.Join(os.TempDir(), "sub", "testrevoked")
  1545. err = os.MkdirAll(filepath.Dir(r.filePath), os.ModePerm)
  1546. assert.NoError(t, err)
  1547. err = os.WriteFile(r.filePath, []byte(`no json`), 0644)
  1548. assert.NoError(t, err)
  1549. err = r.load()
  1550. assert.Error(t, err)
  1551. r.filePath = filepath.Dir(r.filePath)
  1552. err = r.load()
  1553. assert.Error(t, err)
  1554. err = os.RemoveAll(r.filePath)
  1555. assert.NoError(t, err)
  1556. }
  1557. func TestMaxUserSessions(t *testing.T) {
  1558. connection := &Connection{
  1559. BaseConnection: common.NewBaseConnection(xid.New().String(), common.ProtocolSFTP, "", "", dataprovider.User{
  1560. BaseUser: sdk.BaseUser{
  1561. Username: "user_max_sessions",
  1562. HomeDir: filepath.Clean(os.TempDir()),
  1563. MaxSessions: 1,
  1564. },
  1565. }),
  1566. }
  1567. err := common.Connections.Add(connection)
  1568. assert.NoError(t, err)
  1569. c := Configuration{}
  1570. c.handleSftpConnection(nil, connection)
  1571. buf := make([]byte, 65535)
  1572. stdErrBuf := make([]byte, 65535)
  1573. mockSSHChannel := MockChannel{
  1574. Buffer: bytes.NewBuffer(buf),
  1575. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1576. }
  1577. conn := &Connection{
  1578. BaseConnection: common.NewBaseConnection(xid.New().String(), common.ProtocolSFTP, "", "", dataprovider.User{
  1579. BaseUser: sdk.BaseUser{
  1580. Username: "user_max_sessions",
  1581. HomeDir: filepath.Clean(os.TempDir()),
  1582. MaxSessions: 1,
  1583. },
  1584. }),
  1585. channel: &mockSSHChannel,
  1586. }
  1587. sshCmd := sshCommand{
  1588. command: "cd",
  1589. connection: conn,
  1590. }
  1591. err = sshCmd.handle()
  1592. if assert.Error(t, err) {
  1593. assert.Contains(t, err.Error(), "too many open sessions")
  1594. }
  1595. scpCmd := scpCommand{
  1596. sshCommand: sshCommand{
  1597. command: "scp",
  1598. connection: conn,
  1599. },
  1600. }
  1601. err = scpCmd.handle()
  1602. if assert.Error(t, err) {
  1603. assert.Contains(t, err.Error(), "too many open sessions")
  1604. }
  1605. common.Connections.Remove(connection.GetID())
  1606. assert.Len(t, common.Connections.GetStats(""), 0)
  1607. assert.Equal(t, int32(0), common.Connections.GetTotalTransfers())
  1608. }
  1609. func TestCanReadSymlink(t *testing.T) {
  1610. connection := &Connection{
  1611. BaseConnection: common.NewBaseConnection(xid.New().String(), common.ProtocolSFTP, "", "", dataprovider.User{
  1612. BaseUser: sdk.BaseUser{
  1613. Username: "user_can_read_symlink",
  1614. HomeDir: filepath.Clean(os.TempDir()),
  1615. Permissions: map[string][]string{
  1616. "/": {dataprovider.PermAny},
  1617. "/sub": {dataprovider.PermUpload},
  1618. },
  1619. },
  1620. Filters: dataprovider.UserFilters{
  1621. BaseUserFilters: sdk.BaseUserFilters{
  1622. FilePatterns: []sdk.PatternsFilter{
  1623. {
  1624. Path: "/denied",
  1625. DeniedPatterns: []string{"*.txt"},
  1626. DenyPolicy: sdk.DenyPolicyHide,
  1627. },
  1628. },
  1629. },
  1630. },
  1631. }),
  1632. }
  1633. err := connection.canReadLink("/sub/link")
  1634. assert.ErrorIs(t, err, sftp.ErrSSHFxPermissionDenied)
  1635. err = connection.canReadLink("/denied/file.txt")
  1636. assert.ErrorIs(t, err, sftp.ErrSSHFxNoSuchFile)
  1637. }
  1638. func TestAuthenticationErrors(t *testing.T) {
  1639. loginMethod := dataprovider.SSHLoginMethodPassword
  1640. username := "test user"
  1641. err := newAuthenticationError(fmt.Errorf("cannot validate credentials: %w", util.NewRecordNotFoundError("not found")),
  1642. loginMethod, username)
  1643. assert.ErrorIs(t, err, sftpAuthError)
  1644. assert.ErrorIs(t, err, util.ErrNotFound)
  1645. var sftpAuthErr *authenticationError
  1646. if assert.ErrorAs(t, err, &sftpAuthErr) {
  1647. assert.Equal(t, loginMethod, sftpAuthErr.getLoginMethod())
  1648. assert.Equal(t, username, sftpAuthErr.getUsername())
  1649. }
  1650. err = newAuthenticationError(fmt.Errorf("cannot validate credentials: %w", fs.ErrPermission), loginMethod, username)
  1651. assert.ErrorIs(t, err, sftpAuthError)
  1652. assert.NotErrorIs(t, err, util.ErrNotFound)
  1653. err = newAuthenticationError(fmt.Errorf("cert has wrong type %d", ssh.HostCert), loginMethod, username)
  1654. assert.ErrorIs(t, err, sftpAuthError)
  1655. assert.NotErrorIs(t, err, util.ErrNotFound)
  1656. err = newAuthenticationError(errors.New("ssh: certificate signed by unrecognized authority"), loginMethod, username)
  1657. assert.ErrorIs(t, err, sftpAuthError)
  1658. assert.NotErrorIs(t, err, util.ErrNotFound)
  1659. err = newAuthenticationError(nil, loginMethod, username)
  1660. assert.ErrorIs(t, err, sftpAuthError)
  1661. assert.NotErrorIs(t, err, util.ErrNotFound)
  1662. }