internal_test.go 67 KB

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