internal_test.go 69 KB

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