internal_test.go 58 KB

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