root
/
sftp
mirror of https://github.com/pkg/sftp.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity
582 Commits 14 Branches 34 Tags 4 MiB
Go 99.8%
Makefile 0.2%
Go to file
John Eikenberry 2d92cdcf8c Merge branch 'sigmonsays-fix-fsetstat' 2018-05-10 16:12:12 -07:00
examples Fix #182; use ssh connection meta-data in example 2017-06-29 14:49:54 -07:00
server_standalone server_standalone: handle readonly properly 2017-03-15 12:45:09 -07:00
.gitignore ignore test keys in all examples 2017-06-29 14:48:40 -07:00
.travis.yml update travis for go 1.10 release 2018-03-04 17:19:02 -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 soften contrib text a bit 2017-04-25 15:30:31 -07:00
attrs.go a few code simplifications 2018-02-15 11:17:19 -08: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 Client.MkdirAll - mimic os.MkdirAll code for consistency & perf 2018-04-25 08:13:19 -07: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 Client.MkdirAll - mimic os.MkdirAll code for consistency & perf 2018-04-25 08:13:19 -07:00
client_test.go Allow the use of packets smaller than 32768 bytes, and add MaxPacketChecked/Unchecked client options to prevent developers from accidentally using larger, potentially incompatible sizes. 2018-02-22 14:05:13 -08:00
conn.go set inflight chan buffer to 2 for deadlock 2018-02-06 16:43:44 -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 Add example about ReadFrom + bufio interaction 2018-01-11 18:24:04 -08:00
match.go Fixes #188; eliminates duplicated core code 2017-07-20 15:28:11 -07:00
other_test.go Handle osx returning EPERM not ENOTDIR 2015-12-22 13:34:21 +09:00
packet-manager.go drop support for go versions <= 1.7 2018-01-25 17:44:22 -08:00
packet-manager_test.go Remove bad test 2018-03-03 18:32:05 -08:00
packet-typing.go Send unsupported error on extended packets. 2018-03-19 10:32:22 -04:00
packet.go Send unsupported error on extended packets. 2018-03-19 10:32:22 -04: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-attrs.go add helper methods for request flags/attrs data 2018-01-09 15:31:54 -08:00
request-attrs_test.go add helper methods for request flags/attrs data 2018-01-09 15:31:54 -08:00
request-errors.go support handlers returning explicit error codes 2018-01-26 17:26:44 -08:00
request-example.go a few code simplifications 2018-02-15 11:17:19 -08:00
request-interfaces.go handler type documenation improvements 2018-01-16 14:42:06 -08:00
request-readme.md update Request structure docs for path and flag changes 2018-01-04 13:30:43 -08:00
request-server.go Handle RequestServer the same 2018-03-19 11:53:13 -04:00
request-server_test.go unused variables in tests 2018-02-15 10:28:06 -08:00
request-unix.go Revert "rename files with OS specific request test code" 2017-03-01 20:54:40 -08:00
request.go set flags and attrs for fsetstat packet type in filecmd 2018-05-10 16:09:50 -07:00
request_test.go better/clearer function name 2018-03-10 12:51:41 -08:00
request_windows.go Revert "rename files with OS specific request test code" 2017-03-01 20:54:40 -08:00
server.go Send unsupported error on extended packets. 2018-03-19 10:32:22 -04:00
server_integration_test.go a few code simplifications 2018-02-15 11:17:19 -08: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 Remove gccgo special cases 2018-02-02 15:01:09 -05:00
server_statvfs_linux.go Remove gccgo special cases 2018-02-02 15:01:09 -05:00
server_statvfs_stubs.go Remove gccgo special cases 2018-02-02 15:01:09 -05:00
server_stubs.go Changed default user and group to root and count links for directories to 0 on non *nix systems 2017-08-10 12:10:05 +02:00
server_test.go Send unsupported error on extended packets. 2018-03-19 10:32:22 -04:00
server_unix.go improve previous commit's user/group lookups 2018-04-23 15:35:48 -07:00
sftp.go use ietf link for sftp spec everywhere 2017-10-01 17:55:39 -07: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 try to 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.

Thanks.