internal_test.go 63 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197
  1. package sftpd
  2. import (
  3. "bytes"
  4. "errors"
  5. "fmt"
  6. "io"
  7. "net"
  8. "os"
  9. "path/filepath"
  10. "runtime"
  11. "testing"
  12. "time"
  13. "github.com/eikenb/pipeat"
  14. "github.com/pkg/sftp"
  15. "github.com/rs/xid"
  16. "github.com/sftpgo/sdk"
  17. "github.com/stretchr/testify/assert"
  18. "github.com/stretchr/testify/require"
  19. "golang.org/x/crypto/ssh"
  20. "github.com/drakkan/sftpgo/v2/common"
  21. "github.com/drakkan/sftpgo/v2/dataprovider"
  22. "github.com/drakkan/sftpgo/v2/kms"
  23. "github.com/drakkan/sftpgo/v2/util"
  24. "github.com/drakkan/sftpgo/v2/vfs"
  25. )
  26. const osWindows = "windows"
  27. type MockChannel struct {
  28. Buffer *bytes.Buffer
  29. StdErrBuffer *bytes.Buffer
  30. ReadError error
  31. WriteError error
  32. ShortWriteErr bool
  33. }
  34. func (c *MockChannel) Read(data []byte) (int, error) {
  35. if c.ReadError != nil {
  36. return 0, c.ReadError
  37. }
  38. return c.Buffer.Read(data)
  39. }
  40. func (c *MockChannel) Write(data []byte) (int, error) {
  41. if c.WriteError != nil {
  42. return 0, c.WriteError
  43. }
  44. if c.ShortWriteErr {
  45. return 0, nil
  46. }
  47. return c.Buffer.Write(data)
  48. }
  49. func (c *MockChannel) Close() error {
  50. return nil
  51. }
  52. func (c *MockChannel) CloseWrite() error {
  53. return nil
  54. }
  55. func (c *MockChannel) SendRequest(name string, wantReply bool, payload []byte) (bool, error) {
  56. return true, nil
  57. }
  58. func (c *MockChannel) Stderr() io.ReadWriter {
  59. return c.StdErrBuffer
  60. }
  61. // MockOsFs mockable OsFs
  62. type MockOsFs struct {
  63. vfs.Fs
  64. err error
  65. statErr error
  66. isAtomicUploadSupported bool
  67. }
  68. // Name returns the name for the Fs implementation
  69. func (fs MockOsFs) Name() string {
  70. return "mockOsFs"
  71. }
  72. // IsUploadResumeSupported returns true if resuming uploads is supported
  73. func (MockOsFs) IsUploadResumeSupported() bool {
  74. return false
  75. }
  76. // IsAtomicUploadSupported returns true if atomic upload is supported
  77. func (fs MockOsFs) IsAtomicUploadSupported() bool {
  78. return fs.isAtomicUploadSupported
  79. }
  80. // Stat returns a FileInfo describing the named file
  81. func (fs MockOsFs) Stat(name string) (os.FileInfo, error) {
  82. if fs.statErr != nil {
  83. return nil, fs.statErr
  84. }
  85. return os.Stat(name)
  86. }
  87. // Lstat returns a FileInfo describing the named file
  88. func (fs MockOsFs) Lstat(name string) (os.FileInfo, error) {
  89. if fs.statErr != nil {
  90. return nil, fs.statErr
  91. }
  92. return os.Lstat(name)
  93. }
  94. // Remove removes the named file or (empty) directory.
  95. func (fs MockOsFs) Remove(name string, isDir bool) error {
  96. if fs.err != nil {
  97. return fs.err
  98. }
  99. return os.Remove(name)
  100. }
  101. // Rename renames (moves) source to target
  102. func (fs MockOsFs) Rename(source, target string) error {
  103. if fs.err != nil {
  104. return fs.err
  105. }
  106. return os.Rename(source, target)
  107. }
  108. func newMockOsFs(err, statErr error, atomicUpload bool, connectionID, rootDir string) vfs.Fs {
  109. return &MockOsFs{
  110. Fs: vfs.NewOsFs(connectionID, rootDir, ""),
  111. err: err,
  112. statErr: statErr,
  113. isAtomicUploadSupported: atomicUpload,
  114. }
  115. }
  116. func TestRemoveNonexistentQuotaScan(t *testing.T) {
  117. assert.False(t, common.QuotaScans.RemoveUserQuotaScan("username"))
  118. }
  119. func TestGetOSOpenFlags(t *testing.T) {
  120. var flags sftp.FileOpenFlags
  121. flags.Write = true
  122. flags.Excl = true
  123. osFlags := getOSOpenFlags(flags)
  124. assert.NotEqual(t, 0, osFlags&os.O_WRONLY)
  125. assert.NotEqual(t, 0, osFlags&os.O_EXCL)
  126. flags.Append = true
  127. // append flag should be ignored to allow resume
  128. assert.NotEqual(t, 0, osFlags&os.O_WRONLY)
  129. assert.NotEqual(t, 0, osFlags&os.O_EXCL)
  130. }
  131. func TestUploadResumeInvalidOffset(t *testing.T) {
  132. testfile := "testfile" //nolint:goconst
  133. file, err := os.Create(testfile)
  134. assert.NoError(t, err)
  135. user := dataprovider.User{
  136. BaseUser: sdk.BaseUser{
  137. Username: "testuser",
  138. },
  139. }
  140. fs := vfs.NewOsFs("", os.TempDir(), "")
  141. conn := common.NewBaseConnection("", common.ProtocolSFTP, "", "", user)
  142. baseTransfer := common.NewBaseTransfer(file, conn, nil, file.Name(), file.Name(), testfile,
  143. common.TransferUpload, 10, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
  144. transfer := newTransfer(baseTransfer, nil, nil, nil)
  145. _, err = transfer.WriteAt([]byte("test"), 0)
  146. assert.Error(t, err, "upload with invalid offset must fail")
  147. if assert.Error(t, transfer.ErrTransfer) {
  148. assert.EqualError(t, err, transfer.ErrTransfer.Error())
  149. assert.Contains(t, transfer.ErrTransfer.Error(), "invalid write offset")
  150. }
  151. err = transfer.Close()
  152. if assert.Error(t, err) {
  153. assert.ErrorIs(t, err, sftp.ErrSSHFxFailure)
  154. assert.Contains(t, err.Error(), "invalid write offset")
  155. }
  156. err = os.Remove(testfile)
  157. assert.NoError(t, err)
  158. }
  159. func TestReadWriteErrors(t *testing.T) {
  160. testfile := "testfile"
  161. file, err := os.Create(testfile)
  162. assert.NoError(t, err)
  163. user := dataprovider.User{
  164. BaseUser: sdk.BaseUser{
  165. Username: "testuser",
  166. },
  167. }
  168. fs := vfs.NewOsFs("", os.TempDir(), "")
  169. conn := common.NewBaseConnection("", common.ProtocolSFTP, "", "", user)
  170. baseTransfer := common.NewBaseTransfer(file, conn, nil, file.Name(), file.Name(), testfile, common.TransferDownload,
  171. 0, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
  172. transfer := newTransfer(baseTransfer, nil, nil, nil)
  173. err = file.Close()
  174. assert.NoError(t, err)
  175. _, err = transfer.WriteAt([]byte("test"), 0)
  176. assert.Error(t, err, "writing to closed file must fail")
  177. buf := make([]byte, 32768)
  178. _, err = transfer.ReadAt(buf, 0)
  179. assert.Error(t, err, "reading from a closed file must fail")
  180. err = transfer.Close()
  181. assert.Error(t, err)
  182. r, _, err := pipeat.Pipe()
  183. assert.NoError(t, err)
  184. baseTransfer = common.NewBaseTransfer(nil, conn, nil, file.Name(), file.Name(), testfile, common.TransferDownload,
  185. 0, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
  186. transfer = newTransfer(baseTransfer, nil, r, nil)
  187. err = transfer.Close()
  188. assert.NoError(t, err)
  189. _, err = transfer.ReadAt(buf, 0)
  190. assert.Error(t, err, "reading from a closed pipe must fail")
  191. r, w, err := pipeat.Pipe()
  192. assert.NoError(t, err)
  193. pipeWriter := vfs.NewPipeWriter(w)
  194. baseTransfer = common.NewBaseTransfer(nil, conn, nil, file.Name(), file.Name(), testfile, common.TransferDownload,
  195. 0, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
  196. transfer = newTransfer(baseTransfer, pipeWriter, nil, nil)
  197. err = r.Close()
  198. assert.NoError(t, err)
  199. errFake := fmt.Errorf("fake upload error")
  200. go func() {
  201. time.Sleep(100 * time.Millisecond)
  202. pipeWriter.Done(errFake)
  203. }()
  204. err = transfer.closeIO()
  205. assert.EqualError(t, err, errFake.Error())
  206. _, err = transfer.WriteAt([]byte("test"), 0)
  207. assert.Error(t, err, "writing to closed pipe must fail")
  208. err = transfer.BaseTransfer.Close()
  209. assert.EqualError(t, err, errFake.Error())
  210. err = os.Remove(testfile)
  211. assert.NoError(t, err)
  212. assert.Len(t, conn.GetTransfers(), 0)
  213. }
  214. func TestUnsupportedListOP(t *testing.T) {
  215. conn := common.NewBaseConnection("", common.ProtocolSFTP, "", "", dataprovider.User{})
  216. sftpConn := Connection{
  217. BaseConnection: conn,
  218. }
  219. request := sftp.NewRequest("Unsupported", "")
  220. _, err := sftpConn.Filelist(request)
  221. assert.EqualError(t, err, sftp.ErrSSHFxOpUnsupported.Error())
  222. }
  223. func TestTransferCancelFn(t *testing.T) {
  224. testfile := "testfile"
  225. file, err := os.Create(testfile)
  226. assert.NoError(t, err)
  227. isCancelled := false
  228. cancelFn := func() {
  229. isCancelled = true
  230. }
  231. user := dataprovider.User{
  232. BaseUser: sdk.BaseUser{
  233. Username: "testuser",
  234. },
  235. }
  236. fs := vfs.NewOsFs("", os.TempDir(), "")
  237. conn := common.NewBaseConnection("", common.ProtocolSFTP, "", "", user)
  238. baseTransfer := common.NewBaseTransfer(file, conn, cancelFn, file.Name(), file.Name(), testfile, common.TransferDownload,
  239. 0, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
  240. transfer := newTransfer(baseTransfer, nil, nil, nil)
  241. errFake := errors.New("fake error, this will trigger cancelFn")
  242. transfer.TransferError(errFake)
  243. err = transfer.Close()
  244. if assert.Error(t, err) {
  245. assert.ErrorIs(t, err, sftp.ErrSSHFxFailure)
  246. assert.Contains(t, err.Error(), errFake.Error())
  247. }
  248. if assert.Error(t, transfer.ErrTransfer) {
  249. assert.EqualError(t, transfer.ErrTransfer, errFake.Error())
  250. }
  251. assert.True(t, isCancelled, "cancelFn not called!")
  252. err = os.Remove(testfile)
  253. assert.NoError(t, err)
  254. }
  255. func TestUploadFiles(t *testing.T) {
  256. common.Config.UploadMode = common.UploadModeAtomic
  257. fs := vfs.NewOsFs("123", os.TempDir(), "")
  258. u := dataprovider.User{}
  259. c := Connection{
  260. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", u),
  261. }
  262. var flags sftp.FileOpenFlags
  263. flags.Write = true
  264. flags.Trunc = true
  265. _, err := c.handleSFTPUploadToExistingFile(fs, flags, "missing_path", "other_missing_path", 0, "/missing_path", nil)
  266. assert.Error(t, err, "upload to existing file must fail if one or both paths are invalid")
  267. common.Config.UploadMode = common.UploadModeStandard
  268. _, err = c.handleSFTPUploadToExistingFile(fs, flags, "missing_path", "other_missing_path", 0, "/missing_path", nil)
  269. assert.Error(t, err, "upload to existing file must fail if one or both paths are invalid")
  270. missingFile := "missing/relative/file.txt"
  271. if runtime.GOOS == osWindows {
  272. missingFile = "missing\\relative\\file.txt"
  273. }
  274. _, err = c.handleSFTPUploadToNewFile(fs, flags, ".", missingFile, "/missing", nil)
  275. assert.Error(t, err, "upload new file in missing path must fail")
  276. fs = newMockOsFs(nil, nil, false, "123", os.TempDir())
  277. f, err := os.CreateTemp("", "temp")
  278. assert.NoError(t, err)
  279. err = f.Close()
  280. assert.NoError(t, err)
  281. tr, err := c.handleSFTPUploadToExistingFile(fs, flags, f.Name(), f.Name(), 123, f.Name(), nil)
  282. if assert.NoError(t, err) {
  283. transfer := tr.(*transfer)
  284. transfers := c.GetTransfers()
  285. if assert.Equal(t, 1, len(transfers)) {
  286. assert.Equal(t, transfers[0].ID, transfer.GetID())
  287. assert.Equal(t, int64(123), transfer.InitialSize)
  288. err = transfer.Close()
  289. assert.NoError(t, err)
  290. assert.Equal(t, 0, len(c.GetTransfers()))
  291. }
  292. }
  293. err = os.Remove(f.Name())
  294. assert.NoError(t, err)
  295. common.Config.UploadMode = common.UploadModeAtomicWithResume
  296. }
  297. func TestWithInvalidHome(t *testing.T) {
  298. u := dataprovider.User{}
  299. u.HomeDir = "home_rel_path" //nolint:goconst
  300. _, err := loginUser(&u, dataprovider.LoginMethodPassword, "", nil)
  301. assert.Error(t, err, "login a user with an invalid home_dir must fail")
  302. u.HomeDir = os.TempDir()
  303. fs, err := u.GetFilesystem("123")
  304. assert.NoError(t, err)
  305. c := Connection{
  306. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", u),
  307. }
  308. _, err = fs.ResolvePath("../upper_path")
  309. assert.Error(t, err, "tested path is not a home subdir")
  310. _, err = c.StatVFS(&sftp.Request{
  311. Method: "StatVFS",
  312. Filepath: "../unresolvable-path",
  313. })
  314. assert.Error(t, err)
  315. }
  316. func TestResolveWithRootDir(t *testing.T) {
  317. u := dataprovider.User{}
  318. if runtime.GOOS == osWindows {
  319. u.HomeDir = "C:\\"
  320. } else {
  321. u.HomeDir = "/"
  322. }
  323. fs, err := u.GetFilesystem("")
  324. assert.NoError(t, err)
  325. rel, err := filepath.Rel(u.HomeDir, os.TempDir())
  326. assert.NoError(t, err)
  327. p, err := fs.ResolvePath(rel)
  328. assert.NoError(t, err, "path %v", p)
  329. }
  330. func TestSFTPGetUsedQuota(t *testing.T) {
  331. u := dataprovider.User{}
  332. u.HomeDir = "home_rel_path"
  333. u.Username = "test_invalid_user"
  334. u.QuotaSize = 4096
  335. u.QuotaFiles = 1
  336. u.Permissions = make(map[string][]string)
  337. u.Permissions["/"] = []string{dataprovider.PermAny}
  338. connection := Connection{
  339. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", u),
  340. }
  341. quotaResult, _ := connection.HasSpace(false, false, "/")
  342. assert.False(t, quotaResult.HasSpace)
  343. }
  344. func TestSupportedSSHCommands(t *testing.T) {
  345. cmds := GetSupportedSSHCommands()
  346. assert.Equal(t, len(supportedSSHCommands), len(cmds))
  347. for _, c := range cmds {
  348. assert.True(t, util.IsStringInSlice(c, supportedSSHCommands))
  349. }
  350. }
  351. func TestSSHCommandPath(t *testing.T) {
  352. buf := make([]byte, 65535)
  353. stdErrBuf := make([]byte, 65535)
  354. mockSSHChannel := MockChannel{
  355. Buffer: bytes.NewBuffer(buf),
  356. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  357. ReadError: nil,
  358. }
  359. connection := &Connection{
  360. channel: &mockSSHChannel,
  361. BaseConnection: common.NewBaseConnection("", common.ProtocolSSH, "", "", dataprovider.User{}),
  362. }
  363. sshCommand := sshCommand{
  364. command: "test",
  365. connection: connection,
  366. args: []string{},
  367. }
  368. assert.Equal(t, "", sshCommand.getDestPath())
  369. sshCommand.args = []string{"-t", "/tmp/../path"}
  370. assert.Equal(t, "/path", sshCommand.getDestPath())
  371. sshCommand.args = []string{"-t", "/tmp/"}
  372. assert.Equal(t, "/tmp/", sshCommand.getDestPath())
  373. sshCommand.args = []string{"-t", "tmp/"}
  374. assert.Equal(t, "/tmp/", sshCommand.getDestPath())
  375. sshCommand.args = []string{"-t", "/tmp/../../../path"}
  376. assert.Equal(t, "/path", sshCommand.getDestPath())
  377. sshCommand.args = []string{"-t", ".."}
  378. assert.Equal(t, "/", sshCommand.getDestPath())
  379. sshCommand.args = []string{"-t", "."}
  380. assert.Equal(t, "/", sshCommand.getDestPath())
  381. sshCommand.args = []string{"-t", "//"}
  382. assert.Equal(t, "/", sshCommand.getDestPath())
  383. sshCommand.args = []string{"-t", "../.."}
  384. assert.Equal(t, "/", sshCommand.getDestPath())
  385. sshCommand.args = []string{"-t", "/.."}
  386. assert.Equal(t, "/", sshCommand.getDestPath())
  387. sshCommand.args = []string{"-f", "/a space.txt"}
  388. assert.Equal(t, "/a space.txt", sshCommand.getDestPath())
  389. }
  390. func TestSSHParseCommandPayload(t *testing.T) {
  391. cmd := "command -a -f /ab\\ à/some\\ spaces\\ \\ \\(\\).txt"
  392. name, args, _ := parseCommandPayload(cmd)
  393. assert.Equal(t, "command", name)
  394. assert.Equal(t, 3, len(args))
  395. assert.Equal(t, "/ab à/some spaces ().txt", args[2])
  396. _, _, err := parseCommandPayload("")
  397. assert.Error(t, err, "parsing invalid command must fail")
  398. }
  399. func TestSSHCommandErrors(t *testing.T) {
  400. buf := make([]byte, 65535)
  401. stdErrBuf := make([]byte, 65535)
  402. readErr := fmt.Errorf("test read error")
  403. mockSSHChannel := MockChannel{
  404. Buffer: bytes.NewBuffer(buf),
  405. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  406. ReadError: readErr,
  407. }
  408. server, client := net.Pipe()
  409. defer func() {
  410. err := server.Close()
  411. assert.NoError(t, err)
  412. }()
  413. defer func() {
  414. err := client.Close()
  415. assert.NoError(t, err)
  416. }()
  417. user := dataprovider.User{}
  418. user.Permissions = map[string][]string{
  419. "/": {dataprovider.PermAny},
  420. }
  421. connection := Connection{
  422. BaseConnection: common.NewBaseConnection("", common.ProtocolSSH, "", "", user),
  423. channel: &mockSSHChannel,
  424. }
  425. cmd := sshCommand{
  426. command: "md5sum",
  427. connection: &connection,
  428. args: []string{},
  429. }
  430. err := cmd.handle()
  431. assert.Error(t, err, "ssh command must fail, we are sending a fake error")
  432. cmd = sshCommand{
  433. command: "md5sum",
  434. connection: &connection,
  435. args: []string{"/../../test_file_ftp.dat"},
  436. }
  437. err = cmd.handle()
  438. assert.Error(t, err, "ssh command must fail, we are requesting an invalid path")
  439. cmd = sshCommand{
  440. command: "git-receive-pack",
  441. connection: &connection,
  442. args: []string{"/../../testrepo"},
  443. }
  444. err = cmd.handle()
  445. assert.Error(t, err, "ssh command must fail, we are requesting an invalid path")
  446. user = dataprovider.User{}
  447. user.Permissions = map[string][]string{
  448. "/": {dataprovider.PermAny},
  449. }
  450. user.HomeDir = filepath.Clean(os.TempDir())
  451. user.QuotaFiles = 1
  452. user.UsedQuotaFiles = 2
  453. cmd.connection.User = user
  454. fs, err := cmd.connection.User.GetFilesystem("123")
  455. assert.NoError(t, err)
  456. err = cmd.handle()
  457. assert.EqualError(t, err, common.ErrQuotaExceeded.Error())
  458. cmd.connection.User.QuotaFiles = 0
  459. cmd.connection.User.UsedQuotaFiles = 0
  460. cmd.connection.User.Permissions = make(map[string][]string)
  461. cmd.connection.User.Permissions["/"] = []string{dataprovider.PermListItems}
  462. err = cmd.handle()
  463. assert.EqualError(t, err, common.ErrPermissionDenied.Error())
  464. cmd.connection.User.Permissions["/"] = []string{dataprovider.PermAny}
  465. cmd.command = "invalid_command"
  466. command, err := cmd.getSystemCommand()
  467. assert.NoError(t, err)
  468. err = cmd.executeSystemCommand(command)
  469. assert.Error(t, err, "invalid command must fail")
  470. command, err = cmd.getSystemCommand()
  471. assert.NoError(t, err)
  472. _, err = command.cmd.StderrPipe()
  473. assert.NoError(t, err)
  474. err = cmd.executeSystemCommand(command)
  475. assert.Error(t, err, "command must fail, pipe was already assigned")
  476. err = cmd.executeSystemCommand(command)
  477. assert.Error(t, err, "command must fail, pipe was already assigned")
  478. command, err = cmd.getSystemCommand()
  479. assert.NoError(t, err)
  480. _, err = command.cmd.StdoutPipe()
  481. assert.NoError(t, err)
  482. err = cmd.executeSystemCommand(command)
  483. assert.Error(t, err, "command must fail, pipe was already assigned")
  484. cmd = sshCommand{
  485. command: "sftpgo-remove",
  486. connection: &connection,
  487. args: []string{"/../../src"},
  488. }
  489. err = cmd.handle()
  490. assert.Error(t, err, "ssh command must fail, we are requesting an invalid path")
  491. cmd = sshCommand{
  492. command: "sftpgo-copy",
  493. connection: &connection,
  494. args: []string{"/../../test_src", "."},
  495. }
  496. err = cmd.handle()
  497. assert.Error(t, err, "ssh command must fail, we are requesting an invalid path")
  498. cmd.connection.User.HomeDir = filepath.Clean(os.TempDir())
  499. cmd = sshCommand{
  500. command: "sftpgo-copy",
  501. connection: &connection,
  502. args: []string{"src", "dst"},
  503. }
  504. cmd.connection.User.Permissions = make(map[string][]string)
  505. cmd.connection.User.Permissions["/"] = []string{dataprovider.PermAny}
  506. if runtime.GOOS != osWindows {
  507. aDir := filepath.Join(os.TempDir(), "adir")
  508. err = os.MkdirAll(aDir, os.ModePerm)
  509. assert.NoError(t, err)
  510. tmpFile := filepath.Join(aDir, "testcopy")
  511. err = os.WriteFile(tmpFile, []byte("aaa"), os.ModePerm)
  512. assert.NoError(t, err)
  513. err = os.Chmod(aDir, 0001)
  514. assert.NoError(t, err)
  515. err = cmd.checkCopyDestination(fs, tmpFile)
  516. assert.Error(t, err)
  517. err = os.Chmod(aDir, os.ModePerm)
  518. assert.NoError(t, err)
  519. err = os.Remove(tmpFile)
  520. assert.NoError(t, err)
  521. }
  522. }
  523. func TestCommandsWithExtensionsFilter(t *testing.T) {
  524. buf := make([]byte, 65535)
  525. stdErrBuf := make([]byte, 65535)
  526. mockSSHChannel := MockChannel{
  527. Buffer: bytes.NewBuffer(buf),
  528. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  529. }
  530. server, client := net.Pipe()
  531. defer server.Close()
  532. defer client.Close()
  533. user := dataprovider.User{
  534. BaseUser: sdk.BaseUser{
  535. Username: "test",
  536. HomeDir: os.TempDir(),
  537. Status: 1,
  538. },
  539. }
  540. user.Filters.FilePatterns = []sdk.PatternsFilter{
  541. {
  542. Path: "/subdir",
  543. AllowedPatterns: []string{".jpg"},
  544. DeniedPatterns: []string{},
  545. },
  546. }
  547. connection := &Connection{
  548. BaseConnection: common.NewBaseConnection("", common.ProtocolSSH, "", "", user),
  549. channel: &mockSSHChannel,
  550. }
  551. cmd := sshCommand{
  552. command: "md5sum",
  553. connection: connection,
  554. args: []string{"subdir/test.png"},
  555. }
  556. err := cmd.handleHashCommands()
  557. assert.EqualError(t, err, common.ErrPermissionDenied.Error())
  558. cmd = sshCommand{
  559. command: "rsync",
  560. connection: connection,
  561. args: []string{"--server", "-vlogDtprze.iLsfxC", ".", "/"},
  562. }
  563. _, err = cmd.getSystemCommand()
  564. assert.EqualError(t, err, errUnsupportedConfig.Error())
  565. cmd = sshCommand{
  566. command: "git-receive-pack",
  567. connection: connection,
  568. args: []string{"/subdir"},
  569. }
  570. _, err = cmd.getSystemCommand()
  571. assert.EqualError(t, err, errUnsupportedConfig.Error())
  572. cmd = sshCommand{
  573. command: "git-receive-pack",
  574. connection: connection,
  575. args: []string{"/subdir/dir"},
  576. }
  577. _, err = cmd.getSystemCommand()
  578. assert.EqualError(t, err, errUnsupportedConfig.Error())
  579. cmd = sshCommand{
  580. command: "git-receive-pack",
  581. connection: connection,
  582. args: []string{"/adir/subdir"},
  583. }
  584. _, err = cmd.getSystemCommand()
  585. assert.NoError(t, err)
  586. }
  587. func TestSSHCommandsRemoteFs(t *testing.T) {
  588. buf := make([]byte, 65535)
  589. stdErrBuf := make([]byte, 65535)
  590. mockSSHChannel := MockChannel{
  591. Buffer: bytes.NewBuffer(buf),
  592. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  593. }
  594. user := dataprovider.User{}
  595. user.FsConfig = vfs.Filesystem{
  596. Provider: sdk.S3FilesystemProvider,
  597. S3Config: vfs.S3FsConfig{
  598. BaseS3FsConfig: sdk.BaseS3FsConfig{
  599. Bucket: "s3bucket",
  600. Endpoint: "endpoint",
  601. Region: "eu-west-1",
  602. },
  603. },
  604. }
  605. connection := &Connection{
  606. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
  607. channel: &mockSSHChannel,
  608. }
  609. cmd := sshCommand{
  610. command: "md5sum",
  611. connection: connection,
  612. args: []string{},
  613. }
  614. command, err := cmd.getSystemCommand()
  615. assert.NoError(t, err)
  616. err = cmd.executeSystemCommand(command)
  617. assert.Error(t, err, "command must fail for a non local filesystem")
  618. cmd = sshCommand{
  619. command: "sftpgo-copy",
  620. connection: connection,
  621. args: []string{},
  622. }
  623. err = cmd.handleSFTPGoCopy()
  624. assert.Error(t, err)
  625. cmd = sshCommand{
  626. command: "sftpgo-remove",
  627. connection: connection,
  628. args: []string{},
  629. }
  630. err = cmd.handleSFTPGoRemove()
  631. assert.Error(t, err)
  632. // the user has no permissions
  633. assert.False(t, cmd.hasCopyPermissions("", "", nil))
  634. }
  635. func TestSSHCmdGetFsErrors(t *testing.T) {
  636. buf := make([]byte, 65535)
  637. stdErrBuf := make([]byte, 65535)
  638. mockSSHChannel := MockChannel{
  639. Buffer: bytes.NewBuffer(buf),
  640. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  641. }
  642. user := dataprovider.User{
  643. BaseUser: sdk.BaseUser{
  644. HomeDir: "relative path",
  645. },
  646. }
  647. user.Permissions = map[string][]string{}
  648. user.Permissions["/"] = []string{dataprovider.PermAny}
  649. connection := &Connection{
  650. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
  651. channel: &mockSSHChannel,
  652. }
  653. cmd := sshCommand{
  654. command: "sftpgo-remove",
  655. connection: connection,
  656. args: []string{"path"},
  657. }
  658. err := cmd.handleSFTPGoRemove()
  659. assert.Error(t, err)
  660. cmd = sshCommand{
  661. command: "sftpgo-copy",
  662. connection: connection,
  663. args: []string{"path1", "path2"},
  664. }
  665. _, _, _, _, _, _, err = cmd.getFsAndCopyPaths() //nolint:dogsled
  666. assert.Error(t, err)
  667. user = dataprovider.User{}
  668. user.HomeDir = filepath.Join(os.TempDir(), "home")
  669. user.VirtualFolders = append(connection.User.VirtualFolders, vfs.VirtualFolder{
  670. BaseVirtualFolder: vfs.BaseVirtualFolder{
  671. MappedPath: "relative",
  672. },
  673. VirtualPath: "/vpath",
  674. })
  675. connection.User = user
  676. err = os.MkdirAll(user.GetHomeDir(), os.ModePerm)
  677. assert.NoError(t, err)
  678. cmd = sshCommand{
  679. command: "sftpgo-copy",
  680. connection: connection,
  681. args: []string{"path1", "/vpath/path2"},
  682. }
  683. _, _, _, _, _, _, err = cmd.getFsAndCopyPaths() //nolint:dogsled
  684. assert.Error(t, err)
  685. err = os.Remove(user.GetHomeDir())
  686. assert.NoError(t, err)
  687. }
  688. func TestGitVirtualFolders(t *testing.T) {
  689. permissions := make(map[string][]string)
  690. permissions["/"] = []string{dataprovider.PermAny}
  691. user := dataprovider.User{
  692. BaseUser: sdk.BaseUser{
  693. Permissions: permissions,
  694. HomeDir: os.TempDir(),
  695. },
  696. }
  697. conn := &Connection{
  698. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
  699. }
  700. cmd := sshCommand{
  701. command: "git-receive-pack",
  702. connection: conn,
  703. args: []string{"/vdir"},
  704. }
  705. cmd.connection.User.VirtualFolders = append(cmd.connection.User.VirtualFolders, vfs.VirtualFolder{
  706. BaseVirtualFolder: vfs.BaseVirtualFolder{
  707. MappedPath: os.TempDir(),
  708. },
  709. VirtualPath: "/vdir",
  710. })
  711. _, err := cmd.getSystemCommand()
  712. assert.NoError(t, err)
  713. cmd.args = []string{"/"}
  714. _, err = cmd.getSystemCommand()
  715. assert.EqualError(t, err, errUnsupportedConfig.Error())
  716. cmd.args = []string{"/vdir1"}
  717. _, err = cmd.getSystemCommand()
  718. assert.NoError(t, err)
  719. cmd.connection.User.VirtualFolders = nil
  720. cmd.connection.User.VirtualFolders = append(cmd.connection.User.VirtualFolders, vfs.VirtualFolder{
  721. BaseVirtualFolder: vfs.BaseVirtualFolder{
  722. MappedPath: os.TempDir(),
  723. },
  724. VirtualPath: "/vdir",
  725. })
  726. cmd.args = []string{"/vdir/subdir"}
  727. _, err = cmd.getSystemCommand()
  728. assert.NoError(t, err)
  729. cmd.args = []string{"/adir/subdir"}
  730. _, err = cmd.getSystemCommand()
  731. assert.NoError(t, err)
  732. }
  733. func TestRsyncOptions(t *testing.T) {
  734. permissions := make(map[string][]string)
  735. permissions["/"] = []string{dataprovider.PermAny}
  736. user := dataprovider.User{
  737. BaseUser: sdk.BaseUser{
  738. Permissions: permissions,
  739. HomeDir: os.TempDir(),
  740. },
  741. }
  742. conn := &Connection{
  743. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
  744. }
  745. sshCmd := sshCommand{
  746. command: "rsync",
  747. connection: conn,
  748. args: []string{"--server", "-vlogDtprze.iLsfxC", ".", "/"},
  749. }
  750. cmd, err := sshCmd.getSystemCommand()
  751. assert.NoError(t, err)
  752. assert.True(t, util.IsStringInSlice("--safe-links", cmd.cmd.Args),
  753. "--safe-links must be added if the user has the create symlinks permission")
  754. permissions["/"] = []string{dataprovider.PermDownload, dataprovider.PermUpload, dataprovider.PermCreateDirs,
  755. dataprovider.PermListItems, dataprovider.PermOverwrite, dataprovider.PermDelete, dataprovider.PermRename}
  756. user.Permissions = permissions
  757. conn = &Connection{
  758. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
  759. }
  760. sshCmd = sshCommand{
  761. command: "rsync",
  762. connection: conn,
  763. args: []string{"--server", "-vlogDtprze.iLsfxC", ".", "/"},
  764. }
  765. cmd, err = sshCmd.getSystemCommand()
  766. assert.NoError(t, err)
  767. assert.True(t, util.IsStringInSlice("--munge-links", cmd.cmd.Args),
  768. "--munge-links must be added if the user has the create symlinks permission")
  769. sshCmd.connection.User.VirtualFolders = append(sshCmd.connection.User.VirtualFolders, vfs.VirtualFolder{
  770. BaseVirtualFolder: vfs.BaseVirtualFolder{
  771. MappedPath: os.TempDir(),
  772. },
  773. VirtualPath: "/vdir",
  774. })
  775. _, err = sshCmd.getSystemCommand()
  776. assert.EqualError(t, err, errUnsupportedConfig.Error())
  777. }
  778. func TestSystemCommandSizeForPath(t *testing.T) {
  779. permissions := make(map[string][]string)
  780. permissions["/"] = []string{dataprovider.PermAny}
  781. user := dataprovider.User{
  782. BaseUser: sdk.BaseUser{
  783. Permissions: permissions,
  784. HomeDir: os.TempDir(),
  785. },
  786. }
  787. fs, err := user.GetFilesystem("123")
  788. assert.NoError(t, err)
  789. conn := &Connection{
  790. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
  791. }
  792. sshCmd := sshCommand{
  793. command: "rsync",
  794. connection: conn,
  795. args: []string{"--server", "-vlogDtprze.iLsfxC", ".", "/"},
  796. }
  797. _, _, err = sshCmd.getSizeForPath(fs, "missing path")
  798. assert.NoError(t, err)
  799. testDir := filepath.Join(os.TempDir(), "dir")
  800. err = os.MkdirAll(testDir, os.ModePerm)
  801. assert.NoError(t, err)
  802. testFile := filepath.Join(testDir, "testfile")
  803. err = os.WriteFile(testFile, []byte("test content"), os.ModePerm)
  804. assert.NoError(t, err)
  805. err = os.Symlink(testFile, testFile+".link")
  806. assert.NoError(t, err)
  807. numFiles, size, err := sshCmd.getSizeForPath(fs, testFile+".link")
  808. assert.NoError(t, err)
  809. assert.Equal(t, 0, numFiles)
  810. assert.Equal(t, int64(0), size)
  811. numFiles, size, err = sshCmd.getSizeForPath(fs, testFile)
  812. assert.NoError(t, err)
  813. assert.Equal(t, 1, numFiles)
  814. assert.Equal(t, int64(12), size)
  815. if runtime.GOOS != osWindows {
  816. err = os.Chmod(testDir, 0001)
  817. assert.NoError(t, err)
  818. _, _, err = sshCmd.getSizeForPath(fs, testFile)
  819. assert.Error(t, err)
  820. err = os.Chmod(testDir, os.ModePerm)
  821. assert.NoError(t, err)
  822. }
  823. err = os.RemoveAll(testDir)
  824. assert.NoError(t, err)
  825. }
  826. func TestSystemCommandErrors(t *testing.T) {
  827. buf := make([]byte, 65535)
  828. stdErrBuf := make([]byte, 65535)
  829. readErr := fmt.Errorf("test read error")
  830. writeErr := fmt.Errorf("test write error")
  831. mockSSHChannel := MockChannel{
  832. Buffer: bytes.NewBuffer(buf),
  833. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  834. ReadError: nil,
  835. WriteError: writeErr,
  836. }
  837. permissions := make(map[string][]string)
  838. permissions["/"] = []string{dataprovider.PermAny}
  839. homeDir := filepath.Join(os.TempDir(), "adir")
  840. err := os.MkdirAll(homeDir, os.ModePerm)
  841. assert.NoError(t, err)
  842. err = os.WriteFile(filepath.Join(homeDir, "afile"), []byte("content"), os.ModePerm)
  843. assert.NoError(t, err)
  844. user := dataprovider.User{
  845. BaseUser: sdk.BaseUser{
  846. Permissions: permissions,
  847. HomeDir: homeDir,
  848. },
  849. }
  850. fs, err := user.GetFilesystem("123")
  851. assert.NoError(t, err)
  852. connection := &Connection{
  853. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
  854. channel: &mockSSHChannel,
  855. }
  856. var sshCmd sshCommand
  857. if runtime.GOOS == osWindows {
  858. sshCmd = sshCommand{
  859. command: "dir",
  860. connection: connection,
  861. args: []string{"/"},
  862. }
  863. } else {
  864. sshCmd = sshCommand{
  865. command: "ls",
  866. connection: connection,
  867. args: []string{"/"},
  868. }
  869. }
  870. systemCmd, err := sshCmd.getSystemCommand()
  871. assert.NoError(t, err)
  872. systemCmd.cmd.Dir = os.TempDir()
  873. // FIXME: the command completes but the fake client is unable to read the response
  874. // no error is reported in this case. We can see that the expected code is executed
  875. // reading the test coverage
  876. sshCmd.executeSystemCommand(systemCmd) //nolint:errcheck
  877. mockSSHChannel = MockChannel{
  878. Buffer: bytes.NewBuffer(buf),
  879. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  880. ReadError: readErr,
  881. WriteError: nil,
  882. }
  883. sshCmd.connection.channel = &mockSSHChannel
  884. baseTransfer := common.NewBaseTransfer(nil, sshCmd.connection.BaseConnection, nil, "", "", "",
  885. common.TransferUpload, 0, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
  886. transfer := newTransfer(baseTransfer, nil, nil, nil)
  887. destBuff := make([]byte, 65535)
  888. dst := bytes.NewBuffer(destBuff)
  889. _, err = transfer.copyFromReaderToWriter(dst, sshCmd.connection.channel)
  890. assert.EqualError(t, err, readErr.Error())
  891. mockSSHChannel = MockChannel{
  892. Buffer: bytes.NewBuffer(buf),
  893. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  894. ReadError: nil,
  895. WriteError: nil,
  896. }
  897. sshCmd.connection.channel = &mockSSHChannel
  898. transfer.MaxWriteSize = 1
  899. _, err = transfer.copyFromReaderToWriter(dst, sshCmd.connection.channel)
  900. assert.True(t, transfer.Connection.IsQuotaExceededError(err))
  901. mockSSHChannel = MockChannel{
  902. Buffer: bytes.NewBuffer(buf),
  903. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  904. ReadError: nil,
  905. WriteError: nil,
  906. ShortWriteErr: true,
  907. }
  908. sshCmd.connection.channel = &mockSSHChannel
  909. _, err = transfer.copyFromReaderToWriter(sshCmd.connection.channel, dst)
  910. assert.EqualError(t, err, io.ErrShortWrite.Error())
  911. transfer.MaxWriteSize = -1
  912. _, err = transfer.copyFromReaderToWriter(sshCmd.connection.channel, dst)
  913. assert.True(t, transfer.Connection.IsQuotaExceededError(err))
  914. baseTransfer = common.NewBaseTransfer(nil, sshCmd.connection.BaseConnection, nil, "", "", "",
  915. common.TransferDownload, 0, 0, 0, 0, false, fs, dataprovider.TransferQuota{
  916. AllowedDLSize: 1,
  917. })
  918. transfer = newTransfer(baseTransfer, nil, nil, nil)
  919. mockSSHChannel = MockChannel{
  920. Buffer: bytes.NewBuffer(buf),
  921. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  922. ReadError: nil,
  923. WriteError: nil,
  924. }
  925. sshCmd.connection.channel = &mockSSHChannel
  926. _, err = transfer.copyFromReaderToWriter(dst, sshCmd.connection.channel)
  927. if assert.Error(t, err) {
  928. assert.Contains(t, err.Error(), common.ErrReadQuotaExceeded.Error())
  929. }
  930. err = os.RemoveAll(homeDir)
  931. assert.NoError(t, err)
  932. }
  933. func TestCommandGetFsError(t *testing.T) {
  934. user := dataprovider.User{
  935. FsConfig: vfs.Filesystem{
  936. Provider: sdk.CryptedFilesystemProvider,
  937. },
  938. }
  939. conn := &Connection{
  940. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
  941. }
  942. sshCmd := sshCommand{
  943. command: "rsync",
  944. connection: conn,
  945. args: []string{"--server", "-vlogDtprze.iLsfxC", ".", "/"},
  946. }
  947. _, err := sshCmd.getSystemCommand()
  948. assert.Error(t, err)
  949. buf := make([]byte, 65535)
  950. stdErrBuf := make([]byte, 65535)
  951. mockSSHChannel := MockChannel{
  952. Buffer: bytes.NewBuffer(buf),
  953. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  954. ReadError: nil,
  955. }
  956. conn = &Connection{
  957. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", user),
  958. channel: &mockSSHChannel,
  959. }
  960. scpCommand := scpCommand{
  961. sshCommand: sshCommand{
  962. command: "scp",
  963. connection: conn,
  964. args: []string{"-t", "/tmp"},
  965. },
  966. }
  967. err = scpCommand.handleRecursiveUpload()
  968. assert.Error(t, err)
  969. err = scpCommand.handleDownload("")
  970. assert.Error(t, err)
  971. }
  972. func TestGetConnectionInfo(t *testing.T) {
  973. c := common.ConnectionStatus{
  974. Username: "test_user",
  975. ConnectionID: "123",
  976. ClientVersion: "client",
  977. RemoteAddress: "127.0.0.1:1234",
  978. Protocol: common.ProtocolSSH,
  979. Command: "sha1sum /test_file_ftp.dat",
  980. }
  981. info := c.GetConnectionInfo()
  982. assert.Contains(t, info, "sha1sum /test_file_ftp.dat")
  983. }
  984. func TestSCPFileMode(t *testing.T) {
  985. mode := getFileModeAsString(0, true)
  986. assert.Equal(t, "0755", mode)
  987. mode = getFileModeAsString(0700, true)
  988. assert.Equal(t, "0700", mode)
  989. mode = getFileModeAsString(0750, true)
  990. assert.Equal(t, "0750", mode)
  991. mode = getFileModeAsString(0777, true)
  992. assert.Equal(t, "0777", mode)
  993. mode = getFileModeAsString(0640, false)
  994. assert.Equal(t, "0640", mode)
  995. mode = getFileModeAsString(0600, false)
  996. assert.Equal(t, "0600", mode)
  997. mode = getFileModeAsString(0, false)
  998. assert.Equal(t, "0644", mode)
  999. fileMode := uint32(0777)
  1000. fileMode = fileMode | uint32(os.ModeSetgid)
  1001. fileMode = fileMode | uint32(os.ModeSetuid)
  1002. fileMode = fileMode | uint32(os.ModeSticky)
  1003. mode = getFileModeAsString(os.FileMode(fileMode), false)
  1004. assert.Equal(t, "7777", mode)
  1005. fileMode = uint32(0644)
  1006. fileMode = fileMode | uint32(os.ModeSetgid)
  1007. mode = getFileModeAsString(os.FileMode(fileMode), false)
  1008. assert.Equal(t, "4644", mode)
  1009. fileMode = uint32(0600)
  1010. fileMode = fileMode | uint32(os.ModeSetuid)
  1011. mode = getFileModeAsString(os.FileMode(fileMode), false)
  1012. assert.Equal(t, "2600", mode)
  1013. fileMode = uint32(0044)
  1014. fileMode = fileMode | uint32(os.ModeSticky)
  1015. mode = getFileModeAsString(os.FileMode(fileMode), false)
  1016. assert.Equal(t, "1044", mode)
  1017. }
  1018. func TestSCPUploadError(t *testing.T) {
  1019. buf := make([]byte, 65535)
  1020. stdErrBuf := make([]byte, 65535)
  1021. writeErr := fmt.Errorf("test write error")
  1022. mockSSHChannel := MockChannel{
  1023. Buffer: bytes.NewBuffer(buf),
  1024. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1025. ReadError: nil,
  1026. WriteError: writeErr,
  1027. }
  1028. user := dataprovider.User{
  1029. BaseUser: sdk.BaseUser{
  1030. HomeDir: filepath.Join(os.TempDir()),
  1031. Permissions: make(map[string][]string),
  1032. },
  1033. }
  1034. user.Permissions["/"] = []string{dataprovider.PermAny}
  1035. connection := &Connection{
  1036. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
  1037. channel: &mockSSHChannel,
  1038. }
  1039. scpCommand := scpCommand{
  1040. sshCommand: sshCommand{
  1041. command: "scp",
  1042. connection: connection,
  1043. args: []string{"-t", "/"},
  1044. },
  1045. }
  1046. err := scpCommand.handle()
  1047. assert.EqualError(t, err, writeErr.Error())
  1048. mockSSHChannel = MockChannel{
  1049. Buffer: bytes.NewBuffer([]byte("D0755 0 testdir\n")),
  1050. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1051. ReadError: nil,
  1052. WriteError: writeErr,
  1053. }
  1054. err = scpCommand.handleRecursiveUpload()
  1055. assert.EqualError(t, err, writeErr.Error())
  1056. mockSSHChannel = MockChannel{
  1057. Buffer: bytes.NewBuffer([]byte("D0755 a testdir\n")),
  1058. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1059. ReadError: nil,
  1060. WriteError: nil,
  1061. }
  1062. err = scpCommand.handleRecursiveUpload()
  1063. assert.Error(t, err)
  1064. }
  1065. func TestSCPInvalidEndDir(t *testing.T) {
  1066. stdErrBuf := make([]byte, 65535)
  1067. mockSSHChannel := MockChannel{
  1068. Buffer: bytes.NewBuffer([]byte("E\n")),
  1069. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1070. }
  1071. connection := &Connection{
  1072. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", dataprovider.User{
  1073. BaseUser: sdk.BaseUser{
  1074. HomeDir: os.TempDir(),
  1075. },
  1076. }),
  1077. channel: &mockSSHChannel,
  1078. }
  1079. scpCommand := scpCommand{
  1080. sshCommand: sshCommand{
  1081. command: "scp",
  1082. connection: connection,
  1083. args: []string{"-t", "/tmp"},
  1084. },
  1085. }
  1086. err := scpCommand.handleRecursiveUpload()
  1087. assert.EqualError(t, err, "unacceptable end dir command")
  1088. }
  1089. func TestSCPParseUploadMessage(t *testing.T) {
  1090. buf := make([]byte, 65535)
  1091. stdErrBuf := make([]byte, 65535)
  1092. mockSSHChannel := MockChannel{
  1093. Buffer: bytes.NewBuffer(buf),
  1094. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1095. ReadError: nil,
  1096. }
  1097. fs := vfs.NewOsFs("", os.TempDir(), "")
  1098. connection := &Connection{
  1099. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", dataprovider.User{
  1100. BaseUser: sdk.BaseUser{
  1101. HomeDir: os.TempDir(),
  1102. },
  1103. }),
  1104. channel: &mockSSHChannel,
  1105. }
  1106. scpCommand := scpCommand{
  1107. sshCommand: sshCommand{
  1108. command: "scp",
  1109. connection: connection,
  1110. args: []string{"-t", "/tmp"},
  1111. },
  1112. }
  1113. _, _, err := scpCommand.parseUploadMessage(fs, "invalid")
  1114. assert.Error(t, err, "parsing invalid upload message must fail")
  1115. _, _, err = scpCommand.parseUploadMessage(fs, "D0755 0")
  1116. assert.Error(t, err, "parsing incomplete upload message must fail")
  1117. _, _, err = scpCommand.parseUploadMessage(fs, "D0755 invalidsize testdir")
  1118. assert.Error(t, err, "parsing upload message with invalid size must fail")
  1119. _, _, err = scpCommand.parseUploadMessage(fs, "D0755 0 ")
  1120. assert.Error(t, err, "parsing upload message with invalid name must fail")
  1121. }
  1122. func TestSCPProtocolMessages(t *testing.T) {
  1123. buf := make([]byte, 65535)
  1124. stdErrBuf := make([]byte, 65535)
  1125. readErr := fmt.Errorf("test read error")
  1126. writeErr := fmt.Errorf("test write error")
  1127. mockSSHChannel := MockChannel{
  1128. Buffer: bytes.NewBuffer(buf),
  1129. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1130. ReadError: readErr,
  1131. WriteError: writeErr,
  1132. }
  1133. connection := &Connection{
  1134. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", dataprovider.User{}),
  1135. channel: &mockSSHChannel,
  1136. }
  1137. scpCommand := scpCommand{
  1138. sshCommand: sshCommand{
  1139. command: "scp",
  1140. connection: connection,
  1141. args: []string{"-t", "/tmp"},
  1142. },
  1143. }
  1144. _, err := scpCommand.readProtocolMessage()
  1145. assert.EqualError(t, err, readErr.Error())
  1146. err = scpCommand.sendConfirmationMessage()
  1147. assert.EqualError(t, err, writeErr.Error())
  1148. err = scpCommand.sendProtocolMessage("E\n")
  1149. assert.EqualError(t, err, writeErr.Error())
  1150. _, err = scpCommand.getNextUploadProtocolMessage()
  1151. assert.EqualError(t, err, readErr.Error())
  1152. mockSSHChannel = MockChannel{
  1153. Buffer: bytes.NewBuffer([]byte("T1183832947 0 1183833773 0\n")),
  1154. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1155. ReadError: nil,
  1156. WriteError: writeErr,
  1157. }
  1158. scpCommand.connection.channel = &mockSSHChannel
  1159. _, err = scpCommand.getNextUploadProtocolMessage()
  1160. assert.EqualError(t, err, writeErr.Error())
  1161. respBuffer := []byte{0x02}
  1162. protocolErrorMsg := "protocol error msg"
  1163. respBuffer = append(respBuffer, protocolErrorMsg...)
  1164. respBuffer = append(respBuffer, 0x0A)
  1165. mockSSHChannel = MockChannel{
  1166. Buffer: bytes.NewBuffer(respBuffer),
  1167. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1168. ReadError: nil,
  1169. WriteError: nil,
  1170. }
  1171. scpCommand.connection.channel = &mockSSHChannel
  1172. err = scpCommand.readConfirmationMessage()
  1173. if assert.Error(t, err) {
  1174. assert.Equal(t, protocolErrorMsg, err.Error())
  1175. }
  1176. }
  1177. func TestSCPTestDownloadProtocolMessages(t *testing.T) {
  1178. buf := make([]byte, 65535)
  1179. stdErrBuf := make([]byte, 65535)
  1180. readErr := fmt.Errorf("test read error")
  1181. writeErr := fmt.Errorf("test write error")
  1182. mockSSHChannel := MockChannel{
  1183. Buffer: bytes.NewBuffer(buf),
  1184. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1185. ReadError: readErr,
  1186. WriteError: writeErr,
  1187. }
  1188. connection := &Connection{
  1189. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", dataprovider.User{}),
  1190. channel: &mockSSHChannel,
  1191. }
  1192. scpCommand := scpCommand{
  1193. sshCommand: sshCommand{
  1194. command: "scp",
  1195. connection: connection,
  1196. args: []string{"-f", "-p", "/tmp"},
  1197. },
  1198. }
  1199. path := "testDir"
  1200. err := os.Mkdir(path, os.ModePerm)
  1201. assert.NoError(t, err)
  1202. stat, err := os.Stat(path)
  1203. assert.NoError(t, err)
  1204. err = scpCommand.sendDownloadProtocolMessages(path, stat)
  1205. assert.EqualError(t, err, writeErr.Error())
  1206. mockSSHChannel = MockChannel{
  1207. Buffer: bytes.NewBuffer(buf),
  1208. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1209. ReadError: readErr,
  1210. WriteError: nil,
  1211. }
  1212. err = scpCommand.sendDownloadProtocolMessages(path, stat)
  1213. assert.EqualError(t, err, readErr.Error())
  1214. mockSSHChannel = MockChannel{
  1215. Buffer: bytes.NewBuffer(buf),
  1216. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1217. ReadError: readErr,
  1218. WriteError: writeErr,
  1219. }
  1220. scpCommand.args = []string{"-f", "/tmp"}
  1221. scpCommand.connection.channel = &mockSSHChannel
  1222. err = scpCommand.sendDownloadProtocolMessages(path, stat)
  1223. assert.EqualError(t, err, writeErr.Error())
  1224. mockSSHChannel = MockChannel{
  1225. Buffer: bytes.NewBuffer(buf),
  1226. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1227. ReadError: readErr,
  1228. WriteError: nil,
  1229. }
  1230. scpCommand.connection.channel = &mockSSHChannel
  1231. err = scpCommand.sendDownloadProtocolMessages(path, stat)
  1232. assert.EqualError(t, err, readErr.Error())
  1233. err = os.Remove(path)
  1234. assert.NoError(t, err)
  1235. }
  1236. func TestSCPCommandHandleErrors(t *testing.T) {
  1237. buf := make([]byte, 65535)
  1238. stdErrBuf := make([]byte, 65535)
  1239. readErr := fmt.Errorf("test read error")
  1240. writeErr := fmt.Errorf("test write error")
  1241. mockSSHChannel := MockChannel{
  1242. Buffer: bytes.NewBuffer(buf),
  1243. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1244. ReadError: readErr,
  1245. WriteError: writeErr,
  1246. }
  1247. server, client := net.Pipe()
  1248. defer func() {
  1249. err := server.Close()
  1250. assert.NoError(t, err)
  1251. }()
  1252. defer func() {
  1253. err := client.Close()
  1254. assert.NoError(t, err)
  1255. }()
  1256. connection := &Connection{
  1257. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", dataprovider.User{}),
  1258. channel: &mockSSHChannel,
  1259. }
  1260. scpCommand := scpCommand{
  1261. sshCommand: sshCommand{
  1262. command: "scp",
  1263. connection: connection,
  1264. args: []string{"-f", "/tmp"},
  1265. },
  1266. }
  1267. err := scpCommand.handle()
  1268. assert.EqualError(t, err, readErr.Error())
  1269. scpCommand.args = []string{"-i", "/tmp"}
  1270. err = scpCommand.handle()
  1271. assert.Error(t, err, "invalid scp command must fail")
  1272. }
  1273. func TestSCPErrorsMockFs(t *testing.T) {
  1274. errFake := errors.New("fake error")
  1275. u := dataprovider.User{}
  1276. u.Username = "test"
  1277. u.Permissions = make(map[string][]string)
  1278. u.Permissions["/"] = []string{dataprovider.PermAny}
  1279. u.HomeDir = os.TempDir()
  1280. buf := make([]byte, 65535)
  1281. stdErrBuf := make([]byte, 65535)
  1282. mockSSHChannel := MockChannel{
  1283. Buffer: bytes.NewBuffer(buf),
  1284. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1285. }
  1286. server, client := net.Pipe()
  1287. defer func() {
  1288. err := server.Close()
  1289. assert.NoError(t, err)
  1290. }()
  1291. defer func() {
  1292. err := client.Close()
  1293. assert.NoError(t, err)
  1294. }()
  1295. connection := &Connection{
  1296. channel: &mockSSHChannel,
  1297. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", u),
  1298. }
  1299. scpCommand := scpCommand{
  1300. sshCommand: sshCommand{
  1301. command: "scp",
  1302. connection: connection,
  1303. args: []string{"-r", "-t", "/tmp"},
  1304. },
  1305. }
  1306. testfile := filepath.Join(u.HomeDir, "testfile")
  1307. err := os.WriteFile(testfile, []byte("test"), os.ModePerm)
  1308. assert.NoError(t, err)
  1309. fs := newMockOsFs(errFake, nil, true, "123", os.TempDir())
  1310. err = scpCommand.handleUploadFile(fs, testfile, testfile, 0, false, 4, "/testfile")
  1311. assert.NoError(t, err)
  1312. err = os.Remove(testfile)
  1313. assert.NoError(t, err)
  1314. }
  1315. func TestSCPRecursiveDownloadErrors(t *testing.T) {
  1316. buf := make([]byte, 65535)
  1317. stdErrBuf := make([]byte, 65535)
  1318. readErr := fmt.Errorf("test read error")
  1319. writeErr := fmt.Errorf("test write error")
  1320. mockSSHChannel := MockChannel{
  1321. Buffer: bytes.NewBuffer(buf),
  1322. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1323. ReadError: readErr,
  1324. WriteError: writeErr,
  1325. }
  1326. server, client := net.Pipe()
  1327. defer func() {
  1328. err := server.Close()
  1329. assert.NoError(t, err)
  1330. }()
  1331. defer func() {
  1332. err := client.Close()
  1333. assert.NoError(t, err)
  1334. }()
  1335. fs := vfs.NewOsFs("123", os.TempDir(), "")
  1336. connection := &Connection{
  1337. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", dataprovider.User{
  1338. BaseUser: sdk.BaseUser{
  1339. HomeDir: os.TempDir(),
  1340. },
  1341. }),
  1342. channel: &mockSSHChannel,
  1343. }
  1344. scpCommand := scpCommand{
  1345. sshCommand: sshCommand{
  1346. command: "scp",
  1347. connection: connection,
  1348. args: []string{"-r", "-f", "/tmp"},
  1349. },
  1350. }
  1351. path := "testDir"
  1352. err := os.Mkdir(path, os.ModePerm)
  1353. assert.NoError(t, err)
  1354. stat, err := os.Stat(path)
  1355. assert.NoError(t, err)
  1356. err = scpCommand.handleRecursiveDownload(fs, "invalid_dir", "invalid_dir", stat)
  1357. assert.EqualError(t, err, writeErr.Error())
  1358. mockSSHChannel = MockChannel{
  1359. Buffer: bytes.NewBuffer(buf),
  1360. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1361. ReadError: nil,
  1362. WriteError: nil,
  1363. }
  1364. scpCommand.connection.channel = &mockSSHChannel
  1365. err = scpCommand.handleRecursiveDownload(fs, "invalid_dir", "invalid_dir", stat)
  1366. assert.Error(t, err, "recursive upload download must fail for a non existing dir")
  1367. err = os.Remove(path)
  1368. assert.NoError(t, err)
  1369. }
  1370. func TestSCPRecursiveUploadErrors(t *testing.T) {
  1371. buf := make([]byte, 65535)
  1372. stdErrBuf := make([]byte, 65535)
  1373. readErr := fmt.Errorf("test read error")
  1374. writeErr := fmt.Errorf("test write error")
  1375. mockSSHChannel := MockChannel{
  1376. Buffer: bytes.NewBuffer(buf),
  1377. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1378. ReadError: readErr,
  1379. WriteError: writeErr,
  1380. }
  1381. connection := &Connection{
  1382. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", dataprovider.User{}),
  1383. channel: &mockSSHChannel,
  1384. }
  1385. scpCommand := scpCommand{
  1386. sshCommand: sshCommand{
  1387. command: "scp",
  1388. connection: connection,
  1389. args: []string{"-r", "-t", "/tmp"},
  1390. },
  1391. }
  1392. err := scpCommand.handleRecursiveUpload()
  1393. assert.Error(t, err, "recursive upload must fail, we send a fake error message")
  1394. mockSSHChannel = MockChannel{
  1395. Buffer: bytes.NewBuffer(buf),
  1396. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1397. ReadError: readErr,
  1398. WriteError: nil,
  1399. }
  1400. scpCommand.connection.channel = &mockSSHChannel
  1401. err = scpCommand.handleRecursiveUpload()
  1402. assert.Error(t, err, "recursive upload must fail, we send a fake error message")
  1403. }
  1404. func TestSCPCreateDirs(t *testing.T) {
  1405. buf := make([]byte, 65535)
  1406. stdErrBuf := make([]byte, 65535)
  1407. u := dataprovider.User{}
  1408. u.HomeDir = "home_rel_path"
  1409. u.Username = "test"
  1410. u.Permissions = make(map[string][]string)
  1411. u.Permissions["/"] = []string{dataprovider.PermAny}
  1412. mockSSHChannel := MockChannel{
  1413. Buffer: bytes.NewBuffer(buf),
  1414. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1415. ReadError: nil,
  1416. WriteError: nil,
  1417. }
  1418. fs, err := u.GetFilesystem("123")
  1419. assert.NoError(t, err)
  1420. connection := &Connection{
  1421. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", u),
  1422. channel: &mockSSHChannel,
  1423. }
  1424. scpCommand := scpCommand{
  1425. sshCommand: sshCommand{
  1426. command: "scp",
  1427. connection: connection,
  1428. args: []string{"-r", "-t", "/tmp"},
  1429. },
  1430. }
  1431. err = scpCommand.handleCreateDir(fs, "invalid_dir")
  1432. assert.Error(t, err, "create invalid dir must fail")
  1433. }
  1434. func TestSCPDownloadFileData(t *testing.T) {
  1435. testfile := "testfile"
  1436. buf := make([]byte, 65535)
  1437. readErr := fmt.Errorf("test read error")
  1438. writeErr := fmt.Errorf("test write error")
  1439. stdErrBuf := make([]byte, 65535)
  1440. mockSSHChannelReadErr := MockChannel{
  1441. Buffer: bytes.NewBuffer(buf),
  1442. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1443. ReadError: readErr,
  1444. WriteError: nil,
  1445. }
  1446. mockSSHChannelWriteErr := MockChannel{
  1447. Buffer: bytes.NewBuffer(buf),
  1448. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1449. ReadError: nil,
  1450. WriteError: writeErr,
  1451. }
  1452. fs := vfs.NewOsFs("", os.TempDir(), "")
  1453. connection := &Connection{
  1454. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", dataprovider.User{BaseUser: sdk.BaseUser{HomeDir: os.TempDir()}}),
  1455. channel: &mockSSHChannelReadErr,
  1456. }
  1457. scpCommand := scpCommand{
  1458. sshCommand: sshCommand{
  1459. command: "scp",
  1460. connection: connection,
  1461. args: []string{"-r", "-f", "/tmp"},
  1462. },
  1463. }
  1464. err := os.WriteFile(testfile, []byte("test"), os.ModePerm)
  1465. assert.NoError(t, err)
  1466. stat, err := os.Stat(testfile)
  1467. assert.NoError(t, err)
  1468. err = scpCommand.sendDownloadFileData(fs, testfile, stat, nil)
  1469. assert.EqualError(t, err, readErr.Error())
  1470. scpCommand.connection.channel = &mockSSHChannelWriteErr
  1471. err = scpCommand.sendDownloadFileData(fs, testfile, stat, nil)
  1472. assert.EqualError(t, err, writeErr.Error())
  1473. scpCommand.args = []string{"-r", "-p", "-f", "/tmp"}
  1474. err = scpCommand.sendDownloadFileData(fs, testfile, stat, nil)
  1475. assert.EqualError(t, err, writeErr.Error())
  1476. scpCommand.connection.channel = &mockSSHChannelReadErr
  1477. err = scpCommand.sendDownloadFileData(fs, testfile, stat, nil)
  1478. assert.EqualError(t, err, readErr.Error())
  1479. err = os.Remove(testfile)
  1480. assert.NoError(t, err)
  1481. }
  1482. func TestSCPUploadFiledata(t *testing.T) {
  1483. testfile := "testfile"
  1484. buf := make([]byte, 65535)
  1485. stdErrBuf := make([]byte, 65535)
  1486. readErr := fmt.Errorf("test read error")
  1487. writeErr := fmt.Errorf("test write error")
  1488. mockSSHChannel := MockChannel{
  1489. Buffer: bytes.NewBuffer(buf),
  1490. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1491. ReadError: readErr,
  1492. WriteError: writeErr,
  1493. }
  1494. user := dataprovider.User{
  1495. BaseUser: sdk.BaseUser{
  1496. Username: "testuser",
  1497. },
  1498. }
  1499. fs := vfs.NewOsFs("", os.TempDir(), "")
  1500. connection := &Connection{
  1501. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", user),
  1502. channel: &mockSSHChannel,
  1503. }
  1504. scpCommand := scpCommand{
  1505. sshCommand: sshCommand{
  1506. command: "scp",
  1507. connection: connection,
  1508. args: []string{"-r", "-t", "/tmp"},
  1509. },
  1510. }
  1511. file, err := os.Create(testfile)
  1512. assert.NoError(t, err)
  1513. baseTransfer := common.NewBaseTransfer(file, scpCommand.connection.BaseConnection, nil, file.Name(), file.Name(),
  1514. "/"+testfile, common.TransferDownload, 0, 0, 0, 0, true, fs, dataprovider.TransferQuota{})
  1515. transfer := newTransfer(baseTransfer, nil, nil, nil)
  1516. err = scpCommand.getUploadFileData(2, transfer)
  1517. assert.Error(t, err, "upload must fail, we send a fake write error message")
  1518. mockSSHChannel = MockChannel{
  1519. Buffer: bytes.NewBuffer(buf),
  1520. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1521. ReadError: readErr,
  1522. WriteError: nil,
  1523. }
  1524. scpCommand.connection.channel = &mockSSHChannel
  1525. file, err = os.Create(testfile)
  1526. assert.NoError(t, err)
  1527. transfer.File = file
  1528. transfer.isFinished = false
  1529. transfer.Connection.AddTransfer(transfer)
  1530. err = scpCommand.getUploadFileData(2, transfer)
  1531. assert.Error(t, err, "upload must fail, we send a fake read error message")
  1532. respBuffer := []byte("12")
  1533. respBuffer = append(respBuffer, 0x02)
  1534. mockSSHChannel = MockChannel{
  1535. Buffer: bytes.NewBuffer(respBuffer),
  1536. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1537. ReadError: nil,
  1538. WriteError: nil,
  1539. }
  1540. scpCommand.connection.channel = &mockSSHChannel
  1541. file, err = os.Create(testfile)
  1542. assert.NoError(t, err)
  1543. baseTransfer.File = file
  1544. transfer = newTransfer(baseTransfer, nil, nil, nil)
  1545. transfer.Connection.AddTransfer(transfer)
  1546. err = scpCommand.getUploadFileData(2, transfer)
  1547. assert.Error(t, err, "upload must fail, we have not enough data to read")
  1548. // the file is already closed so we have an error on trasfer closing
  1549. mockSSHChannel = MockChannel{
  1550. Buffer: bytes.NewBuffer(buf),
  1551. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1552. ReadError: nil,
  1553. WriteError: nil,
  1554. }
  1555. transfer.Connection.AddTransfer(transfer)
  1556. err = scpCommand.getUploadFileData(0, transfer)
  1557. if assert.Error(t, err) {
  1558. assert.EqualError(t, err, common.ErrTransferClosed.Error())
  1559. }
  1560. mockSSHChannel = MockChannel{
  1561. Buffer: bytes.NewBuffer(buf),
  1562. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1563. ReadError: nil,
  1564. WriteError: nil,
  1565. }
  1566. transfer.Connection.AddTransfer(transfer)
  1567. err = scpCommand.getUploadFileData(2, transfer)
  1568. assert.True(t, errors.Is(err, os.ErrClosed))
  1569. err = os.Remove(testfile)
  1570. assert.NoError(t, err)
  1571. }
  1572. func TestUploadError(t *testing.T) {
  1573. common.Config.UploadMode = common.UploadModeAtomic
  1574. user := dataprovider.User{
  1575. BaseUser: sdk.BaseUser{
  1576. Username: "testuser",
  1577. },
  1578. }
  1579. fs := vfs.NewOsFs("", os.TempDir(), "")
  1580. connection := &Connection{
  1581. BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", user),
  1582. }
  1583. testfile := "testfile"
  1584. fileTempName := "temptestfile"
  1585. file, err := os.Create(fileTempName)
  1586. assert.NoError(t, err)
  1587. baseTransfer := common.NewBaseTransfer(file, connection.BaseConnection, nil, testfile, file.Name(),
  1588. testfile, common.TransferUpload, 0, 0, 0, 0, true, fs, dataprovider.TransferQuota{})
  1589. transfer := newTransfer(baseTransfer, nil, nil, nil)
  1590. errFake := errors.New("fake error")
  1591. transfer.TransferError(errFake)
  1592. err = transfer.Close()
  1593. if assert.Error(t, err) {
  1594. assert.EqualError(t, err, common.ErrGenericFailure.Error())
  1595. }
  1596. if assert.Error(t, transfer.ErrTransfer) {
  1597. assert.EqualError(t, transfer.ErrTransfer, errFake.Error())
  1598. }
  1599. assert.Equal(t, int64(0), transfer.BytesReceived)
  1600. assert.NoFileExists(t, testfile)
  1601. assert.NoFileExists(t, fileTempName)
  1602. common.Config.UploadMode = common.UploadModeAtomicWithResume
  1603. }
  1604. func TestTransferFailingReader(t *testing.T) {
  1605. user := dataprovider.User{
  1606. BaseUser: sdk.BaseUser{
  1607. Username: "testuser",
  1608. HomeDir: os.TempDir(),
  1609. },
  1610. FsConfig: vfs.Filesystem{
  1611. Provider: sdk.CryptedFilesystemProvider,
  1612. CryptConfig: vfs.CryptFsConfig{
  1613. Passphrase: kms.NewPlainSecret("crypt secret"),
  1614. },
  1615. },
  1616. }
  1617. user.Permissions = make(map[string][]string)
  1618. user.Permissions["/"] = []string{dataprovider.PermAny}
  1619. fs := newMockOsFs(nil, nil, true, "", os.TempDir())
  1620. connection := &Connection{
  1621. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
  1622. }
  1623. request := sftp.NewRequest("Open", "afile.txt")
  1624. request.Flags = 27 // read,write,create,truncate
  1625. transfer, err := connection.handleFilewrite(request)
  1626. require.NoError(t, err)
  1627. buf := make([]byte, 32)
  1628. _, err = transfer.ReadAt(buf, 0)
  1629. assert.EqualError(t, err, sftp.ErrSSHFxOpUnsupported.Error())
  1630. if c, ok := transfer.(io.Closer); ok {
  1631. err = c.Close()
  1632. assert.NoError(t, err)
  1633. }
  1634. fsPath := filepath.Join(os.TempDir(), "afile.txt")
  1635. r, _, err := pipeat.Pipe()
  1636. assert.NoError(t, err)
  1637. baseTransfer := common.NewBaseTransfer(nil, connection.BaseConnection, nil, fsPath, fsPath, filepath.Base(fsPath),
  1638. common.TransferUpload, 0, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
  1639. errRead := errors.New("read is not allowed")
  1640. tr := newTransfer(baseTransfer, nil, r, errRead)
  1641. _, err = tr.ReadAt(buf, 0)
  1642. assert.EqualError(t, err, errRead.Error())
  1643. err = tr.Close()
  1644. assert.NoError(t, err)
  1645. tr = newTransfer(baseTransfer, nil, nil, errRead)
  1646. _, err = tr.ReadAt(buf, 0)
  1647. assert.EqualError(t, err, errRead.Error())
  1648. err = tr.Close()
  1649. assert.NoError(t, err)
  1650. err = os.Remove(fsPath)
  1651. assert.NoError(t, err)
  1652. assert.Len(t, connection.GetTransfers(), 0)
  1653. }
  1654. func TestConnectionStatusStruct(t *testing.T) {
  1655. var transfers []common.ConnectionTransfer
  1656. transferUL := common.ConnectionTransfer{
  1657. OperationType: "upload",
  1658. StartTime: util.GetTimeAsMsSinceEpoch(time.Now()),
  1659. Size: 123,
  1660. VirtualPath: "/test.upload",
  1661. }
  1662. transferDL := common.ConnectionTransfer{
  1663. OperationType: "download",
  1664. StartTime: util.GetTimeAsMsSinceEpoch(time.Now()),
  1665. Size: 123,
  1666. VirtualPath: "/test.download",
  1667. }
  1668. transfers = append(transfers, transferUL)
  1669. transfers = append(transfers, transferDL)
  1670. c := common.ConnectionStatus{
  1671. Username: "test",
  1672. ConnectionID: "123",
  1673. ClientVersion: "fakeClient-1.0.0",
  1674. RemoteAddress: "127.0.0.1:1234",
  1675. ConnectionTime: util.GetTimeAsMsSinceEpoch(time.Now()),
  1676. LastActivity: util.GetTimeAsMsSinceEpoch(time.Now()),
  1677. Protocol: "SFTP",
  1678. Transfers: transfers,
  1679. }
  1680. durationString := c.GetConnectionDuration()
  1681. assert.NotEqual(t, 0, len(durationString))
  1682. transfersString := c.GetTransfersAsString()
  1683. assert.NotEqual(t, 0, len(transfersString))
  1684. connInfo := c.GetConnectionInfo()
  1685. assert.NotEqual(t, 0, len(connInfo))
  1686. }
  1687. func TestSupportedSecurityOptions(t *testing.T) {
  1688. c := Configuration{
  1689. KexAlgorithms: supportedKexAlgos,
  1690. MACs: supportedMACs,
  1691. Ciphers: supportedCiphers,
  1692. }
  1693. serverConfig := &ssh.ServerConfig{}
  1694. err := c.configureSecurityOptions(serverConfig)
  1695. assert.NoError(t, err)
  1696. assert.Equal(t, supportedCiphers, serverConfig.Ciphers)
  1697. assert.Equal(t, supportedMACs, serverConfig.MACs)
  1698. assert.Equal(t, supportedKexAlgos, serverConfig.KeyExchanges)
  1699. c.KexAlgorithms = append(c.KexAlgorithms, "not a kex")
  1700. err = c.configureSecurityOptions(serverConfig)
  1701. assert.Error(t, err)
  1702. }
  1703. func TestLoadHostKeys(t *testing.T) {
  1704. configDir := ".."
  1705. serverConfig := &ssh.ServerConfig{}
  1706. c := Configuration{}
  1707. c.HostKeys = []string{".", "missing file"}
  1708. err := c.checkAndLoadHostKeys(configDir, serverConfig)
  1709. assert.Error(t, err)
  1710. testfile := filepath.Join(os.TempDir(), "invalidkey")
  1711. err = os.WriteFile(testfile, []byte("some bytes"), os.ModePerm)
  1712. assert.NoError(t, err)
  1713. c.HostKeys = []string{testfile}
  1714. err = c.checkAndLoadHostKeys(configDir, serverConfig)
  1715. assert.Error(t, err)
  1716. err = os.Remove(testfile)
  1717. assert.NoError(t, err)
  1718. keysDir := filepath.Join(os.TempDir(), "keys")
  1719. err = os.MkdirAll(keysDir, os.ModePerm)
  1720. assert.NoError(t, err)
  1721. rsaKeyName := filepath.Join(keysDir, defaultPrivateRSAKeyName)
  1722. ecdsaKeyName := filepath.Join(keysDir, defaultPrivateECDSAKeyName)
  1723. ed25519KeyName := filepath.Join(keysDir, defaultPrivateEd25519KeyName)
  1724. nonDefaultKeyName := filepath.Join(keysDir, "akey")
  1725. c.HostKeys = []string{nonDefaultKeyName, rsaKeyName, ecdsaKeyName, ed25519KeyName}
  1726. err = c.checkAndLoadHostKeys(configDir, serverConfig)
  1727. assert.Error(t, err)
  1728. assert.FileExists(t, rsaKeyName)
  1729. assert.FileExists(t, ecdsaKeyName)
  1730. assert.FileExists(t, ed25519KeyName)
  1731. assert.NoFileExists(t, nonDefaultKeyName)
  1732. err = os.Remove(rsaKeyName)
  1733. assert.NoError(t, err)
  1734. err = os.Remove(ecdsaKeyName)
  1735. assert.NoError(t, err)
  1736. err = os.Remove(ed25519KeyName)
  1737. assert.NoError(t, err)
  1738. if runtime.GOOS != osWindows {
  1739. err = os.Chmod(keysDir, 0551)
  1740. assert.NoError(t, err)
  1741. c.HostKeys = nil
  1742. err = c.checkAndLoadHostKeys(keysDir, serverConfig)
  1743. assert.Error(t, err)
  1744. c.HostKeys = []string{rsaKeyName, ecdsaKeyName}
  1745. err = c.checkAndLoadHostKeys(configDir, serverConfig)
  1746. assert.Error(t, err)
  1747. c.HostKeys = []string{ecdsaKeyName, rsaKeyName}
  1748. err = c.checkAndLoadHostKeys(configDir, serverConfig)
  1749. assert.Error(t, err)
  1750. c.HostKeys = []string{ed25519KeyName}
  1751. err = c.checkAndLoadHostKeys(configDir, serverConfig)
  1752. assert.Error(t, err)
  1753. err = os.Chmod(keysDir, 0755)
  1754. assert.NoError(t, err)
  1755. }
  1756. err = os.RemoveAll(keysDir)
  1757. assert.NoError(t, err)
  1758. }
  1759. func TestCertCheckerInitErrors(t *testing.T) {
  1760. c := Configuration{}
  1761. c.TrustedUserCAKeys = []string{".", "missing file"}
  1762. err := c.initializeCertChecker("")
  1763. assert.Error(t, err)
  1764. testfile := filepath.Join(os.TempDir(), "invalidkey")
  1765. err = os.WriteFile(testfile, []byte("some bytes"), os.ModePerm)
  1766. assert.NoError(t, err)
  1767. c.TrustedUserCAKeys = []string{testfile}
  1768. err = c.initializeCertChecker("")
  1769. assert.Error(t, err)
  1770. err = os.Remove(testfile)
  1771. assert.NoError(t, err)
  1772. }
  1773. func TestRecursiveCopyErrors(t *testing.T) {
  1774. permissions := make(map[string][]string)
  1775. permissions["/"] = []string{dataprovider.PermAny}
  1776. user := dataprovider.User{
  1777. BaseUser: sdk.BaseUser{
  1778. Permissions: permissions,
  1779. HomeDir: os.TempDir(),
  1780. },
  1781. }
  1782. fs, err := user.GetFilesystem("123")
  1783. assert.NoError(t, err)
  1784. conn := &Connection{
  1785. BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
  1786. }
  1787. sshCmd := sshCommand{
  1788. command: "sftpgo-copy",
  1789. connection: conn,
  1790. args: []string{"adir", "another"},
  1791. }
  1792. // try to copy a missing directory
  1793. err = sshCmd.checkRecursiveCopyPermissions(fs, fs, "adir", "another", "/another")
  1794. assert.Error(t, err)
  1795. }
  1796. func TestSFTPSubSystem(t *testing.T) {
  1797. permissions := make(map[string][]string)
  1798. permissions["/"] = []string{dataprovider.PermAny}
  1799. user := &dataprovider.User{
  1800. BaseUser: sdk.BaseUser{
  1801. Permissions: permissions,
  1802. HomeDir: os.TempDir(),
  1803. },
  1804. }
  1805. user.FsConfig.Provider = sdk.AzureBlobFilesystemProvider
  1806. err := ServeSubSystemConnection(user, "connID", nil, nil)
  1807. assert.Error(t, err)
  1808. user.FsConfig.Provider = sdk.LocalFilesystemProvider
  1809. buf := make([]byte, 0, 4096)
  1810. stdErrBuf := make([]byte, 0, 4096)
  1811. mockSSHChannel := &MockChannel{
  1812. Buffer: bytes.NewBuffer(buf),
  1813. StdErrBuffer: bytes.NewBuffer(stdErrBuf),
  1814. }
  1815. // this is 327680 and it will result in packet too long error
  1816. _, err = mockSSHChannel.Write([]byte{0x00, 0x05, 0x00, 0x00, 0x00, 0x00})
  1817. assert.NoError(t, err)
  1818. err = ServeSubSystemConnection(user, "id", mockSSHChannel, mockSSHChannel)
  1819. assert.EqualError(t, err, "packet too long")
  1820. subsystemChannel := newSubsystemChannel(mockSSHChannel, mockSSHChannel)
  1821. n, err := subsystemChannel.Write([]byte{0x00})
  1822. assert.NoError(t, err)
  1823. assert.Equal(t, n, 1)
  1824. err = subsystemChannel.Close()
  1825. assert.NoError(t, err)
  1826. }
  1827. func TestRecoverer(t *testing.T) {
  1828. c := Configuration{}
  1829. c.AcceptInboundConnection(nil, nil)
  1830. connID := "connectionID"
  1831. connection := &Connection{
  1832. BaseConnection: common.NewBaseConnection(connID, common.ProtocolSFTP, "", "", dataprovider.User{}),
  1833. }
  1834. c.handleSftpConnection(nil, connection)
  1835. sshCmd := sshCommand{
  1836. command: "cd",
  1837. connection: connection,
  1838. }
  1839. err := sshCmd.handle()
  1840. assert.EqualError(t, err, common.ErrGenericFailure.Error())
  1841. scpCmd := scpCommand{
  1842. sshCommand: sshCommand{
  1843. command: "scp",
  1844. connection: connection,
  1845. },
  1846. }
  1847. err = scpCmd.handle()
  1848. assert.EqualError(t, err, common.ErrGenericFailure.Error())
  1849. assert.Len(t, common.Connections.GetStats(), 0)
  1850. }
  1851. func TestListernerAcceptErrors(t *testing.T) {
  1852. errFake := errors.New("a fake error")
  1853. listener := newFakeListener(errFake)
  1854. c := Configuration{}
  1855. err := c.serve(listener, nil)
  1856. require.EqualError(t, err, errFake.Error())
  1857. err = listener.Close()
  1858. require.NoError(t, err)
  1859. errNetFake := &fakeNetError{error: errFake}
  1860. listener = newFakeListener(errNetFake)
  1861. err = c.serve(listener, nil)
  1862. require.EqualError(t, err, errFake.Error())
  1863. err = listener.Close()
  1864. require.NoError(t, err)
  1865. }
  1866. type fakeNetError struct {
  1867. error
  1868. count int
  1869. }
  1870. func (e *fakeNetError) Timeout() bool {
  1871. return false
  1872. }
  1873. func (e *fakeNetError) Temporary() bool {
  1874. e.count++
  1875. return e.count < 10
  1876. }
  1877. func (e *fakeNetError) Error() string {
  1878. return e.error.Error()
  1879. }
  1880. type fakeListener struct {
  1881. server net.Conn
  1882. client net.Conn
  1883. err error
  1884. }
  1885. func (l *fakeListener) Accept() (net.Conn, error) {
  1886. return l.client, l.err
  1887. }
  1888. func (l *fakeListener) Close() error {
  1889. errClient := l.client.Close()
  1890. errServer := l.server.Close()
  1891. if errServer != nil {
  1892. return errServer
  1893. }
  1894. return errClient
  1895. }
  1896. func (l *fakeListener) Addr() net.Addr {
  1897. return l.server.LocalAddr()
  1898. }
  1899. func newFakeListener(err error) net.Listener {
  1900. server, client := net.Pipe()
  1901. return &fakeListener{
  1902. server: server,
  1903. client: client,
  1904. err: err,
  1905. }
  1906. }
  1907. func TestFolderPrefix(t *testing.T) {
  1908. c := Configuration{
  1909. FolderPrefix: "files",
  1910. }
  1911. c.checkFolderPrefix()
  1912. assert.Equal(t, "/files", c.FolderPrefix)
  1913. c.FolderPrefix = ""
  1914. c.checkFolderPrefix()
  1915. assert.Empty(t, c.FolderPrefix)
  1916. c.FolderPrefix = "/"
  1917. c.checkFolderPrefix()
  1918. assert.Empty(t, c.FolderPrefix)
  1919. c.FolderPrefix = "/."
  1920. c.checkFolderPrefix()
  1921. assert.Empty(t, c.FolderPrefix)
  1922. c.FolderPrefix = "."
  1923. c.checkFolderPrefix()
  1924. assert.Empty(t, c.FolderPrefix)
  1925. c.FolderPrefix = ".."
  1926. c.checkFolderPrefix()
  1927. assert.Empty(t, c.FolderPrefix)
  1928. }
  1929. func TestLoadRevokedUserCertsFile(t *testing.T) {
  1930. r := revokedCertificates{
  1931. certs: map[string]bool{},
  1932. }
  1933. err := r.load()
  1934. assert.NoError(t, err)
  1935. r.filePath = filepath.Join(os.TempDir(), "sub", "testrevoked")
  1936. err = os.MkdirAll(filepath.Dir(r.filePath), os.ModePerm)
  1937. assert.NoError(t, err)
  1938. err = os.WriteFile(r.filePath, []byte(`no json`), 0644)
  1939. assert.NoError(t, err)
  1940. err = r.load()
  1941. assert.Error(t, err)
  1942. r.filePath = filepath.Dir(r.filePath)
  1943. err = r.load()
  1944. assert.Error(t, err)
  1945. err = os.RemoveAll(r.filePath)
  1946. assert.NoError(t, err)
  1947. }
  1948. func TestMaxUserSessions(t *testing.T) {
  1949. connection := &Connection{
  1950. BaseConnection: common.NewBaseConnection(xid.New().String(), common.ProtocolSFTP, "", "", dataprovider.User{
  1951. BaseUser: sdk.BaseUser{
  1952. Username: "user_max_sessions",
  1953. HomeDir: filepath.Clean(os.TempDir()),
  1954. MaxSessions: 1,
  1955. },
  1956. }),
  1957. }
  1958. err := common.Connections.Add(connection)
  1959. assert.NoError(t, err)
  1960. c := Configuration{}
  1961. c.handleSftpConnection(nil, connection)
  1962. sshCmd := sshCommand{
  1963. command: "cd",
  1964. connection: connection,
  1965. }
  1966. err = sshCmd.handle()
  1967. if assert.Error(t, err) {
  1968. assert.Contains(t, err.Error(), "too many open sessions")
  1969. }
  1970. scpCmd := scpCommand{
  1971. sshCommand: sshCommand{
  1972. command: "scp",
  1973. connection: connection,
  1974. },
  1975. }
  1976. err = scpCmd.handle()
  1977. if assert.Error(t, err) {
  1978. assert.Contains(t, err.Error(), "too many open sessions")
  1979. }
  1980. err = ServeSubSystemConnection(&connection.User, connection.ID, nil, nil)
  1981. if assert.Error(t, err) {
  1982. assert.Contains(t, err.Error(), "too many open sessions")
  1983. }
  1984. common.Connections.Remove(connection.GetID())
  1985. assert.Len(t, common.Connections.GetStats(), 0)
  1986. }