123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331 |
- // Copyright (C) 2019-2022 Nicola Murino
- //
- // This program is free software: you can redistribute it and/or modify
- // it under the terms of the GNU Affero General Public License as published
- // by the Free Software Foundation, version 3.
- //
- // This program is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU Affero General Public License for more details.
- //
- // You should have received a copy of the GNU Affero General Public License
- // along with this program. If not, see <https://www.gnu.org/licenses/>.
- package sftpd
- import (
- "bytes"
- "errors"
- "fmt"
- "io"
- "io/fs"
- "net"
- "os"
- "path/filepath"
- "runtime"
- "testing"
- "time"
- "github.com/eikenb/pipeat"
- "github.com/pkg/sftp"
- "github.com/rs/xid"
- "github.com/sftpgo/sdk"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
- "golang.org/x/crypto/ssh"
- "github.com/drakkan/sftpgo/v2/internal/common"
- "github.com/drakkan/sftpgo/v2/internal/dataprovider"
- "github.com/drakkan/sftpgo/v2/internal/kms"
- "github.com/drakkan/sftpgo/v2/internal/util"
- "github.com/drakkan/sftpgo/v2/internal/vfs"
- )
- const (
- osWindows = "windows"
- )
- var (
- configDir = filepath.Join(".", "..", "..")
- )
- type MockChannel struct {
- Buffer *bytes.Buffer
- StdErrBuffer *bytes.Buffer
- ReadError error
- WriteError error
- ShortWriteErr bool
- }
- func (c *MockChannel) Read(data []byte) (int, error) {
- if c.ReadError != nil {
- return 0, c.ReadError
- }
- return c.Buffer.Read(data)
- }
- func (c *MockChannel) Write(data []byte) (int, error) {
- if c.WriteError != nil {
- return 0, c.WriteError
- }
- if c.ShortWriteErr {
- return 0, nil
- }
- return c.Buffer.Write(data)
- }
- func (c *MockChannel) Close() error {
- return nil
- }
- func (c *MockChannel) CloseWrite() error {
- return nil
- }
- func (c *MockChannel) SendRequest(name string, wantReply bool, payload []byte) (bool, error) {
- return true, nil
- }
- func (c *MockChannel) Stderr() io.ReadWriter {
- return c.StdErrBuffer
- }
- // MockOsFs mockable OsFs
- type MockOsFs struct {
- vfs.Fs
- err error
- statErr error
- isAtomicUploadSupported bool
- }
- // Name returns the name for the Fs implementation
- func (fs MockOsFs) Name() string {
- return "mockOsFs"
- }
- // IsUploadResumeSupported returns true if resuming uploads is supported
- func (MockOsFs) IsUploadResumeSupported() bool {
- return false
- }
- // IsAtomicUploadSupported returns true if atomic upload is supported
- func (fs MockOsFs) IsAtomicUploadSupported() bool {
- return fs.isAtomicUploadSupported
- }
- // Stat returns a FileInfo describing the named file
- func (fs MockOsFs) Stat(name string) (os.FileInfo, error) {
- if fs.statErr != nil {
- return nil, fs.statErr
- }
- return os.Stat(name)
- }
- // Lstat returns a FileInfo describing the named file
- func (fs MockOsFs) Lstat(name string) (os.FileInfo, error) {
- if fs.statErr != nil {
- return nil, fs.statErr
- }
- return os.Lstat(name)
- }
- // Remove removes the named file or (empty) directory.
- func (fs MockOsFs) Remove(name string, isDir bool) error {
- if fs.err != nil {
- return fs.err
- }
- return os.Remove(name)
- }
- // Rename renames (moves) source to target
- func (fs MockOsFs) Rename(source, target string) error {
- if fs.err != nil {
- return fs.err
- }
- return os.Rename(source, target)
- }
- func newMockOsFs(err, statErr error, atomicUpload bool, connectionID, rootDir string) vfs.Fs {
- return &MockOsFs{
- Fs: vfs.NewOsFs(connectionID, rootDir, ""),
- err: err,
- statErr: statErr,
- isAtomicUploadSupported: atomicUpload,
- }
- }
- func TestRemoveNonexistentQuotaScan(t *testing.T) {
- assert.False(t, common.QuotaScans.RemoveUserQuotaScan("username"))
- }
- func TestGetOSOpenFlags(t *testing.T) {
- var flags sftp.FileOpenFlags
- flags.Write = true
- flags.Excl = true
- osFlags := getOSOpenFlags(flags)
- assert.NotEqual(t, 0, osFlags&os.O_WRONLY)
- assert.NotEqual(t, 0, osFlags&os.O_EXCL)
- flags.Append = true
- // append flag should be ignored to allow resume
- assert.NotEqual(t, 0, osFlags&os.O_WRONLY)
- assert.NotEqual(t, 0, osFlags&os.O_EXCL)
- }
- func TestUploadResumeInvalidOffset(t *testing.T) {
- testfile := "testfile" //nolint:goconst
- file, err := os.Create(testfile)
- assert.NoError(t, err)
- user := dataprovider.User{
- BaseUser: sdk.BaseUser{
- Username: "testuser",
- },
- }
- fs := vfs.NewOsFs("", os.TempDir(), "")
- conn := common.NewBaseConnection("", common.ProtocolSFTP, "", "", user)
- baseTransfer := common.NewBaseTransfer(file, conn, nil, file.Name(), file.Name(), testfile,
- common.TransferUpload, 10, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
- transfer := newTransfer(baseTransfer, nil, nil, nil)
- _, err = transfer.WriteAt([]byte("test"), 0)
- assert.Error(t, err, "upload with invalid offset must fail")
- if assert.Error(t, transfer.ErrTransfer) {
- assert.EqualError(t, err, transfer.ErrTransfer.Error())
- assert.Contains(t, transfer.ErrTransfer.Error(), "invalid write offset")
- }
- err = transfer.Close()
- if assert.Error(t, err) {
- assert.ErrorIs(t, err, sftp.ErrSSHFxFailure)
- }
- err = os.Remove(testfile)
- assert.NoError(t, err)
- }
- func TestReadWriteErrors(t *testing.T) {
- testfile := "testfile"
- file, err := os.Create(testfile)
- assert.NoError(t, err)
- user := dataprovider.User{
- BaseUser: sdk.BaseUser{
- Username: "testuser",
- },
- }
- fs := vfs.NewOsFs("", os.TempDir(), "")
- conn := common.NewBaseConnection("", common.ProtocolSFTP, "", "", user)
- baseTransfer := common.NewBaseTransfer(file, conn, nil, file.Name(), file.Name(), testfile, common.TransferDownload,
- 0, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
- transfer := newTransfer(baseTransfer, nil, nil, nil)
- err = file.Close()
- assert.NoError(t, err)
- _, err = transfer.WriteAt([]byte("test"), 0)
- assert.Error(t, err, "writing to closed file must fail")
- buf := make([]byte, 32768)
- _, err = transfer.ReadAt(buf, 0)
- assert.Error(t, err, "reading from a closed file must fail")
- err = transfer.Close()
- assert.Error(t, err)
- r, _, err := pipeat.Pipe()
- assert.NoError(t, err)
- baseTransfer = common.NewBaseTransfer(nil, conn, nil, file.Name(), file.Name(), testfile, common.TransferDownload,
- 0, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
- transfer = newTransfer(baseTransfer, nil, r, nil)
- err = transfer.Close()
- assert.NoError(t, err)
- _, err = transfer.ReadAt(buf, 0)
- assert.Error(t, err, "reading from a closed pipe must fail")
- r, w, err := pipeat.Pipe()
- assert.NoError(t, err)
- pipeWriter := vfs.NewPipeWriter(w)
- baseTransfer = common.NewBaseTransfer(nil, conn, nil, file.Name(), file.Name(), testfile, common.TransferDownload,
- 0, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
- transfer = newTransfer(baseTransfer, pipeWriter, nil, nil)
- err = r.Close()
- assert.NoError(t, err)
- errFake := fmt.Errorf("fake upload error")
- go func() {
- time.Sleep(100 * time.Millisecond)
- pipeWriter.Done(errFake)
- }()
- err = transfer.closeIO()
- assert.EqualError(t, err, errFake.Error())
- _, err = transfer.WriteAt([]byte("test"), 0)
- assert.Error(t, err, "writing to closed pipe must fail")
- err = transfer.BaseTransfer.Close()
- assert.EqualError(t, err, errFake.Error())
- err = os.Remove(testfile)
- assert.NoError(t, err)
- assert.Len(t, conn.GetTransfers(), 0)
- }
- func TestUnsupportedListOP(t *testing.T) {
- conn := common.NewBaseConnection("", common.ProtocolSFTP, "", "", dataprovider.User{})
- sftpConn := Connection{
- BaseConnection: conn,
- }
- request := sftp.NewRequest("Unsupported", "")
- _, err := sftpConn.Filelist(request)
- assert.EqualError(t, err, sftp.ErrSSHFxOpUnsupported.Error())
- }
- func TestTransferCancelFn(t *testing.T) {
- testfile := "testfile"
- file, err := os.Create(testfile)
- assert.NoError(t, err)
- isCancelled := false
- cancelFn := func() {
- isCancelled = true
- }
- user := dataprovider.User{
- BaseUser: sdk.BaseUser{
- Username: "testuser",
- },
- }
- fs := vfs.NewOsFs("", os.TempDir(), "")
- conn := common.NewBaseConnection("", common.ProtocolSFTP, "", "", user)
- baseTransfer := common.NewBaseTransfer(file, conn, cancelFn, file.Name(), file.Name(), testfile, common.TransferDownload,
- 0, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
- transfer := newTransfer(baseTransfer, nil, nil, nil)
- errFake := errors.New("fake error, this will trigger cancelFn")
- transfer.TransferError(errFake)
- err = transfer.Close()
- if assert.Error(t, err) {
- assert.ErrorIs(t, err, sftp.ErrSSHFxFailure)
- }
- if assert.Error(t, transfer.ErrTransfer) {
- assert.EqualError(t, transfer.ErrTransfer, errFake.Error())
- }
- assert.True(t, isCancelled, "cancelFn not called!")
- err = os.Remove(testfile)
- assert.NoError(t, err)
- }
- func TestUploadFiles(t *testing.T) {
- common.Config.UploadMode = common.UploadModeAtomic
- fs := vfs.NewOsFs("123", os.TempDir(), "")
- u := dataprovider.User{}
- c := Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", u),
- }
- var flags sftp.FileOpenFlags
- flags.Write = true
- flags.Trunc = true
- _, err := c.handleSFTPUploadToExistingFile(fs, flags, "missing_path", "other_missing_path", 0, "/missing_path", nil)
- assert.Error(t, err, "upload to existing file must fail if one or both paths are invalid")
- common.Config.UploadMode = common.UploadModeStandard
- _, err = c.handleSFTPUploadToExistingFile(fs, flags, "missing_path", "other_missing_path", 0, "/missing_path", nil)
- assert.Error(t, err, "upload to existing file must fail if one or both paths are invalid")
- missingFile := "missing/relative/file.txt"
- if runtime.GOOS == osWindows {
- missingFile = "missing\\relative\\file.txt"
- }
- _, err = c.handleSFTPUploadToNewFile(fs, flags, ".", missingFile, "/missing", nil)
- assert.Error(t, err, "upload new file in missing path must fail")
- fs = newMockOsFs(nil, nil, false, "123", os.TempDir())
- f, err := os.CreateTemp("", "temp")
- assert.NoError(t, err)
- err = f.Close()
- assert.NoError(t, err)
- tr, err := c.handleSFTPUploadToExistingFile(fs, flags, f.Name(), f.Name(), 123, f.Name(), nil)
- if assert.NoError(t, err) {
- transfer := tr.(*transfer)
- transfers := c.GetTransfers()
- if assert.Equal(t, 1, len(transfers)) {
- assert.Equal(t, transfers[0].ID, transfer.GetID())
- assert.Equal(t, int64(123), transfer.InitialSize)
- err = transfer.Close()
- assert.NoError(t, err)
- assert.Equal(t, 0, len(c.GetTransfers()))
- }
- }
- err = os.Remove(f.Name())
- assert.NoError(t, err)
- common.Config.UploadMode = common.UploadModeAtomicWithResume
- }
- func TestWithInvalidHome(t *testing.T) {
- u := dataprovider.User{}
- u.HomeDir = "home_rel_path" //nolint:goconst
- _, err := loginUser(&u, dataprovider.LoginMethodPassword, "", nil)
- assert.Error(t, err, "login a user with an invalid home_dir must fail")
- u.HomeDir = os.TempDir()
- fs, err := u.GetFilesystem("123")
- assert.NoError(t, err)
- c := Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", u),
- }
- _, err = fs.ResolvePath("../upper_path")
- assert.Error(t, err, "tested path is not a home subdir")
- _, err = c.StatVFS(&sftp.Request{
- Method: "StatVFS",
- Filepath: "../unresolvable-path",
- })
- assert.Error(t, err)
- }
- func TestResolveWithRootDir(t *testing.T) {
- u := dataprovider.User{}
- if runtime.GOOS == osWindows {
- u.HomeDir = "C:\\"
- } else {
- u.HomeDir = "/"
- }
- fs, err := u.GetFilesystem("")
- assert.NoError(t, err)
- rel, err := filepath.Rel(u.HomeDir, os.TempDir())
- assert.NoError(t, err)
- p, err := fs.ResolvePath(rel)
- assert.NoError(t, err, "path %v", p)
- }
- func TestSFTPGetUsedQuota(t *testing.T) {
- u := dataprovider.User{}
- u.HomeDir = "home_rel_path"
- u.Username = "test_invalid_user"
- u.QuotaSize = 4096
- u.QuotaFiles = 1
- u.Permissions = make(map[string][]string)
- u.Permissions["/"] = []string{dataprovider.PermAny}
- connection := Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", u),
- }
- quotaResult, _ := connection.HasSpace(false, false, "/")
- assert.False(t, quotaResult.HasSpace)
- }
- func TestSupportedSSHCommands(t *testing.T) {
- cmds := GetSupportedSSHCommands()
- assert.Equal(t, len(supportedSSHCommands), len(cmds))
- for _, c := range cmds {
- assert.True(t, util.Contains(supportedSSHCommands, c))
- }
- }
- func TestSSHCommandPath(t *testing.T) {
- buf := make([]byte, 65535)
- stdErrBuf := make([]byte, 65535)
- mockSSHChannel := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- }
- connection := &Connection{
- channel: &mockSSHChannel,
- BaseConnection: common.NewBaseConnection("", common.ProtocolSSH, "", "", dataprovider.User{}),
- }
- sshCommand := sshCommand{
- command: "test",
- connection: connection,
- args: []string{},
- }
- assert.Equal(t, "", sshCommand.getDestPath())
- sshCommand.args = []string{"-t", "/tmp/../path"}
- assert.Equal(t, "/path", sshCommand.getDestPath())
- sshCommand.args = []string{"-t", "/tmp/"}
- assert.Equal(t, "/tmp/", sshCommand.getDestPath())
- sshCommand.args = []string{"-t", "tmp/"}
- assert.Equal(t, "/tmp/", sshCommand.getDestPath())
- sshCommand.args = []string{"-t", "/tmp/../../../path"}
- assert.Equal(t, "/path", sshCommand.getDestPath())
- sshCommand.args = []string{"-t", ".."}
- assert.Equal(t, "/", sshCommand.getDestPath())
- sshCommand.args = []string{"-t", "."}
- assert.Equal(t, "/", sshCommand.getDestPath())
- sshCommand.args = []string{"-t", "//"}
- assert.Equal(t, "/", sshCommand.getDestPath())
- sshCommand.args = []string{"-t", "../.."}
- assert.Equal(t, "/", sshCommand.getDestPath())
- sshCommand.args = []string{"-t", "/.."}
- assert.Equal(t, "/", sshCommand.getDestPath())
- sshCommand.args = []string{"-f", "/a space.txt"}
- assert.Equal(t, "/a space.txt", sshCommand.getDestPath())
- }
- func TestSSHParseCommandPayload(t *testing.T) {
- cmd := "command -a -f /ab\\ à/some\\ spaces\\ \\ \\(\\).txt"
- name, args, _ := parseCommandPayload(cmd)
- assert.Equal(t, "command", name)
- assert.Equal(t, 3, len(args))
- assert.Equal(t, "/ab à/some spaces ().txt", args[2])
- _, _, err := parseCommandPayload("")
- assert.Error(t, err, "parsing invalid command must fail")
- }
- func TestSSHCommandErrors(t *testing.T) {
- buf := make([]byte, 65535)
- stdErrBuf := make([]byte, 65535)
- readErr := fmt.Errorf("test read error")
- mockSSHChannel := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: readErr,
- }
- server, client := net.Pipe()
- defer func() {
- err := server.Close()
- assert.NoError(t, err)
- }()
- defer func() {
- err := client.Close()
- assert.NoError(t, err)
- }()
- user := dataprovider.User{}
- user.Permissions = map[string][]string{
- "/": {dataprovider.PermAny},
- }
- connection := Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSSH, "", "", user),
- channel: &mockSSHChannel,
- }
- cmd := sshCommand{
- command: "md5sum",
- connection: &connection,
- args: []string{},
- }
- err := cmd.handle()
- assert.Error(t, err, "ssh command must fail, we are sending a fake error")
- cmd = sshCommand{
- command: "md5sum",
- connection: &connection,
- args: []string{"/../../test_file_ftp.dat"},
- }
- err = cmd.handle()
- assert.Error(t, err, "ssh command must fail, we are requesting an invalid path")
- cmd = sshCommand{
- command: "git-receive-pack",
- connection: &connection,
- args: []string{"/../../testrepo"},
- }
- err = cmd.handle()
- assert.Error(t, err, "ssh command must fail, we are requesting an invalid path")
- user = dataprovider.User{}
- user.Permissions = map[string][]string{
- "/": {dataprovider.PermAny},
- }
- user.HomeDir = filepath.Clean(os.TempDir())
- user.QuotaFiles = 1
- user.UsedQuotaFiles = 2
- cmd.connection.User = user
- fs, err := cmd.connection.User.GetFilesystem("123")
- assert.NoError(t, err)
- err = cmd.handle()
- assert.EqualError(t, err, common.ErrQuotaExceeded.Error())
- cmd.connection.User.QuotaFiles = 0
- cmd.connection.User.UsedQuotaFiles = 0
- cmd.connection.User.Permissions = make(map[string][]string)
- cmd.connection.User.Permissions["/"] = []string{dataprovider.PermListItems}
- err = cmd.handle()
- assert.EqualError(t, err, common.ErrPermissionDenied.Error())
- cmd.connection.User.Permissions["/"] = []string{dataprovider.PermAny}
- cmd.command = "invalid_command"
- command, err := cmd.getSystemCommand()
- assert.NoError(t, err)
- err = cmd.executeSystemCommand(command)
- assert.Error(t, err, "invalid command must fail")
- command, err = cmd.getSystemCommand()
- assert.NoError(t, err)
- _, err = command.cmd.StderrPipe()
- assert.NoError(t, err)
- err = cmd.executeSystemCommand(command)
- assert.Error(t, err, "command must fail, pipe was already assigned")
- err = cmd.executeSystemCommand(command)
- assert.Error(t, err, "command must fail, pipe was already assigned")
- command, err = cmd.getSystemCommand()
- assert.NoError(t, err)
- _, err = command.cmd.StdoutPipe()
- assert.NoError(t, err)
- err = cmd.executeSystemCommand(command)
- assert.Error(t, err, "command must fail, pipe was already assigned")
- cmd = sshCommand{
- command: "sftpgo-remove",
- connection: &connection,
- args: []string{"/../../src"},
- }
- err = cmd.handle()
- assert.Error(t, err, "ssh command must fail, we are requesting an invalid path")
- cmd = sshCommand{
- command: "sftpgo-copy",
- connection: &connection,
- args: []string{"/../../test_src", "."},
- }
- err = cmd.handle()
- assert.Error(t, err, "ssh command must fail, we are requesting an invalid path")
- cmd.connection.User.HomeDir = filepath.Clean(os.TempDir())
- cmd = sshCommand{
- command: "sftpgo-copy",
- connection: &connection,
- args: []string{"src", "dst"},
- }
- cmd.connection.User.Permissions = make(map[string][]string)
- cmd.connection.User.Permissions["/"] = []string{dataprovider.PermAny}
- if runtime.GOOS != osWindows {
- aDir := filepath.Join(os.TempDir(), "adir")
- err = os.MkdirAll(aDir, os.ModePerm)
- assert.NoError(t, err)
- tmpFile := filepath.Join(aDir, "testcopy")
- err = os.WriteFile(tmpFile, []byte("aaa"), os.ModePerm)
- assert.NoError(t, err)
- err = os.Chmod(aDir, 0001)
- assert.NoError(t, err)
- err = cmd.checkCopyDestination(fs, tmpFile)
- assert.Error(t, err)
- err = os.Chmod(aDir, os.ModePerm)
- assert.NoError(t, err)
- err = os.Remove(tmpFile)
- assert.NoError(t, err)
- }
- common.WaitForTransfers(1)
- _, err = cmd.getSystemCommand()
- if assert.Error(t, err) {
- assert.Contains(t, err.Error(), common.ErrShuttingDown.Error())
- }
- err = common.Initialize(common.Config, 0)
- assert.NoError(t, err)
- }
- func TestCommandsWithExtensionsFilter(t *testing.T) {
- buf := make([]byte, 65535)
- stdErrBuf := make([]byte, 65535)
- mockSSHChannel := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- }
- server, client := net.Pipe()
- defer server.Close()
- defer client.Close()
- user := dataprovider.User{
- BaseUser: sdk.BaseUser{
- Username: "test",
- HomeDir: os.TempDir(),
- Status: 1,
- },
- }
- user.Filters.FilePatterns = []sdk.PatternsFilter{
- {
- Path: "/subdir",
- AllowedPatterns: []string{".jpg"},
- DeniedPatterns: []string{},
- },
- }
- connection := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSSH, "", "", user),
- channel: &mockSSHChannel,
- }
- cmd := sshCommand{
- command: "md5sum",
- connection: connection,
- args: []string{"subdir/test.png"},
- }
- err := cmd.handleHashCommands()
- assert.EqualError(t, err, common.ErrPermissionDenied.Error())
- cmd = sshCommand{
- command: "rsync",
- connection: connection,
- args: []string{"--server", "-vlogDtprze.iLsfxC", ".", "/"},
- }
- _, err = cmd.getSystemCommand()
- assert.EqualError(t, err, errUnsupportedConfig.Error())
- cmd = sshCommand{
- command: "git-receive-pack",
- connection: connection,
- args: []string{"/subdir"},
- }
- _, err = cmd.getSystemCommand()
- assert.EqualError(t, err, errUnsupportedConfig.Error())
- cmd = sshCommand{
- command: "git-receive-pack",
- connection: connection,
- args: []string{"/subdir/dir"},
- }
- _, err = cmd.getSystemCommand()
- assert.EqualError(t, err, errUnsupportedConfig.Error())
- cmd = sshCommand{
- command: "git-receive-pack",
- connection: connection,
- args: []string{"/adir/subdir"},
- }
- _, err = cmd.getSystemCommand()
- assert.NoError(t, err)
- }
- func TestSSHCommandsRemoteFs(t *testing.T) {
- buf := make([]byte, 65535)
- stdErrBuf := make([]byte, 65535)
- mockSSHChannel := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- }
- user := dataprovider.User{}
- user.FsConfig = vfs.Filesystem{
- Provider: sdk.S3FilesystemProvider,
- S3Config: vfs.S3FsConfig{
- BaseS3FsConfig: sdk.BaseS3FsConfig{
- Bucket: "s3bucket",
- Endpoint: "endpoint",
- Region: "eu-west-1",
- },
- },
- }
- connection := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
- channel: &mockSSHChannel,
- }
- cmd := sshCommand{
- command: "md5sum",
- connection: connection,
- args: []string{},
- }
- command, err := cmd.getSystemCommand()
- assert.NoError(t, err)
- err = cmd.executeSystemCommand(command)
- assert.Error(t, err, "command must fail for a non local filesystem")
- cmd = sshCommand{
- command: "sftpgo-copy",
- connection: connection,
- args: []string{},
- }
- err = cmd.handleSFTPGoCopy()
- assert.Error(t, err)
- cmd = sshCommand{
- command: "sftpgo-remove",
- connection: connection,
- args: []string{},
- }
- err = cmd.handleSFTPGoRemove()
- assert.Error(t, err)
- // the user has no permissions
- assert.False(t, cmd.hasCopyPermissions("", "", nil))
- }
- func TestSSHCmdGetFsErrors(t *testing.T) {
- buf := make([]byte, 65535)
- stdErrBuf := make([]byte, 65535)
- mockSSHChannel := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- }
- user := dataprovider.User{
- BaseUser: sdk.BaseUser{
- HomeDir: "relative path",
- },
- }
- user.Permissions = map[string][]string{}
- user.Permissions["/"] = []string{dataprovider.PermAny}
- connection := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
- channel: &mockSSHChannel,
- }
- cmd := sshCommand{
- command: "sftpgo-remove",
- connection: connection,
- args: []string{"path"},
- }
- err := cmd.handleSFTPGoRemove()
- assert.Error(t, err)
- cmd = sshCommand{
- command: "sftpgo-copy",
- connection: connection,
- args: []string{"path1", "path2"},
- }
- _, _, _, _, _, _, err = cmd.getFsAndCopyPaths() //nolint:dogsled
- assert.Error(t, err)
- user = dataprovider.User{}
- user.HomeDir = filepath.Join(os.TempDir(), "home")
- user.VirtualFolders = append(connection.User.VirtualFolders, vfs.VirtualFolder{
- BaseVirtualFolder: vfs.BaseVirtualFolder{
- MappedPath: "relative",
- },
- VirtualPath: "/vpath",
- })
- connection.User = user
- err = os.MkdirAll(user.GetHomeDir(), os.ModePerm)
- assert.NoError(t, err)
- cmd = sshCommand{
- command: "sftpgo-copy",
- connection: connection,
- args: []string{"path1", "/vpath/path2"},
- }
- _, _, _, _, _, _, err = cmd.getFsAndCopyPaths() //nolint:dogsled
- assert.Error(t, err)
- err = os.Remove(user.GetHomeDir())
- assert.NoError(t, err)
- }
- func TestGitVirtualFolders(t *testing.T) {
- permissions := make(map[string][]string)
- permissions["/"] = []string{dataprovider.PermAny}
- user := dataprovider.User{
- BaseUser: sdk.BaseUser{
- Permissions: permissions,
- HomeDir: os.TempDir(),
- },
- }
- conn := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
- }
- cmd := sshCommand{
- command: "git-receive-pack",
- connection: conn,
- args: []string{"/vdir"},
- }
- cmd.connection.User.VirtualFolders = append(cmd.connection.User.VirtualFolders, vfs.VirtualFolder{
- BaseVirtualFolder: vfs.BaseVirtualFolder{
- MappedPath: os.TempDir(),
- },
- VirtualPath: "/vdir",
- })
- _, err := cmd.getSystemCommand()
- assert.NoError(t, err)
- cmd.args = []string{"/"}
- _, err = cmd.getSystemCommand()
- assert.EqualError(t, err, errUnsupportedConfig.Error())
- cmd.args = []string{"/vdir1"}
- _, err = cmd.getSystemCommand()
- assert.NoError(t, err)
- cmd.connection.User.VirtualFolders = nil
- cmd.connection.User.VirtualFolders = append(cmd.connection.User.VirtualFolders, vfs.VirtualFolder{
- BaseVirtualFolder: vfs.BaseVirtualFolder{
- MappedPath: os.TempDir(),
- },
- VirtualPath: "/vdir",
- })
- cmd.args = []string{"/vdir/subdir"}
- _, err = cmd.getSystemCommand()
- assert.NoError(t, err)
- cmd.args = []string{"/adir/subdir"}
- _, err = cmd.getSystemCommand()
- assert.NoError(t, err)
- }
- func TestRsyncOptions(t *testing.T) {
- permissions := make(map[string][]string)
- permissions["/"] = []string{dataprovider.PermAny}
- user := dataprovider.User{
- BaseUser: sdk.BaseUser{
- Permissions: permissions,
- HomeDir: os.TempDir(),
- },
- }
- conn := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
- }
- sshCmd := sshCommand{
- command: "rsync",
- connection: conn,
- args: []string{"--server", "-vlogDtprze.iLsfxC", ".", "/"},
- }
- cmd, err := sshCmd.getSystemCommand()
- assert.NoError(t, err)
- assert.True(t, util.Contains(cmd.cmd.Args, "--safe-links"),
- "--safe-links must be added if the user has the create symlinks permission")
- permissions["/"] = []string{dataprovider.PermDownload, dataprovider.PermUpload, dataprovider.PermCreateDirs,
- dataprovider.PermListItems, dataprovider.PermOverwrite, dataprovider.PermDelete, dataprovider.PermRename}
- user.Permissions = permissions
- conn = &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
- }
- sshCmd = sshCommand{
- command: "rsync",
- connection: conn,
- args: []string{"--server", "-vlogDtprze.iLsfxC", ".", "/"},
- }
- cmd, err = sshCmd.getSystemCommand()
- assert.NoError(t, err)
- assert.True(t, util.Contains(cmd.cmd.Args, "--munge-links"),
- "--munge-links must be added if the user has the create symlinks permission")
- sshCmd.connection.User.VirtualFolders = append(sshCmd.connection.User.VirtualFolders, vfs.VirtualFolder{
- BaseVirtualFolder: vfs.BaseVirtualFolder{
- MappedPath: os.TempDir(),
- },
- VirtualPath: "/vdir",
- })
- _, err = sshCmd.getSystemCommand()
- assert.EqualError(t, err, errUnsupportedConfig.Error())
- }
- func TestSystemCommandSizeForPath(t *testing.T) {
- permissions := make(map[string][]string)
- permissions["/"] = []string{dataprovider.PermAny}
- user := dataprovider.User{
- BaseUser: sdk.BaseUser{
- Permissions: permissions,
- HomeDir: os.TempDir(),
- },
- }
- fs, err := user.GetFilesystem("123")
- assert.NoError(t, err)
- conn := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
- }
- sshCmd := sshCommand{
- command: "rsync",
- connection: conn,
- args: []string{"--server", "-vlogDtprze.iLsfxC", ".", "/"},
- }
- _, _, err = sshCmd.getSizeForPath(fs, "missing path")
- assert.NoError(t, err)
- testDir := filepath.Join(os.TempDir(), "dir")
- err = os.MkdirAll(testDir, os.ModePerm)
- assert.NoError(t, err)
- testFile := filepath.Join(testDir, "testfile")
- err = os.WriteFile(testFile, []byte("test content"), os.ModePerm)
- assert.NoError(t, err)
- err = os.Symlink(testFile, testFile+".link")
- assert.NoError(t, err)
- numFiles, size, err := sshCmd.getSizeForPath(fs, testFile+".link")
- assert.NoError(t, err)
- assert.Equal(t, 0, numFiles)
- assert.Equal(t, int64(0), size)
- numFiles, size, err = sshCmd.getSizeForPath(fs, testFile)
- assert.NoError(t, err)
- assert.Equal(t, 1, numFiles)
- assert.Equal(t, int64(12), size)
- if runtime.GOOS != osWindows {
- err = os.Chmod(testDir, 0001)
- assert.NoError(t, err)
- _, _, err = sshCmd.getSizeForPath(fs, testFile)
- assert.Error(t, err)
- err = os.Chmod(testDir, os.ModePerm)
- assert.NoError(t, err)
- }
- err = os.RemoveAll(testDir)
- assert.NoError(t, err)
- }
- func TestSystemCommandErrors(t *testing.T) {
- buf := make([]byte, 65535)
- stdErrBuf := make([]byte, 65535)
- readErr := fmt.Errorf("test read error")
- writeErr := fmt.Errorf("test write error")
- mockSSHChannel := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- WriteError: writeErr,
- }
- permissions := make(map[string][]string)
- permissions["/"] = []string{dataprovider.PermAny}
- homeDir := filepath.Join(os.TempDir(), "adir")
- err := os.MkdirAll(homeDir, os.ModePerm)
- assert.NoError(t, err)
- err = os.WriteFile(filepath.Join(homeDir, "afile"), []byte("content"), os.ModePerm)
- assert.NoError(t, err)
- user := dataprovider.User{
- BaseUser: sdk.BaseUser{
- Permissions: permissions,
- HomeDir: homeDir,
- },
- }
- fs, err := user.GetFilesystem("123")
- assert.NoError(t, err)
- connection := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
- channel: &mockSSHChannel,
- }
- var sshCmd sshCommand
- if runtime.GOOS == osWindows {
- sshCmd = sshCommand{
- command: "dir",
- connection: connection,
- args: []string{"/"},
- }
- } else {
- sshCmd = sshCommand{
- command: "ls",
- connection: connection,
- args: []string{"/"},
- }
- }
- systemCmd, err := sshCmd.getSystemCommand()
- assert.NoError(t, err)
- systemCmd.cmd.Dir = os.TempDir()
- // FIXME: the command completes but the fake client is unable to read the response
- // no error is reported in this case. We can see that the expected code is executed
- // reading the test coverage
- sshCmd.executeSystemCommand(systemCmd) //nolint:errcheck
- mockSSHChannel = MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: readErr,
- WriteError: nil,
- }
- sshCmd.connection.channel = &mockSSHChannel
- baseTransfer := common.NewBaseTransfer(nil, sshCmd.connection.BaseConnection, nil, "", "", "",
- common.TransferUpload, 0, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
- transfer := newTransfer(baseTransfer, nil, nil, nil)
- destBuff := make([]byte, 65535)
- dst := bytes.NewBuffer(destBuff)
- _, err = transfer.copyFromReaderToWriter(dst, sshCmd.connection.channel)
- assert.EqualError(t, err, readErr.Error())
- mockSSHChannel = MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- WriteError: nil,
- }
- sshCmd.connection.channel = &mockSSHChannel
- transfer.MaxWriteSize = 1
- _, err = transfer.copyFromReaderToWriter(dst, sshCmd.connection.channel)
- assert.True(t, transfer.Connection.IsQuotaExceededError(err))
- mockSSHChannel = MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- WriteError: nil,
- ShortWriteErr: true,
- }
- sshCmd.connection.channel = &mockSSHChannel
- _, err = transfer.copyFromReaderToWriter(sshCmd.connection.channel, dst)
- assert.EqualError(t, err, io.ErrShortWrite.Error())
- transfer.MaxWriteSize = -1
- _, err = transfer.copyFromReaderToWriter(sshCmd.connection.channel, dst)
- assert.True(t, transfer.Connection.IsQuotaExceededError(err))
- baseTransfer = common.NewBaseTransfer(nil, sshCmd.connection.BaseConnection, nil, "", "", "",
- common.TransferDownload, 0, 0, 0, 0, false, fs, dataprovider.TransferQuota{
- AllowedDLSize: 1,
- })
- transfer = newTransfer(baseTransfer, nil, nil, nil)
- mockSSHChannel = MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- WriteError: nil,
- }
- sshCmd.connection.channel = &mockSSHChannel
- _, err = transfer.copyFromReaderToWriter(dst, sshCmd.connection.channel)
- if assert.Error(t, err) {
- assert.Contains(t, err.Error(), common.ErrReadQuotaExceeded.Error())
- }
- err = os.RemoveAll(homeDir)
- assert.NoError(t, err)
- }
- func TestCommandGetFsError(t *testing.T) {
- user := dataprovider.User{
- FsConfig: vfs.Filesystem{
- Provider: sdk.CryptedFilesystemProvider,
- },
- }
- conn := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
- }
- sshCmd := sshCommand{
- command: "rsync",
- connection: conn,
- args: []string{"--server", "-vlogDtprze.iLsfxC", ".", "/"},
- }
- _, err := sshCmd.getSystemCommand()
- assert.Error(t, err)
- buf := make([]byte, 65535)
- stdErrBuf := make([]byte, 65535)
- mockSSHChannel := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- }
- conn = &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", user),
- channel: &mockSSHChannel,
- }
- scpCommand := scpCommand{
- sshCommand: sshCommand{
- command: "scp",
- connection: conn,
- args: []string{"-t", "/tmp"},
- },
- }
- err = scpCommand.handleRecursiveUpload()
- assert.Error(t, err)
- err = scpCommand.handleDownload("")
- assert.Error(t, err)
- }
- func TestGetConnectionInfo(t *testing.T) {
- c := common.ConnectionStatus{
- Username: "test_user",
- ConnectionID: "123",
- ClientVersion: "client",
- RemoteAddress: "127.0.0.1:1234",
- Protocol: common.ProtocolSSH,
- Command: "sha1sum /test_file_ftp.dat",
- }
- info := c.GetConnectionInfo()
- assert.Contains(t, info, "sha1sum /test_file_ftp.dat")
- }
- func TestSCPFileMode(t *testing.T) {
- mode := getFileModeAsString(0, true)
- assert.Equal(t, "0755", mode)
- mode = getFileModeAsString(0700, true)
- assert.Equal(t, "0700", mode)
- mode = getFileModeAsString(0750, true)
- assert.Equal(t, "0750", mode)
- mode = getFileModeAsString(0777, true)
- assert.Equal(t, "0777", mode)
- mode = getFileModeAsString(0640, false)
- assert.Equal(t, "0640", mode)
- mode = getFileModeAsString(0600, false)
- assert.Equal(t, "0600", mode)
- mode = getFileModeAsString(0, false)
- assert.Equal(t, "0644", mode)
- fileMode := uint32(0777)
- fileMode = fileMode | uint32(os.ModeSetgid)
- fileMode = fileMode | uint32(os.ModeSetuid)
- fileMode = fileMode | uint32(os.ModeSticky)
- mode = getFileModeAsString(os.FileMode(fileMode), false)
- assert.Equal(t, "7777", mode)
- fileMode = uint32(0644)
- fileMode = fileMode | uint32(os.ModeSetgid)
- mode = getFileModeAsString(os.FileMode(fileMode), false)
- assert.Equal(t, "4644", mode)
- fileMode = uint32(0600)
- fileMode = fileMode | uint32(os.ModeSetuid)
- mode = getFileModeAsString(os.FileMode(fileMode), false)
- assert.Equal(t, "2600", mode)
- fileMode = uint32(0044)
- fileMode = fileMode | uint32(os.ModeSticky)
- mode = getFileModeAsString(os.FileMode(fileMode), false)
- assert.Equal(t, "1044", mode)
- }
- func TestSCPUploadError(t *testing.T) {
- buf := make([]byte, 65535)
- stdErrBuf := make([]byte, 65535)
- writeErr := fmt.Errorf("test write error")
- mockSSHChannel := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- WriteError: writeErr,
- }
- user := dataprovider.User{
- BaseUser: sdk.BaseUser{
- HomeDir: filepath.Join(os.TempDir()),
- Permissions: make(map[string][]string),
- },
- }
- user.Permissions["/"] = []string{dataprovider.PermAny}
- connection := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
- channel: &mockSSHChannel,
- }
- scpCommand := scpCommand{
- sshCommand: sshCommand{
- command: "scp",
- connection: connection,
- args: []string{"-t", "/"},
- },
- }
- err := scpCommand.handle()
- assert.EqualError(t, err, writeErr.Error())
- mockSSHChannel = MockChannel{
- Buffer: bytes.NewBuffer([]byte("D0755 0 testdir\n")),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- WriteError: writeErr,
- }
- err = scpCommand.handleRecursiveUpload()
- assert.EqualError(t, err, writeErr.Error())
- mockSSHChannel = MockChannel{
- Buffer: bytes.NewBuffer([]byte("D0755 a testdir\n")),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- WriteError: nil,
- }
- err = scpCommand.handleRecursiveUpload()
- assert.Error(t, err)
- }
- func TestSCPInvalidEndDir(t *testing.T) {
- stdErrBuf := make([]byte, 65535)
- mockSSHChannel := MockChannel{
- Buffer: bytes.NewBuffer([]byte("E\n")),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- }
- connection := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", dataprovider.User{
- BaseUser: sdk.BaseUser{
- HomeDir: os.TempDir(),
- },
- }),
- channel: &mockSSHChannel,
- }
- scpCommand := scpCommand{
- sshCommand: sshCommand{
- command: "scp",
- connection: connection,
- args: []string{"-t", "/tmp"},
- },
- }
- err := scpCommand.handleRecursiveUpload()
- assert.EqualError(t, err, "unacceptable end dir command")
- }
- func TestSCPParseUploadMessage(t *testing.T) {
- buf := make([]byte, 65535)
- stdErrBuf := make([]byte, 65535)
- mockSSHChannel := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- }
- fs := vfs.NewOsFs("", os.TempDir(), "")
- connection := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", dataprovider.User{
- BaseUser: sdk.BaseUser{
- HomeDir: os.TempDir(),
- },
- }),
- channel: &mockSSHChannel,
- }
- scpCommand := scpCommand{
- sshCommand: sshCommand{
- command: "scp",
- connection: connection,
- args: []string{"-t", "/tmp"},
- },
- }
- _, _, err := scpCommand.parseUploadMessage(fs, "invalid")
- assert.Error(t, err, "parsing invalid upload message must fail")
- _, _, err = scpCommand.parseUploadMessage(fs, "D0755 0")
- assert.Error(t, err, "parsing incomplete upload message must fail")
- _, _, err = scpCommand.parseUploadMessage(fs, "D0755 invalidsize testdir")
- assert.Error(t, err, "parsing upload message with invalid size must fail")
- _, _, err = scpCommand.parseUploadMessage(fs, "D0755 0 ")
- assert.Error(t, err, "parsing upload message with invalid name must fail")
- }
- func TestSCPProtocolMessages(t *testing.T) {
- buf := make([]byte, 65535)
- stdErrBuf := make([]byte, 65535)
- readErr := fmt.Errorf("test read error")
- writeErr := fmt.Errorf("test write error")
- mockSSHChannel := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: readErr,
- WriteError: writeErr,
- }
- connection := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", dataprovider.User{}),
- channel: &mockSSHChannel,
- }
- scpCommand := scpCommand{
- sshCommand: sshCommand{
- command: "scp",
- connection: connection,
- args: []string{"-t", "/tmp"},
- },
- }
- _, err := scpCommand.readProtocolMessage()
- assert.EqualError(t, err, readErr.Error())
- err = scpCommand.sendConfirmationMessage()
- assert.EqualError(t, err, writeErr.Error())
- err = scpCommand.sendProtocolMessage("E\n")
- assert.EqualError(t, err, writeErr.Error())
- _, err = scpCommand.getNextUploadProtocolMessage()
- assert.EqualError(t, err, readErr.Error())
- mockSSHChannel = MockChannel{
- Buffer: bytes.NewBuffer([]byte("T1183832947 0 1183833773 0\n")),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- WriteError: writeErr,
- }
- scpCommand.connection.channel = &mockSSHChannel
- _, err = scpCommand.getNextUploadProtocolMessage()
- assert.EqualError(t, err, writeErr.Error())
- respBuffer := []byte{0x02}
- protocolErrorMsg := "protocol error msg"
- respBuffer = append(respBuffer, protocolErrorMsg...)
- respBuffer = append(respBuffer, 0x0A)
- mockSSHChannel = MockChannel{
- Buffer: bytes.NewBuffer(respBuffer),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- WriteError: nil,
- }
- scpCommand.connection.channel = &mockSSHChannel
- err = scpCommand.readConfirmationMessage()
- if assert.Error(t, err) {
- assert.Equal(t, protocolErrorMsg, err.Error())
- }
- }
- func TestSCPTestDownloadProtocolMessages(t *testing.T) {
- buf := make([]byte, 65535)
- stdErrBuf := make([]byte, 65535)
- readErr := fmt.Errorf("test read error")
- writeErr := fmt.Errorf("test write error")
- mockSSHChannel := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: readErr,
- WriteError: writeErr,
- }
- connection := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", dataprovider.User{}),
- channel: &mockSSHChannel,
- }
- scpCommand := scpCommand{
- sshCommand: sshCommand{
- command: "scp",
- connection: connection,
- args: []string{"-f", "-p", "/tmp"},
- },
- }
- path := "testDir"
- err := os.Mkdir(path, os.ModePerm)
- assert.NoError(t, err)
- stat, err := os.Stat(path)
- assert.NoError(t, err)
- err = scpCommand.sendDownloadProtocolMessages(path, stat)
- assert.EqualError(t, err, writeErr.Error())
- mockSSHChannel = MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: readErr,
- WriteError: nil,
- }
- err = scpCommand.sendDownloadProtocolMessages(path, stat)
- assert.EqualError(t, err, readErr.Error())
- mockSSHChannel = MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: readErr,
- WriteError: writeErr,
- }
- scpCommand.args = []string{"-f", "/tmp"}
- scpCommand.connection.channel = &mockSSHChannel
- err = scpCommand.sendDownloadProtocolMessages(path, stat)
- assert.EqualError(t, err, writeErr.Error())
- mockSSHChannel = MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: readErr,
- WriteError: nil,
- }
- scpCommand.connection.channel = &mockSSHChannel
- err = scpCommand.sendDownloadProtocolMessages(path, stat)
- assert.EqualError(t, err, readErr.Error())
- err = os.Remove(path)
- assert.NoError(t, err)
- }
- func TestSCPCommandHandleErrors(t *testing.T) {
- buf := make([]byte, 65535)
- stdErrBuf := make([]byte, 65535)
- readErr := fmt.Errorf("test read error")
- writeErr := fmt.Errorf("test write error")
- mockSSHChannel := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: readErr,
- WriteError: writeErr,
- }
- server, client := net.Pipe()
- defer func() {
- err := server.Close()
- assert.NoError(t, err)
- }()
- defer func() {
- err := client.Close()
- assert.NoError(t, err)
- }()
- connection := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", dataprovider.User{}),
- channel: &mockSSHChannel,
- }
- scpCommand := scpCommand{
- sshCommand: sshCommand{
- command: "scp",
- connection: connection,
- args: []string{"-f", "/tmp"},
- },
- }
- err := scpCommand.handle()
- assert.EqualError(t, err, readErr.Error())
- scpCommand.args = []string{"-i", "/tmp"}
- err = scpCommand.handle()
- assert.Error(t, err, "invalid scp command must fail")
- }
- func TestSCPErrorsMockFs(t *testing.T) {
- errFake := errors.New("fake error")
- u := dataprovider.User{}
- u.Username = "test"
- u.Permissions = make(map[string][]string)
- u.Permissions["/"] = []string{dataprovider.PermAny}
- u.HomeDir = os.TempDir()
- buf := make([]byte, 65535)
- stdErrBuf := make([]byte, 65535)
- mockSSHChannel := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- }
- server, client := net.Pipe()
- defer func() {
- err := server.Close()
- assert.NoError(t, err)
- }()
- defer func() {
- err := client.Close()
- assert.NoError(t, err)
- }()
- connection := &Connection{
- channel: &mockSSHChannel,
- BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", u),
- }
- scpCommand := scpCommand{
- sshCommand: sshCommand{
- command: "scp",
- connection: connection,
- args: []string{"-r", "-t", "/tmp"},
- },
- }
- testfile := filepath.Join(u.HomeDir, "testfile")
- err := os.WriteFile(testfile, []byte("test"), os.ModePerm)
- assert.NoError(t, err)
- fs := newMockOsFs(errFake, nil, true, "123", os.TempDir())
- err = scpCommand.handleUploadFile(fs, testfile, testfile, 0, false, 4, "/testfile")
- assert.NoError(t, err)
- err = os.Remove(testfile)
- assert.NoError(t, err)
- }
- func TestSCPRecursiveDownloadErrors(t *testing.T) {
- buf := make([]byte, 65535)
- stdErrBuf := make([]byte, 65535)
- readErr := fmt.Errorf("test read error")
- writeErr := fmt.Errorf("test write error")
- mockSSHChannel := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: readErr,
- WriteError: writeErr,
- }
- server, client := net.Pipe()
- defer func() {
- err := server.Close()
- assert.NoError(t, err)
- }()
- defer func() {
- err := client.Close()
- assert.NoError(t, err)
- }()
- fs := vfs.NewOsFs("123", os.TempDir(), "")
- connection := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", dataprovider.User{
- BaseUser: sdk.BaseUser{
- HomeDir: os.TempDir(),
- },
- }),
- channel: &mockSSHChannel,
- }
- scpCommand := scpCommand{
- sshCommand: sshCommand{
- command: "scp",
- connection: connection,
- args: []string{"-r", "-f", "/tmp"},
- },
- }
- path := "testDir"
- err := os.Mkdir(path, os.ModePerm)
- assert.NoError(t, err)
- stat, err := os.Stat(path)
- assert.NoError(t, err)
- err = scpCommand.handleRecursiveDownload(fs, "invalid_dir", "invalid_dir", stat)
- assert.EqualError(t, err, writeErr.Error())
- mockSSHChannel = MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- WriteError: nil,
- }
- scpCommand.connection.channel = &mockSSHChannel
- err = scpCommand.handleRecursiveDownload(fs, "invalid_dir", "invalid_dir", stat)
- assert.Error(t, err, "recursive upload download must fail for a non existing dir")
- err = os.Remove(path)
- assert.NoError(t, err)
- }
- func TestSCPRecursiveUploadErrors(t *testing.T) {
- buf := make([]byte, 65535)
- stdErrBuf := make([]byte, 65535)
- readErr := fmt.Errorf("test read error")
- writeErr := fmt.Errorf("test write error")
- mockSSHChannel := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: readErr,
- WriteError: writeErr,
- }
- connection := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", dataprovider.User{}),
- channel: &mockSSHChannel,
- }
- scpCommand := scpCommand{
- sshCommand: sshCommand{
- command: "scp",
- connection: connection,
- args: []string{"-r", "-t", "/tmp"},
- },
- }
- err := scpCommand.handleRecursiveUpload()
- assert.Error(t, err, "recursive upload must fail, we send a fake error message")
- mockSSHChannel = MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: readErr,
- WriteError: nil,
- }
- scpCommand.connection.channel = &mockSSHChannel
- err = scpCommand.handleRecursiveUpload()
- assert.Error(t, err, "recursive upload must fail, we send a fake error message")
- }
- func TestSCPCreateDirs(t *testing.T) {
- buf := make([]byte, 65535)
- stdErrBuf := make([]byte, 65535)
- u := dataprovider.User{}
- u.HomeDir = "home_rel_path"
- u.Username = "test"
- u.Permissions = make(map[string][]string)
- u.Permissions["/"] = []string{dataprovider.PermAny}
- mockSSHChannel := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- WriteError: nil,
- }
- fs, err := u.GetFilesystem("123")
- assert.NoError(t, err)
- connection := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", u),
- channel: &mockSSHChannel,
- }
- scpCommand := scpCommand{
- sshCommand: sshCommand{
- command: "scp",
- connection: connection,
- args: []string{"-r", "-t", "/tmp"},
- },
- }
- err = scpCommand.handleCreateDir(fs, "invalid_dir")
- assert.Error(t, err, "create invalid dir must fail")
- }
- func TestSCPDownloadFileData(t *testing.T) {
- testfile := "testfile"
- buf := make([]byte, 65535)
- readErr := fmt.Errorf("test read error")
- writeErr := fmt.Errorf("test write error")
- stdErrBuf := make([]byte, 65535)
- mockSSHChannelReadErr := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: readErr,
- WriteError: nil,
- }
- mockSSHChannelWriteErr := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- WriteError: writeErr,
- }
- fs := vfs.NewOsFs("", os.TempDir(), "")
- connection := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", dataprovider.User{BaseUser: sdk.BaseUser{HomeDir: os.TempDir()}}),
- channel: &mockSSHChannelReadErr,
- }
- scpCommand := scpCommand{
- sshCommand: sshCommand{
- command: "scp",
- connection: connection,
- args: []string{"-r", "-f", "/tmp"},
- },
- }
- err := os.WriteFile(testfile, []byte("test"), os.ModePerm)
- assert.NoError(t, err)
- stat, err := os.Stat(testfile)
- assert.NoError(t, err)
- err = scpCommand.sendDownloadFileData(fs, testfile, stat, nil)
- assert.EqualError(t, err, readErr.Error())
- scpCommand.connection.channel = &mockSSHChannelWriteErr
- err = scpCommand.sendDownloadFileData(fs, testfile, stat, nil)
- assert.EqualError(t, err, writeErr.Error())
- scpCommand.args = []string{"-r", "-p", "-f", "/tmp"}
- err = scpCommand.sendDownloadFileData(fs, testfile, stat, nil)
- assert.EqualError(t, err, writeErr.Error())
- scpCommand.connection.channel = &mockSSHChannelReadErr
- err = scpCommand.sendDownloadFileData(fs, testfile, stat, nil)
- assert.EqualError(t, err, readErr.Error())
- err = os.Remove(testfile)
- assert.NoError(t, err)
- }
- func TestSCPUploadFiledata(t *testing.T) {
- testfile := "testfile"
- buf := make([]byte, 65535)
- stdErrBuf := make([]byte, 65535)
- readErr := fmt.Errorf("test read error")
- writeErr := fmt.Errorf("test write error")
- mockSSHChannel := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: readErr,
- WriteError: writeErr,
- }
- user := dataprovider.User{
- BaseUser: sdk.BaseUser{
- Username: "testuser",
- },
- }
- fs := vfs.NewOsFs("", os.TempDir(), "")
- connection := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", user),
- channel: &mockSSHChannel,
- }
- scpCommand := scpCommand{
- sshCommand: sshCommand{
- command: "scp",
- connection: connection,
- args: []string{"-r", "-t", "/tmp"},
- },
- }
- file, err := os.Create(testfile)
- assert.NoError(t, err)
- baseTransfer := common.NewBaseTransfer(file, scpCommand.connection.BaseConnection, nil, file.Name(), file.Name(),
- "/"+testfile, common.TransferDownload, 0, 0, 0, 0, true, fs, dataprovider.TransferQuota{})
- transfer := newTransfer(baseTransfer, nil, nil, nil)
- err = scpCommand.getUploadFileData(2, transfer)
- assert.Error(t, err, "upload must fail, we send a fake write error message")
- mockSSHChannel = MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: readErr,
- WriteError: nil,
- }
- scpCommand.connection.channel = &mockSSHChannel
- file, err = os.Create(testfile)
- assert.NoError(t, err)
- transfer.File = file
- transfer.isFinished = false
- transfer.Connection.AddTransfer(transfer)
- err = scpCommand.getUploadFileData(2, transfer)
- assert.Error(t, err, "upload must fail, we send a fake read error message")
- respBuffer := []byte("12")
- respBuffer = append(respBuffer, 0x02)
- mockSSHChannel = MockChannel{
- Buffer: bytes.NewBuffer(respBuffer),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- WriteError: nil,
- }
- scpCommand.connection.channel = &mockSSHChannel
- file, err = os.Create(testfile)
- assert.NoError(t, err)
- baseTransfer.File = file
- transfer = newTransfer(baseTransfer, nil, nil, nil)
- transfer.Connection.AddTransfer(transfer)
- err = scpCommand.getUploadFileData(2, transfer)
- assert.Error(t, err, "upload must fail, we have not enough data to read")
- // the file is already closed so we have an error on trasfer closing
- mockSSHChannel = MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- WriteError: nil,
- }
- transfer.Connection.AddTransfer(transfer)
- err = scpCommand.getUploadFileData(0, transfer)
- if assert.Error(t, err) {
- assert.EqualError(t, err, common.ErrTransferClosed.Error())
- }
- mockSSHChannel = MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- WriteError: nil,
- }
- transfer.Connection.AddTransfer(transfer)
- err = scpCommand.getUploadFileData(2, transfer)
- assert.True(t, errors.Is(err, os.ErrClosed))
- err = os.Remove(testfile)
- assert.NoError(t, err)
- }
- func TestUploadError(t *testing.T) {
- common.Config.UploadMode = common.UploadModeAtomic
- user := dataprovider.User{
- BaseUser: sdk.BaseUser{
- Username: "testuser",
- },
- }
- fs := vfs.NewOsFs("", os.TempDir(), "")
- connection := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSCP, "", "", user),
- }
- testfile := "testfile"
- fileTempName := "temptestfile"
- file, err := os.Create(fileTempName)
- assert.NoError(t, err)
- baseTransfer := common.NewBaseTransfer(file, connection.BaseConnection, nil, testfile, file.Name(),
- testfile, common.TransferUpload, 0, 0, 0, 0, true, fs, dataprovider.TransferQuota{})
- transfer := newTransfer(baseTransfer, nil, nil, nil)
- errFake := errors.New("fake error")
- transfer.TransferError(errFake)
- err = transfer.Close()
- if assert.Error(t, err) {
- assert.EqualError(t, err, common.ErrGenericFailure.Error())
- }
- if assert.Error(t, transfer.ErrTransfer) {
- assert.EqualError(t, transfer.ErrTransfer, errFake.Error())
- }
- assert.Equal(t, int64(0), transfer.BytesReceived.Load())
- assert.NoFileExists(t, testfile)
- assert.NoFileExists(t, fileTempName)
- common.Config.UploadMode = common.UploadModeAtomicWithResume
- }
- func TestTransferFailingReader(t *testing.T) {
- user := dataprovider.User{
- BaseUser: sdk.BaseUser{
- Username: "testuser",
- HomeDir: os.TempDir(),
- },
- FsConfig: vfs.Filesystem{
- Provider: sdk.CryptedFilesystemProvider,
- CryptConfig: vfs.CryptFsConfig{
- Passphrase: kms.NewPlainSecret("crypt secret"),
- },
- },
- }
- user.Permissions = make(map[string][]string)
- user.Permissions["/"] = []string{dataprovider.PermAny}
- fs := newMockOsFs(nil, nil, true, "", os.TempDir())
- connection := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
- }
- request := sftp.NewRequest("Open", "afile.txt")
- request.Flags = 27 // read,write,create,truncate
- transfer, err := connection.handleFilewrite(request)
- require.NoError(t, err)
- buf := make([]byte, 32)
- _, err = transfer.ReadAt(buf, 0)
- assert.EqualError(t, err, sftp.ErrSSHFxOpUnsupported.Error())
- if c, ok := transfer.(io.Closer); ok {
- err = c.Close()
- assert.NoError(t, err)
- }
- fsPath := filepath.Join(os.TempDir(), "afile.txt")
- r, _, err := pipeat.Pipe()
- assert.NoError(t, err)
- baseTransfer := common.NewBaseTransfer(nil, connection.BaseConnection, nil, fsPath, fsPath, filepath.Base(fsPath),
- common.TransferUpload, 0, 0, 0, 0, false, fs, dataprovider.TransferQuota{})
- errRead := errors.New("read is not allowed")
- tr := newTransfer(baseTransfer, nil, r, errRead)
- _, err = tr.ReadAt(buf, 0)
- assert.EqualError(t, err, errRead.Error())
- err = tr.Close()
- assert.NoError(t, err)
- tr = newTransfer(baseTransfer, nil, nil, errRead)
- _, err = tr.ReadAt(buf, 0)
- assert.EqualError(t, err, errRead.Error())
- err = tr.Close()
- assert.NoError(t, err)
- err = os.Remove(fsPath)
- assert.NoError(t, err)
- assert.Len(t, connection.GetTransfers(), 0)
- }
- func TestConnectionStatusStruct(t *testing.T) {
- var transfers []common.ConnectionTransfer
- transferUL := common.ConnectionTransfer{
- OperationType: "upload",
- StartTime: util.GetTimeAsMsSinceEpoch(time.Now()),
- Size: 123,
- VirtualPath: "/test.upload",
- }
- transferDL := common.ConnectionTransfer{
- OperationType: "download",
- StartTime: util.GetTimeAsMsSinceEpoch(time.Now()),
- Size: 123,
- VirtualPath: "/test.download",
- }
- transfers = append(transfers, transferUL)
- transfers = append(transfers, transferDL)
- c := common.ConnectionStatus{
- Username: "test",
- ConnectionID: "123",
- ClientVersion: "fakeClient-1.0.0",
- RemoteAddress: "127.0.0.1:1234",
- ConnectionTime: util.GetTimeAsMsSinceEpoch(time.Now()),
- LastActivity: util.GetTimeAsMsSinceEpoch(time.Now()),
- Protocol: "SFTP",
- Transfers: transfers,
- }
- durationString := c.GetConnectionDuration()
- assert.NotEqual(t, 0, len(durationString))
- transfersString := c.GetTransfersAsString()
- assert.NotEqual(t, 0, len(transfersString))
- connInfo := c.GetConnectionInfo()
- assert.NotEqual(t, 0, len(connInfo))
- }
- func TestSupportedSecurityOptions(t *testing.T) {
- c := Configuration{
- KexAlgorithms: supportedKexAlgos,
- MACs: supportedMACs,
- Ciphers: supportedCiphers,
- }
- serverConfig := &ssh.ServerConfig{}
- err := c.configureSecurityOptions(serverConfig)
- assert.NoError(t, err)
- assert.Equal(t, supportedCiphers, serverConfig.Ciphers)
- assert.Equal(t, supportedMACs, serverConfig.MACs)
- assert.Equal(t, supportedKexAlgos, serverConfig.KeyExchanges)
- c.KexAlgorithms = append(c.KexAlgorithms, "not a kex")
- err = c.configureSecurityOptions(serverConfig)
- assert.Error(t, err)
- c.KexAlgorithms = supportedKexAlgos
- c.MACs = []string{
- " hmac-sha2-256-etm@openssh.com ", "hmac-sha2-256",
- " hmac-sha2-512-etm@openssh.com", "hmac-sha2-512 ",
- "hmac-sha1 ", " hmac-sha1-96",
- }
- err = c.configureSecurityOptions(serverConfig)
- assert.NoError(t, err)
- assert.Equal(t, supportedCiphers, serverConfig.Ciphers)
- assert.Equal(t, supportedMACs, serverConfig.MACs)
- assert.Equal(t, supportedKexAlgos, serverConfig.KeyExchanges)
- }
- func TestLoadModuli(t *testing.T) {
- dhGEXSha1 := "diffie-hellman-group-exchange-sha1"
- dhGEXSha256 := "diffie-hellman-group-exchange-sha256"
- c := Configuration{}
- c.Moduli = []string{".", "missing file"}
- err := c.loadModuli(configDir)
- assert.Error(t, err)
- assert.NotContains(t, supportedKexAlgos, dhGEXSha1)
- assert.NotContains(t, supportedKexAlgos, dhGEXSha256)
- assert.Len(t, supportedKexAlgos, 10)
- moduli := []byte("20220414072358 2 6 100 2047 5 F19C2D09AD49978F8A0C1B84168A4011A26F9CD516815934764A319FDC5975FA514AAF11B747D8CA6B3919532BEFB68FA118079473895674F3770F71FBB742F176883841EB3DE679BEF53C6AFE437A662F228B03C1E34B5A0D3909F608CEAA16C1F8131DE11E67878EFD918A89205E5E4DE323054010CA4711F25D466BB7727A016DD3F9F53BDBCE093055A4F2497ADEFB5A2500F9C5C3B0BCD88C6489F4C1CBC7CFB67BA6EABA0195794E4188CE9060F431041AD52FB9BAC4DF7FA536F585FBE67746CD57BFAD67567E9706C24D95C49BE95B759657C6BB5151E2AEA32F4CD557C40298A5C402101520EE8AAB8DFEED6FFC11AAF8036D6345923CFB5D1B922F")
- moduliFile := filepath.Join(os.TempDir(), "moduli")
- err = os.WriteFile(moduliFile, moduli, 0600)
- assert.NoError(t, err)
- c.Moduli = []string{moduliFile}
- err = c.loadModuli(configDir)
- assert.NoError(t, err)
- assert.Contains(t, supportedKexAlgos, dhGEXSha1)
- assert.Contains(t, supportedKexAlgos, dhGEXSha256)
- assert.Len(t, supportedKexAlgos, 12)
- err = os.Remove(moduliFile)
- assert.NoError(t, err)
- }
- func TestLoadHostKeys(t *testing.T) {
- serverConfig := &ssh.ServerConfig{}
- c := Configuration{}
- c.HostKeys = []string{".", "missing file"}
- err := c.checkAndLoadHostKeys(configDir, serverConfig)
- assert.Error(t, err)
- testfile := filepath.Join(os.TempDir(), "invalidkey")
- err = os.WriteFile(testfile, []byte("some bytes"), os.ModePerm)
- assert.NoError(t, err)
- c.HostKeys = []string{testfile}
- err = c.checkAndLoadHostKeys(configDir, serverConfig)
- assert.Error(t, err)
- err = os.Remove(testfile)
- assert.NoError(t, err)
- keysDir := filepath.Join(os.TempDir(), "keys")
- err = os.MkdirAll(keysDir, os.ModePerm)
- assert.NoError(t, err)
- rsaKeyName := filepath.Join(keysDir, defaultPrivateRSAKeyName)
- ecdsaKeyName := filepath.Join(keysDir, defaultPrivateECDSAKeyName)
- ed25519KeyName := filepath.Join(keysDir, defaultPrivateEd25519KeyName)
- nonDefaultKeyName := filepath.Join(keysDir, "akey")
- c.HostKeys = []string{nonDefaultKeyName, rsaKeyName, ecdsaKeyName, ed25519KeyName}
- err = c.checkAndLoadHostKeys(configDir, serverConfig)
- assert.Error(t, err)
- c.HostKeyAlgorithms = []string{ssh.KeyAlgoRSASHA256}
- c.HostKeys = []string{ecdsaKeyName}
- err = c.checkAndLoadHostKeys(configDir, serverConfig)
- assert.Error(t, err)
- c.HostKeyAlgorithms = preferredHostKeyAlgos
- err = c.checkAndLoadHostKeys(configDir, serverConfig)
- assert.NoError(t, err)
- assert.FileExists(t, rsaKeyName)
- assert.FileExists(t, ecdsaKeyName)
- assert.FileExists(t, ed25519KeyName)
- assert.NoFileExists(t, nonDefaultKeyName)
- err = os.Remove(rsaKeyName)
- assert.NoError(t, err)
- err = os.Remove(ecdsaKeyName)
- assert.NoError(t, err)
- err = os.Remove(ed25519KeyName)
- assert.NoError(t, err)
- if runtime.GOOS != osWindows {
- err = os.Chmod(keysDir, 0551)
- assert.NoError(t, err)
- c.HostKeys = nil
- err = c.checkAndLoadHostKeys(keysDir, serverConfig)
- assert.Error(t, err)
- c.HostKeys = []string{rsaKeyName, ecdsaKeyName}
- err = c.checkAndLoadHostKeys(configDir, serverConfig)
- assert.Error(t, err)
- c.HostKeys = []string{ecdsaKeyName, rsaKeyName}
- err = c.checkAndLoadHostKeys(configDir, serverConfig)
- assert.Error(t, err)
- c.HostKeys = []string{ed25519KeyName}
- err = c.checkAndLoadHostKeys(configDir, serverConfig)
- assert.Error(t, err)
- err = os.Chmod(keysDir, 0755)
- assert.NoError(t, err)
- }
- err = os.RemoveAll(keysDir)
- assert.NoError(t, err)
- }
- func TestCertCheckerInitErrors(t *testing.T) {
- c := Configuration{}
- c.TrustedUserCAKeys = []string{".", "missing file"}
- err := c.initializeCertChecker("")
- assert.Error(t, err)
- testfile := filepath.Join(os.TempDir(), "invalidkey")
- err = os.WriteFile(testfile, []byte("some bytes"), os.ModePerm)
- assert.NoError(t, err)
- c.TrustedUserCAKeys = []string{testfile}
- err = c.initializeCertChecker("")
- assert.Error(t, err)
- err = os.Remove(testfile)
- assert.NoError(t, err)
- }
- func TestRecursiveCopyErrors(t *testing.T) {
- permissions := make(map[string][]string)
- permissions["/"] = []string{dataprovider.PermAny}
- user := dataprovider.User{
- BaseUser: sdk.BaseUser{
- Permissions: permissions,
- HomeDir: os.TempDir(),
- },
- }
- fs, err := user.GetFilesystem("123")
- assert.NoError(t, err)
- conn := &Connection{
- BaseConnection: common.NewBaseConnection("", common.ProtocolSFTP, "", "", user),
- }
- sshCmd := sshCommand{
- command: "sftpgo-copy",
- connection: conn,
- args: []string{"adir", "another"},
- }
- // try to copy a missing directory
- sshCmd.connection.User.Permissions["/another"] = []string{
- dataprovider.PermCreateDirs,
- dataprovider.PermCreateSymlinks,
- dataprovider.PermListItems,
- }
- err = sshCmd.checkRecursiveCopyPermissions(fs, fs, "adir", "another/sub", "/adir", "/another/sub")
- assert.Error(t, err)
- sshCmd.connection.User.Permissions["/another"] = []string{
- dataprovider.PermListItems,
- dataprovider.PermCreateDirs,
- }
- err = sshCmd.checkRecursiveCopyPermissions(fs, fs, "adir", "another", "/adir/sub", "/another/sub/dir")
- assert.Error(t, err)
- }
- func TestSFTPSubSystem(t *testing.T) {
- permissions := make(map[string][]string)
- permissions["/"] = []string{dataprovider.PermAny}
- user := &dataprovider.User{
- BaseUser: sdk.BaseUser{
- Permissions: permissions,
- HomeDir: os.TempDir(),
- },
- }
- user.FsConfig.Provider = sdk.AzureBlobFilesystemProvider
- err := ServeSubSystemConnection(user, "connID", nil, nil)
- assert.Error(t, err)
- user.FsConfig.Provider = sdk.LocalFilesystemProvider
- buf := make([]byte, 0, 4096)
- stdErrBuf := make([]byte, 0, 4096)
- mockSSHChannel := &MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- }
- // this is 327680 and it will result in packet too long error
- _, err = mockSSHChannel.Write([]byte{0x00, 0x05, 0x00, 0x00, 0x00, 0x00})
- assert.NoError(t, err)
- err = ServeSubSystemConnection(user, "id", mockSSHChannel, mockSSHChannel)
- assert.EqualError(t, err, "packet too long")
- subsystemChannel := newSubsystemChannel(mockSSHChannel, mockSSHChannel)
- n, err := subsystemChannel.Write([]byte{0x00})
- assert.NoError(t, err)
- assert.Equal(t, n, 1)
- err = subsystemChannel.Close()
- assert.NoError(t, err)
- }
- func TestRecoverer(t *testing.T) {
- c := Configuration{}
- c.AcceptInboundConnection(nil, nil)
- connID := "connectionID"
- connection := &Connection{
- BaseConnection: common.NewBaseConnection(connID, common.ProtocolSFTP, "", "", dataprovider.User{}),
- }
- c.handleSftpConnection(nil, connection)
- sshCmd := sshCommand{
- command: "cd",
- connection: connection,
- }
- err := sshCmd.handle()
- assert.EqualError(t, err, common.ErrGenericFailure.Error())
- scpCmd := scpCommand{
- sshCommand: sshCommand{
- command: "scp",
- connection: connection,
- },
- }
- err = scpCmd.handle()
- assert.EqualError(t, err, common.ErrGenericFailure.Error())
- assert.Len(t, common.Connections.GetStats(), 0)
- }
- func TestListernerAcceptErrors(t *testing.T) {
- errFake := errors.New("a fake error")
- listener := newFakeListener(errFake)
- c := Configuration{}
- err := c.serve(listener, nil)
- require.EqualError(t, err, errFake.Error())
- err = listener.Close()
- require.NoError(t, err)
- errNetFake := &fakeNetError{error: errFake}
- listener = newFakeListener(errNetFake)
- err = c.serve(listener, nil)
- require.EqualError(t, err, errFake.Error())
- err = listener.Close()
- require.NoError(t, err)
- }
- type fakeNetError struct {
- error
- count int
- }
- func (e *fakeNetError) Timeout() bool {
- return false
- }
- func (e *fakeNetError) Temporary() bool {
- e.count++
- return e.count < 10
- }
- func (e *fakeNetError) Error() string {
- return e.error.Error()
- }
- type fakeListener struct {
- server net.Conn
- client net.Conn
- err error
- }
- func (l *fakeListener) Accept() (net.Conn, error) {
- return l.client, l.err
- }
- func (l *fakeListener) Close() error {
- errClient := l.client.Close()
- errServer := l.server.Close()
- if errServer != nil {
- return errServer
- }
- return errClient
- }
- func (l *fakeListener) Addr() net.Addr {
- return l.server.LocalAddr()
- }
- func newFakeListener(err error) net.Listener {
- server, client := net.Pipe()
- return &fakeListener{
- server: server,
- client: client,
- err: err,
- }
- }
- func TestFolderPrefix(t *testing.T) {
- c := Configuration{
- FolderPrefix: "files",
- }
- c.checkFolderPrefix()
- assert.Equal(t, "/files", c.FolderPrefix)
- c.FolderPrefix = ""
- c.checkFolderPrefix()
- assert.Empty(t, c.FolderPrefix)
- c.FolderPrefix = "/"
- c.checkFolderPrefix()
- assert.Empty(t, c.FolderPrefix)
- c.FolderPrefix = "/."
- c.checkFolderPrefix()
- assert.Empty(t, c.FolderPrefix)
- c.FolderPrefix = "."
- c.checkFolderPrefix()
- assert.Empty(t, c.FolderPrefix)
- c.FolderPrefix = ".."
- c.checkFolderPrefix()
- assert.Empty(t, c.FolderPrefix)
- }
- func TestLoadRevokedUserCertsFile(t *testing.T) {
- r := revokedCertificates{
- certs: map[string]bool{},
- }
- err := r.load()
- assert.NoError(t, err)
- r.filePath = filepath.Join(os.TempDir(), "sub", "testrevoked")
- err = os.MkdirAll(filepath.Dir(r.filePath), os.ModePerm)
- assert.NoError(t, err)
- err = os.WriteFile(r.filePath, []byte(`no json`), 0644)
- assert.NoError(t, err)
- err = r.load()
- assert.Error(t, err)
- r.filePath = filepath.Dir(r.filePath)
- err = r.load()
- assert.Error(t, err)
- err = os.RemoveAll(r.filePath)
- assert.NoError(t, err)
- }
- func TestMaxUserSessions(t *testing.T) {
- connection := &Connection{
- BaseConnection: common.NewBaseConnection(xid.New().String(), common.ProtocolSFTP, "", "", dataprovider.User{
- BaseUser: sdk.BaseUser{
- Username: "user_max_sessions",
- HomeDir: filepath.Clean(os.TempDir()),
- MaxSessions: 1,
- },
- }),
- }
- err := common.Connections.Add(connection)
- assert.NoError(t, err)
- c := Configuration{}
- c.handleSftpConnection(nil, connection)
- sshCmd := sshCommand{
- command: "cd",
- connection: connection,
- }
- err = sshCmd.handle()
- if assert.Error(t, err) {
- assert.Contains(t, err.Error(), "too many open sessions")
- }
- scpCmd := scpCommand{
- sshCommand: sshCommand{
- command: "scp",
- connection: connection,
- },
- }
- err = scpCmd.handle()
- if assert.Error(t, err) {
- assert.Contains(t, err.Error(), "too many open sessions")
- }
- err = ServeSubSystemConnection(&connection.User, connection.ID, nil, nil)
- if assert.Error(t, err) {
- assert.Contains(t, err.Error(), "too many open sessions")
- }
- common.Connections.Remove(connection.GetID())
- assert.Len(t, common.Connections.GetStats(), 0)
- }
- func TestCanReadSymlink(t *testing.T) {
- connection := &Connection{
- BaseConnection: common.NewBaseConnection(xid.New().String(), common.ProtocolSFTP, "", "", dataprovider.User{
- BaseUser: sdk.BaseUser{
- Username: "user_can_read_symlink",
- HomeDir: filepath.Clean(os.TempDir()),
- Permissions: map[string][]string{
- "/": {dataprovider.PermAny},
- "/sub": {dataprovider.PermUpload},
- },
- },
- Filters: dataprovider.UserFilters{
- BaseUserFilters: sdk.BaseUserFilters{
- FilePatterns: []sdk.PatternsFilter{
- {
- Path: "/denied",
- DeniedPatterns: []string{"*.txt"},
- DenyPolicy: sdk.DenyPolicyHide,
- },
- },
- },
- },
- }),
- }
- err := connection.canReadLink("/sub/link")
- assert.ErrorIs(t, err, sftp.ErrSSHFxPermissionDenied)
- err = connection.canReadLink("/denied/file.txt")
- assert.ErrorIs(t, err, sftp.ErrSSHFxNoSuchFile)
- }
- func TestAuthenticationErrors(t *testing.T) {
- loginMethod := dataprovider.SSHLoginMethodPassword
- err := newAuthenticationError(fmt.Errorf("cannot validate credentials: %w", util.NewRecordNotFoundError("not found")), loginMethod)
- assert.ErrorIs(t, err, sftpAuthError)
- assert.ErrorIs(t, err, util.ErrNotFound)
- var sftpAuthErr *authenticationError
- if assert.ErrorAs(t, err, &sftpAuthErr) {
- assert.Equal(t, loginMethod, sftpAuthErr.getLoginMethod())
- }
- err = newAuthenticationError(fmt.Errorf("cannot validate credentials: %w", fs.ErrPermission), loginMethod)
- assert.ErrorIs(t, err, sftpAuthError)
- assert.NotErrorIs(t, err, util.ErrNotFound)
- err = newAuthenticationError(fmt.Errorf("cert has wrong type %d", ssh.HostCert), loginMethod)
- assert.ErrorIs(t, err, sftpAuthError)
- assert.NotErrorIs(t, err, util.ErrNotFound)
- err = newAuthenticationError(errors.New("ssh: certificate signed by unrecognized authority"), loginMethod)
- assert.ErrorIs(t, err, sftpAuthError)
- assert.NotErrorIs(t, err, util.ErrNotFound)
- err = newAuthenticationError(nil, loginMethod)
- assert.ErrorIs(t, err, sftpAuthError)
- assert.NotErrorIs(t, err, util.ErrNotFound)
- }
|