Go to file
Cassondra Foesch aad3ee1c0e an even better error message 2022-07-11 11:34:22 +00:00
.github/workflows CI: race is not supported on 386 arch 2021-09-27 12:00:28 +02:00
examples Apply gofmt 2021-08-20 21:32:22 +02:00
internal/encoding/ssh/filexfer Remove unreachable and duplicated return statement 2022-03-30 09:17:11 +00:00
server_standalone server_standalone: handle readonly properly 2017-03-15 12:45:09 -07:00
.gitignore split benchmark and benchmark_w_memprofile, include memprofile files to gitignore 2021-03-17 20:17:15 +00: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
Makefile split benchmark and benchmark_w_memprofile, include memprofile files to gitignore 2021-03-17 20:17:15 +00:00
README.md update documentation links 2021-01-20 13:52:30 +01:00
allocator.go the allocator can now be enabled per request 2020-03-18 09:36:07 +01:00
allocator_test.go the allocator can now be enabled per request 2020-03-18 09:36:07 +01:00
attrs.go exploit the embedded FileStat in fileInfo 2021-08-11 13:20:30 +00:00
attrs_stubs.go no need for excluding based on CGO here 2021-08-11 13:11:37 +00:00
attrs_test.go collect all marshal/unmarshal functions into packet.go 2021-08-11 11:12:34 +00:00
attrs_unix.go js's Stat_t conforms to attrs_unix.go 2021-08-11 15:11:37 +00:00
client.go an even better error message 2022-07-11 11:34:22 +00:00
client_integration_darwin_test.go fix lint issues 2019-08-30 17:04:37 +02:00
client_integration_linux_test.go New method Client.Extensions to list server extensions 2020-10-23 11:16:44 +02:00
client_integration_test.go writeToSequential: improve tests for write errors 2022-03-03 12:30:24 +01:00
client_test.go collect all marshal/unmarshal functions into packet.go 2021-08-11 11:12:34 +00:00
conn.go more context for EOF during client setup 2022-06-29 12:13:03 +00:00
debug.go added debug option, build/test with -tags debug to activate 2014-09-28 12:32:34 +10:00
example_test.go Improve benchmarks and errors 2021-03-17 11:03:51 +00:00
fuzz.go really fix the fuzzer 2021-03-23 21:47:04 +01:00
go.mod update deps 2021-12-17 09:10:48 +01:00
go.sum update deps 2021-12-17 09:10:48 +01:00
ls_formatting.go NameLookupFileLister so that RequestServer does not automatically lookup system usernames 2021-08-17 11:40:30 +00:00
ls_formatting_test.go NameLookupFileLister so that RequestServer does not automatically lookup system usernames 2021-08-17 11:40:30 +00:00
ls_plan9.go NameLookupFileLister so that RequestServer does not automatically lookup system usernames 2021-08-17 11:40:30 +00:00
ls_stub.go refactor ls formatting work 2021-08-11 15:09:43 +00:00
ls_unix.go NameLookupFileLister so that RequestServer does not automatically lookup system usernames 2021-08-17 11:40:30 +00:00
match.go Fix Glob handling of backslashes 2021-03-15 18:11:02 +01:00
packet-manager.go pack structures so they have less size 2020-09-08 10:18:15 +02:00
packet-manager_test.go MarshalBinary now gives a 4-byte header for length, marshalPacket gives a two-stage write 2021-02-22 12:04:43 +00:00
packet-typing.go Use go errors instead of github.com/pkg/errors 2021-06-04 14:18:41 -07:00
packet.go PosixRename, Hardlink: need to convert remote paths to local paths 2022-01-31 21:12:05 +00:00
packet_test.go collect all marshal/unmarshal functions into packet.go 2021-08-11 11:12:34 +00:00
pool.go actually, why not a better safe-guard 2021-07-02 08:49:51 +00:00
release.go added debug option, build/test with -tags debug to activate 2014-09-28 12:32:34 +10:00
request-attrs.go collect all marshal/unmarshal functions into packet.go 2021-08-11 11:12:34 +00:00
request-attrs_test.go collect all marshal/unmarshal functions into packet.go 2021-08-11 11:12:34 +00:00
request-errors.go Lowercase error messages 2021-03-20 20:35:04 +01:00
request-example.go fix as per review 2021-04-27 18:06:39 +02:00
request-interfaces.go mark RealPathFileLister as deprecated 2022-03-02 18:44:54 +01:00
request-plan9.go deconvert encoded paths on windows servers 2021-06-29 15:16:15 +00:00
request-readme.md update Request structure docs for path and flag changes 2018-01-04 13:30:43 -08:00
request-server.go request server: add WithStartDirectory option 2022-03-02 18:33:41 +01:00
request-server_test.go request server: add WithStartDirectory option 2022-03-02 18:33:41 +01:00
request-unix.go deconvert encoded paths on windows servers 2021-06-29 15:16:15 +00:00
request.go request server: add WithStartDirectory option 2022-03-02 18:33:41 +01:00
request_test.go cleanup request mutex usage 2021-08-02 11:23:37 +00:00
request_windows.go deconvert encoded paths on windows servers 2021-06-29 15:16:15 +00:00
server.go NameLookupFileLister so that RequestServer does not automatically lookup system usernames 2021-08-17 11:40:30 +00:00
server_integration_test.go remove racing stdout 2022-01-31 21:25:18 +00: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 missing ID passthru on statfs 2021-09-05 02:35:25 +00:00
server_statvfs_linux.go Remove gccgo special cases 2018-02-02 15:01:09 -05:00
server_statvfs_plan9.go pointer receivers and statusFromError(uint32, error) 2021-02-22 12:11:42 +00:00
server_statvfs_stubs.go pointer receivers and statusFromError(uint32, error) 2021-02-22 12:11:42 +00:00
server_test.go refactor ls formatting work 2021-08-11 15:09:43 +00:00
sftp.go Use go errors instead of github.com/pkg/errors 2021-06-04 14:18:41 -07:00
sftp_test.go Check for two more errors in tests 2021-08-20 21:27:27 +02:00
stat_plan9.go resolve corner-case os.ModeType handling 2021-08-11 13:10:07 +00:00
stat_posix.go Translate EACCES to PERMISSION_DENIED. 2021-10-30 09:02:56 +02:00
syscall_fixed.go fix S_IFMT value on windows and plan9 2020-01-02 12:59:24 -08:00
syscall_good.go fix S_IFMT value on windows and plan9 2020-01-02 12:59:24 -08: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.

CI Status Go Reference

usage and examples

See https://pkg.go.dev/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.