Go to file
Cassondra Foesch 2d30c450c6
Merge pull request #633 from greatroar/dev-v2-errors
Don't translate StatusPacket to os.Err(NotExist|Permission)
2025-06-02 16:55:04 +00:00
.github/workflows update dependencies and CI versions 2025-04-01 14:01:16 +00:00
encoding/ssh/filexfer add debugging context to readPacket errors 2025-05-30 13:51:56 +00:00
examples iterators, golint, and internal packages, oh my\! 2024-11-12 15:37:31 +00:00
internal iterators, golint, and internal packages, oh my\! 2024-11-12 15:37:31 +00:00
localfs fix ssh subsystem request invocation 2025-05-23 17:34:44 +00:00
.gitignore xkcd.com/1022 2024-09-30 17:38:18 +00:00
CONTRIBUTORS xkcd.com/1022 2024-09-30 17:38:18 +00:00
LICENSE xkcd.com/1022 2024-09-30 17:38:18 +00:00
Makefile xkcd.com/1022 2024-09-30 17:38:18 +00:00
README.md xkcd.com/1022 2024-09-30 17:38:18 +00:00
client.go Don't translate StatusPacket to os.Err(NotExist|Permission) 2025-05-31 14:22:06 +02:00
client_test.go xkcd.com/1022 2024-09-30 17:38:18 +00:00
dirfs.go xkcd.com/1022 2024-09-30 17:38:18 +00:00
errno_plan9.go ancilliary breaks 2024-11-13 21:31:18 +00:00
errno_posix.go implement some ClientOptions rename OpSupported, and godoc the client. 2024-10-29 16:56:02 +00:00
fuzz.go Don't crash when the packet length is zero 2025-03-05 11:59:33 +00:00
go.mod update dependencies and CI versions 2025-04-01 14:01:16 +00:00
go.sum update dependencies and CI versions 2025-04-01 14:01:16 +00:00
longname.go a bit of a refactor, match a similar signature to protobuf opaque API 2025-03-04 13:56:56 +00:00
longname_test.go xkcd.com/1022 2024-09-30 17:38:18 +00:00
ls_plan9.go xkcd.com/1022 2024-09-30 17:38:18 +00:00
ls_stub.go xkcd.com/1022 2024-09-30 17:38:18 +00:00
ls_unix.go Add wasip1 as per PR #616 2025-02-22 08:15:49 +00:00
server.go missed one, and explicit statusOK return 2025-03-31 02:22:21 +00:00
sftp.go xkcd.com/1022 2024-09-30 17:38:18 +00:00
unimplemented.go iterators, golint, and internal packages, oh my\! 2024-11-12 15:37:31 +00:00
unimplemented_test.go iterators, golint, and internal packages, oh my\! 2024-11-12 15:37:31 +00: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 local filesystem.

CI Status Go Reference

usage and examples

See https://pkg.go.dev/github.com/pkg/sftp/v2 for examples and usage.

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

The basic interface of the server handler follows the design of gRPC.

roadmap

  • Extensive testing is necessary to validate that functionality has not been lost.

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.