1
0

internal_test.go 68 KB

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