Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for working directory in Server #528

Merged
merged 12 commits into from
Oct 18, 2022
4 changes: 2 additions & 2 deletions packet.go
Original file line number Diff line number Diff line change
Expand Up @@ -1247,7 +1247,7 @@ func (p *sshFxpExtendedPacketPosixRename) UnmarshalBinary(b []byte) error {
}

func (p *sshFxpExtendedPacketPosixRename) respond(s *Server) responsePacket {
err := os.Rename(toLocalPath(p.Oldpath), toLocalPath(p.Newpath))
err := os.Rename(toLocalPath(s.workDir, p.Oldpath), toLocalPath(s.workDir, p.Newpath))
return statusFromError(p.ID, err)
}

Expand Down Expand Up @@ -1276,6 +1276,6 @@ func (p *sshFxpExtendedPacketHardlink) UnmarshalBinary(b []byte) error {
}

func (p *sshFxpExtendedPacketHardlink) respond(s *Server) responsePacket {
err := os.Link(toLocalPath(p.Oldpath), toLocalPath(p.Newpath))
err := os.Link(toLocalPath(s.workDir, p.Oldpath), toLocalPath(s.workDir, p.Newpath))
return statusFromError(p.ID, err)
}
6 changes: 5 additions & 1 deletion request-plan9.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,11 @@ func testOsSys(sys interface{}) error {
return nil
}

func toLocalPath(p string) string {
func toLocalPath(workDir, p string) string {
if workDir != "" && !path.IsAbs(p) {
p = path.Join(workDir, p)
}

lp := filepath.FromSlash(p)

if path.IsAbs(p) {
Expand Down
7 changes: 6 additions & 1 deletion request-unix.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ package sftp

import (
"errors"
"path"
"syscall"
)

Expand All @@ -22,6 +23,10 @@ func testOsSys(sys interface{}) error {
return nil
}

func toLocalPath(p string) string {
func toLocalPath(workDir, p string) string {
if workDir != "" && !path.IsAbs(p) {
p = path.Join(workDir, p)
}

return p
}
107 changes: 107 additions & 0 deletions request_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@ package sftp
import (
"bytes"
"errors"
"fmt"
"io"
"os"
"runtime"
"testing"

"github.com/stretchr/testify/assert"
Expand Down Expand Up @@ -247,3 +249,108 @@ func TestOpendirHandleReuse(t *testing.T) {
rpkt = request.call(handlers, pkt, nil, 0)
assert.IsType(t, &sshFxpNamePacket{}, rpkt)
}

func Test_toLocalPath(t *testing.T) {
type args struct {
workDir string
p string
}
tests := []struct {
name string
goos string
args args
want string
}{
{
name: "empty path",
args: args{p: ""},
want: "",
},
{
name: "relative path",
args: args{p: "file"},
want: "file",
},
{
name: "absolute path",
args: args{p: "/file"},
want: "/file",
},
{
name: "empty path",
goos: "linux",
args: args{workDir: "/home/user", p: ""},
want: "/home/user",
},
{
name: "relative path",
goos: "linux",
args: args{workDir: "/home/user", p: "file"},
want: "/home/user/file",
},
{
name: "relative path with .",
goos: "linux",
args: args{workDir: "/home/user", p: "."},
want: "/home/user",
},
{
name: "relative path with . and file",
goos: "linux",
args: args{workDir: "/home/user", p: "./file"},
want: "/home/user/file",
},
{
name: "absolute path",
goos: "linux",
args: args{workDir: "/home/user", p: "/file"},
want: "/file",
},
{
name: "empty path",
goos: "windows",
args: args{workDir: "C:\\Users\\User", p: ""},
want: "C:\\Users\\User",
},
{
name: "relative path",
goos: "windows",
args: args{workDir: "C:\\Users\\User", p: "file"},
want: "C:\\Users\\User\\file",
},
{
name: "relative path with .",
goos: "windows",
args: args{workDir: "C:\\Users\\User", p: "."},
want: "C:\\Users\\User",
},
{
name: "relative path with . and file",
goos: "windows",
args: args{workDir: "C:\\Users\\User", p: "./file"},
want: "C:\\Users\\User\\file",
},
{
name: "absolute path",
goos: "windows",
args: args{workDir: "C:\\Users\\User", p: "/C:/file"},
want: "C:\\file",
},
}
for _, tt := range tests {
var name string
if tt.goos == "" {
name = fmt.Sprintf("%s %s", tt.args.workDir, tt.name)
} else {
name = fmt.Sprintf("%s %s %s", tt.goos, tt.args.workDir, tt.name)
}
t.Run(name, func(t *testing.T) {
if tt.goos != "" && runtime.GOOS != tt.goos {
t.Skipf("Skipping test for %s on %s", tt.goos, runtime.GOOS)
}

workDir := cleanPath(tt.args.workDir)
assert.Equal(t, tt.want, toLocalPath(workDir, tt.args.p), "wrong local path")
})
}
}
6 changes: 5 additions & 1 deletion request_windows.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@ func testOsSys(sys interface{}) error {
return nil
}

func toLocalPath(p string) string {
func toLocalPath(workDir, p string) string {
if workDir != "" && !path.IsAbs(p) {
p = path.Join(workDir, p)
}

lp := filepath.FromSlash(p)

if path.IsAbs(p) {
Expand Down
40 changes: 26 additions & 14 deletions server.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ type Server struct {
openFiles map[string]*os.File
openFilesLock sync.RWMutex
handleCount int
workDir string
}

func (svr *Server) nextHandle(f *os.File) string {
Expand Down Expand Up @@ -128,6 +129,16 @@ func WithAllocator() ServerOption {
}
}

// WithServerWorkingDirectory sets a working directory to use as base
// for relative paths.
// If unset the default is current working directory (os.Getwd).
func WithServerWorkingDirectory(workDir string) ServerOption {
return func(s *Server) error {
s.workDir = cleanPath(workDir)
return nil
}
}

type rxPacket struct {
pktType fxp
pktBytes []byte
Expand Down Expand Up @@ -174,7 +185,7 @@ func handlePacket(s *Server, p orderedRequest) error {
}
case *sshFxpStatPacket:
// stat the requested file
info, err := os.Stat(toLocalPath(p.Path))
info, err := os.Stat(toLocalPath(s.workDir, p.Path))
rpkt = &sshFxpStatResponse{
ID: p.ID,
info: info,
Expand All @@ -184,7 +195,7 @@ func handlePacket(s *Server, p orderedRequest) error {
}
case *sshFxpLstatPacket:
// stat the requested file
info, err := os.Lstat(toLocalPath(p.Path))
info, err := os.Lstat(toLocalPath(s.workDir, p.Path))
rpkt = &sshFxpStatResponse{
ID: p.ID,
info: info,
Expand All @@ -208,24 +219,24 @@ func handlePacket(s *Server, p orderedRequest) error {
}
case *sshFxpMkdirPacket:
// TODO FIXME: ignore flags field
err := os.Mkdir(toLocalPath(p.Path), 0755)
err := os.Mkdir(toLocalPath(s.workDir, p.Path), 0o755)
rpkt = statusFromError(p.ID, err)
case *sshFxpRmdirPacket:
err := os.Remove(toLocalPath(p.Path))
err := os.Remove(toLocalPath(s.workDir, p.Path))
rpkt = statusFromError(p.ID, err)
case *sshFxpRemovePacket:
err := os.Remove(toLocalPath(p.Filename))
err := os.Remove(toLocalPath(s.workDir, p.Filename))
rpkt = statusFromError(p.ID, err)
case *sshFxpRenamePacket:
err := os.Rename(toLocalPath(p.Oldpath), toLocalPath(p.Newpath))
err := os.Rename(toLocalPath(s.workDir, p.Oldpath), toLocalPath(s.workDir, p.Newpath))
rpkt = statusFromError(p.ID, err)
case *sshFxpSymlinkPacket:
err := os.Symlink(toLocalPath(p.Targetpath), toLocalPath(p.Linkpath))
err := os.Symlink(toLocalPath(s.workDir, p.Targetpath), toLocalPath(s.workDir, p.Linkpath))
rpkt = statusFromError(p.ID, err)
case *sshFxpClosePacket:
rpkt = statusFromError(p.ID, s.closeHandle(p.Handle))
case *sshFxpReadlinkPacket:
f, err := os.Readlink(toLocalPath(p.Path))
f, err := os.Readlink(toLocalPath(s.workDir, p.Path))
rpkt = &sshFxpNamePacket{
ID: p.ID,
NameAttrs: []*sshFxpNameAttr{
Expand All @@ -240,7 +251,7 @@ func handlePacket(s *Server, p orderedRequest) error {
rpkt = statusFromError(p.ID, err)
}
case *sshFxpRealpathPacket:
f, err := filepath.Abs(toLocalPath(p.Path))
f, err := filepath.Abs(toLocalPath(s.workDir, p.Path))
f = cleanPath(f)
rpkt = &sshFxpNamePacket{
ID: p.ID,
Expand All @@ -256,13 +267,14 @@ func handlePacket(s *Server, p orderedRequest) error {
rpkt = statusFromError(p.ID, err)
}
case *sshFxpOpendirPacket:
p.Path = toLocalPath(p.Path)
lp := toLocalPath(s.workDir, p.Path)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There’s another p.Path that wasn’t replaced by lp in the &sshFxpOpenPacket packet. I’d probably recommend backing out the s/lp/p.Path/ change instead.

Less change, less chance of new bug.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I follow. The only other assignment to p.Path that I can find is in (*sshFxpSetstatPacket).respond.

This change was to prevent the following scenario: toLocalPath(s.workDir, toLocalPath(s.workDir, p.Path)) which happens in (*sshFxpOpenPacket).respond because of this assignment to p.Path. This becomes a problem when workDir is being used and we're not checking filepath.IsAbs, resulting in double workDir prefix on Windows and Plan 9.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ach so! You’re absolutely right. The toLocalPath really should be deferred in that case until the .respond happens. Nice bug catch!


if stat, err := os.Stat(p.Path); err != nil {
if stat, err := os.Stat(lp); err != nil {
rpkt = statusFromError(p.ID, err)
} else if !stat.IsDir() {
rpkt = statusFromError(p.ID, &os.PathError{
Path: p.Path, Err: syscall.ENOTDIR})
Path: lp, Err: syscall.ENOTDIR,
})
} else {
rpkt = (&sshFxpOpenPacket{
ID: p.ID,
Expand Down Expand Up @@ -446,7 +458,7 @@ func (p *sshFxpOpenPacket) respond(svr *Server) responsePacket {
osFlags |= os.O_EXCL
}

f, err := os.OpenFile(toLocalPath(p.Path), osFlags, 0644)
f, err := os.OpenFile(toLocalPath(svr.workDir, p.Path), osFlags, 0o644)
if err != nil {
return statusFromError(p.ID, err)
}
Expand Down Expand Up @@ -484,7 +496,7 @@ func (p *sshFxpSetstatPacket) respond(svr *Server) responsePacket {
b := p.Attrs.([]byte)
var err error

p.Path = toLocalPath(p.Path)
p.Path = toLocalPath(svr.workDir, p.Path)

debug("setstat name \"%s\"", p.Path)
if (p.Flags & sshFileXferAttrSize) != 0 {
Expand Down