root
/
sftp
mirror of https://github.com/pkg/sftp.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity
355 Commits 14 Branches 34 Tags 4 MiB
Go 99.8%
Makefile 0.2%
Go to file
John Eikenberry 15c875477a add remove and realpath handling 2017-02-18 18:20:36 -08:00
examples make example server respect readOnly flag (#108) 2016-05-31 11:05:26 +10:00
server_standalone add serverside StatVFS function, implemented for darwin and linux (#89) 2016-06-13 14:45:13 +10:00
.gitignore Created working example SFTP server 2015-11-07 19:21:42 +00:00
.travis.yml Remove workaround for crypto bug 18861 2017-02-06 15:10:58 -08:00
CONTRIBUTORS Adding myself as I'm helping out 2017-01-06 17:20:11 -08:00
LICENSE Rename LICENCE to LICENSE 2014-10-27 21:31:41 +00:00
README.md small note to help set expectations for contributions 2017-01-07 12:20:37 -08:00
attrs.go *: golint: add and fix up comments on exported types 2016-01-07 15:16:34 -05:00
attrs_stubs.go add windows as a build target to _stubs.go files 2015-09-19 19:16:50 -07:00
attrs_test.go *: golint (part 1) 2016-01-07 12:10:24 -05:00
attrs_unix.go *: golint (part 1) 2016-01-07 12:10:24 -05:00
client.go Fix deadlock issue in client Read and WriteTo 2017-02-13 17:36:29 -08:00
client_integration_darwin_test.go Do not check bavail, it can change in a shared CI environment 2016-06-15 20:02:28 +10:00
client_integration_linux_test.go vet: formatting directive in Fatal call 2016-09-22 16:33:00 -07:00
client_integration_test.go ported Glob method from filepath - https://golang.org/pkg/path/filepath/#Glob 2017-02-18 14:26:32 -08:00
client_test.go Make SSH_FXP_STATUS "message" field optional. 2017-02-05 14:53:51 -08:00
conn.go Tests to replicate deadlock bug in Write/ReadFrom 2017-02-13 00:32:33 -08:00
debug.go added debug option, build/test with -tags debug to activate 2014-09-28 12:32:34 +10:00
example_test.go vet: Example should be niladic 2016-09-22 16:37:25 -07:00
match.go ported Glob method from filepath - https://golang.org/pkg/path/filepath/#Glob 2017-02-18 14:26:32 -08:00
other_test.go Handle osx returning EPERM not ENOTDIR 2015-12-22 13:34:21 +09:00
packet.go Always close client conn when clientConn.recv exits (#117) 2016-06-15 20:04:26 +10:00
packet_test.go packet, server: use a single read-only check 2016-01-11 11:50:10 -05:00
release.go added debug option, build/test with -tags debug to activate 2014-09-28 12:32:34 +10:00
request-interfaces.go better interface naming consistency 2017-02-18 18:20:36 -08:00
request-packet.go isOpener interface to simplify type checking/testing 2017-02-18 18:20:36 -08:00
request-server.go remove redundant 'request' from handle method name 2017-02-18 18:20:36 -08:00
request-server_test.go variable name fix 2017-02-18 18:20:36 -08:00
request.go add remove and realpath handling 2017-02-18 18:20:36 -08:00
request_test.go remove redundant 'request' from handle method name 2017-02-18 18:20:36 -08:00
server.go Integrate readPacket and writePacket into handlePacket (#120) 2016-06-15 21:17:20 +10:00
server_integration_test.go General server cleanups (#103) 2016-05-29 16:32:05 +10:00
server_statvfs_darwin.go add serverside StatVFS function, implemented for darwin and linux (#89) 2016-06-13 14:45:13 +10:00
server_statvfs_impl.go Fix build directive to properly compile under gccgo in Linux (#126) 2016-07-22 09:14:53 +10:00
server_statvfs_linux.go Remove reference to X__val (#142) 2016-10-01 08:07:58 +10:00
server_statvfs_stubs.go Skip statvfs impl on linux if using gccgo (#122) 2016-06-22 13:17:59 +10:00
server_stubs.go add windows as a build target to _stubs.go files 2015-09-19 19:16:50 -07:00
server_test.go remove debugging dreg from fc30a3e 2016-06-15 20:15:49 +10:00
server_unix.go add more tests; bug setting S_IFREG caused openssh sftp to refuse to get the file 2015-09-08 17:03:18 -07:00
sftp.go Use pkg/errors for error handling (#101) 2016-05-19 15:16:48 +10:00

README.md

sftp

The sftp package provides support for file system operations on remote ssh servers using the SFTP subsystem. It also implements an SFTP server for serving files from the filesystem.

UNIX Build Status GoDoc

usage and examples

See godoc.org/github.com/pkg/sftp for examples and usage.

The basic operation of the package mirrors the facilities of the os package.

The Walker interface for directory traversal is heavily inspired by Keith Rarick's fs package.

roadmap

  • There is way too much duplication in the Client methods. If there was an unmarshal(interface{}) method this would reduce a heap of the duplication.

contributing

We welcome pull requests, bug fixes and issue reports.

Before proposing a large change, first please discuss your change by raising an issue.

For API/code bugs, please include a small, self contained code example to reproduce the issue. For pull requests, remember test coverage.

We handle issues and pull requests with a 0 open philosophy. That means we will try to address the submission as soon as possible and will work toward a resolution. If progress can no longer be made (eg. unreproducible bug) or stops (eg. unresponsive submitter), we will close the bug.

Please remember that we don't have infinite time and so it is a good guideline that the less time it takes us to work with you on your idea/issue the greater the chance we will have the time to do it.

Thanks.