| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844 |
- // Copyright (C) 2019 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"
- "slices"
- "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(_ string, _ bool, _ []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
- }
- // IsConditionalUploadResumeSupported returns if resuming uploads is supported
- // for the specified size
- func (MockOsFs) IsConditionalUploadResumeSupported(_ int64) 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, _ 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, _ int) (int, int64, error) {
- if fs.err != nil {
- return -1, -1, fs.err
- }
- err := os.Rename(source, target)
- return -1, -1, err
- }
- func newMockOsFs(err, statErr error, atomicUpload bool, connectionID, rootDir string) vfs.Fs {
- return &MockOsFs{
- Fs: vfs.NewOsFs(connectionID, rootDir, "", nil),
- 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(), "", nil)
- 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(), "", nil)
- 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, vfs.NewPipeReader(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)
- assert.Equal(t, int32(0), common.Connections.GetTotalTransfers())
- }
- 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(), "", nil)
- 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(), "", nil)
- 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, slices.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")
- 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
- _, err = cmd.connection.User.GetFilesystem("123")
- assert.NoError(t, err)
- 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")
- 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())
- }
- 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{},
- }
- err := cmd.handleSFTPGoCopy()
- assert.Error(t, err)
- cmd = sshCommand{
- command: "sftpgo-remove",
- connection: connection,
- args: []string{},
- }
- err = cmd.handleSFTPGoRemove()
- assert.Error(t, err)
- }
- 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.handleSFTPGoCopy()
- assert.Error(t, err)
- err = os.RemoveAll(user.GetHomeDir())
- assert.NoError(t, err)
- }
- func TestCommandGetFsError(t *testing.T) {
- user := dataprovider.User{
- FsConfig: vfs.Filesystem{
- Provider: sdk.CryptedFilesystemProvider,
- },
- }
- 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 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(), "", nil)
- 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())
- }
- mockSSHChannel = MockChannel{
- Buffer: bytes.NewBuffer(respBuffer),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- WriteError: writeErr,
- }
- scpCommand.connection.channel = &mockSSHChannel
- err = scpCommand.downloadDirs(nil, nil)
- assert.ErrorIs(t, err, writeErr)
- }
- 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(), "", nil)
- 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(), "", nil)
- 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(), "", nil)
- 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())
- }
- transfer.Connection.RemoveTransfer(transfer)
- mockSSHChannel = MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- ReadError: nil,
- WriteError: nil,
- }
- transfer.Connection.AddTransfer(transfer)
- err = scpCommand.getUploadFileData(2, transfer)
- assert.ErrorContains(t, err, os.ErrClosed.Error())
- transfer.Connection.RemoveTransfer(transfer)
- err = os.Remove(testfile)
- assert.NoError(t, err)
- assert.Equal(t, int32(0), common.Connections.GetTotalTransfers())
- }
- func TestUploadError(t *testing.T) {
- common.Config.UploadMode = common.UploadModeAtomic
- user := dataprovider.User{
- BaseUser: sdk.BaseUser{
- Username: "testuser",
- },
- }
- fs := vfs.NewOsFs("", os.TempDir(), "", nil)
- 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.ErrorIs(t, err, sftp.ErrSSHFxOpUnsupported)
- 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, vfs.NewPipeReader(r), errRead)
- _, err = tr.ReadAt(buf, 0)
- assert.ErrorIs(t, err, sftp.ErrSSHFxFailure)
- err = tr.Close()
- assert.NoError(t, err)
- tr = newTransfer(baseTransfer, nil, nil, errRead)
- _, err = tr.ReadAt(buf, 0)
- assert.ErrorIs(t, err, sftp.ErrSSHFxFailure)
- err = tr.Close()
- assert.NoError(t, err)
- err = os.Remove(fsPath)
- assert.NoError(t, err)
- assert.Len(t, connection.GetTransfers(), 0)
- }
- func TestConfigsFromProvider(t *testing.T) {
- err := dataprovider.UpdateConfigs(nil, "", "", "")
- assert.NoError(t, err)
- c := Configuration{}
- err = c.loadFromProvider()
- assert.NoError(t, err)
- assert.Len(t, c.HostKeyAlgorithms, 0)
- assert.Len(t, c.KexAlgorithms, 0)
- assert.Len(t, c.Ciphers, 0)
- assert.Len(t, c.MACs, 0)
- assert.Len(t, c.PublicKeyAlgorithms, 0)
- configs := dataprovider.Configs{
- SFTPD: &dataprovider.SFTPDConfigs{
- HostKeyAlgos: []string{ssh.KeyAlgoRSA},
- KexAlgorithms: []string{ssh.InsecureKeyExchangeDHGEXSHA1},
- Ciphers: []string{ssh.InsecureCipherAES128CBC},
- MACs: []string{ssh.HMACSHA512ETM},
- PublicKeyAlgos: []string{ssh.InsecureKeyAlgoDSA}, //nolint:staticcheck
- },
- }
- err = dataprovider.UpdateConfigs(&configs, "", "", "")
- assert.NoError(t, err)
- err = c.loadFromProvider()
- assert.NoError(t, err)
- expectedHostKeyAlgos := append(preferredHostKeyAlgos, configs.SFTPD.HostKeyAlgos...)
- expectedKEXs := append(preferredKexAlgos, configs.SFTPD.KexAlgorithms...)
- expectedCiphers := append(preferredCiphers, configs.SFTPD.Ciphers...)
- expectedMACs := append(preferredMACs, configs.SFTPD.MACs...)
- expectedPublicKeyAlgos := append(preferredPublicKeyAlgos, configs.SFTPD.PublicKeyAlgos...)
- assert.Equal(t, expectedHostKeyAlgos, c.HostKeyAlgorithms)
- assert.Equal(t, expectedKEXs, c.KexAlgorithms)
- assert.Equal(t, expectedCiphers, c.Ciphers)
- assert.Equal(t, expectedMACs, c.MACs)
- assert.Equal(t, expectedPublicKeyAlgos, c.PublicKeyAlgorithms)
- err = dataprovider.UpdateConfigs(nil, "", "", "")
- assert.NoError(t, err)
- }
- func TestSupportedSecurityOptions(t *testing.T) {
- c := Configuration{
- KexAlgorithms: supportedKexAlgos,
- MACs: supportedMACs,
- Ciphers: supportedCiphers,
- }
- var defaultKexs []string
- for _, k := range supportedKexAlgos {
- defaultKexs = append(defaultKexs, k)
- if k == ssh.KeyExchangeCurve25519 {
- defaultKexs = append(defaultKexs, keyExchangeCurve25519SHA256LibSSH)
- }
- }
- 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, defaultKexs, serverConfig.KeyExchanges)
- c.KexAlgorithms = append(c.KexAlgorithms, "not a kex")
- err = c.configureSecurityOptions(serverConfig)
- assert.Error(t, err)
- c.KexAlgorithms = append(supportedKexAlgos, "diffie-hellman-group18-sha512")
- c.MACs = []string{
- " [email protected] ", " [email protected]",
- "hmac-sha2-256", "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, defaultKexs, serverConfig.KeyExchanges)
- }
- 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 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)
- assert.Equal(t, int32(0), common.Connections.GetTotalTransfers())
- }
- 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 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)
- buf := make([]byte, 65535)
- stdErrBuf := make([]byte, 65535)
- mockSSHChannel := MockChannel{
- Buffer: bytes.NewBuffer(buf),
- StdErrBuffer: bytes.NewBuffer(stdErrBuf),
- }
- conn := &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,
- },
- }),
- channel: &mockSSHChannel,
- }
- sshCmd := sshCommand{
- command: "cd",
- connection: conn,
- }
- err = sshCmd.handle()
- if assert.Error(t, err) {
- assert.Contains(t, err.Error(), "too many open sessions")
- }
- scpCmd := scpCommand{
- sshCommand: sshCommand{
- command: "scp",
- connection: conn,
- },
- }
- err = scpCmd.handle()
- 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)
- assert.Equal(t, int32(0), common.Connections.GetTotalTransfers())
- }
- 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
- username := "test user"
- err := newAuthenticationError(fmt.Errorf("cannot validate credentials: %w", util.NewRecordNotFoundError("not found")),
- loginMethod, username)
- 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())
- assert.Equal(t, username, sftpAuthErr.getUsername())
- }
- err = newAuthenticationError(fmt.Errorf("cannot validate credentials: %w", fs.ErrPermission), loginMethod, username)
- assert.ErrorIs(t, err, sftpAuthError)
- assert.NotErrorIs(t, err, util.ErrNotFound)
- err = newAuthenticationError(fmt.Errorf("cert has wrong type %d", ssh.HostCert), loginMethod, username)
- assert.ErrorIs(t, err, sftpAuthError)
- assert.NotErrorIs(t, err, util.ErrNotFound)
- err = newAuthenticationError(errors.New("ssh: certificate signed by unrecognized authority"), loginMethod, username)
- assert.ErrorIs(t, err, sftpAuthError)
- assert.NotErrorIs(t, err, util.ErrNotFound)
- err = newAuthenticationError(nil, loginMethod, username)
- assert.ErrorIs(t, err, sftpAuthError)
- assert.NotErrorIs(t, err, util.ErrNotFound)
- }
|