tree: 0a95b7d88a409566bc67cc0a45b19b29b6249205 [path history] [tgz]
  1. .github/
  2. examples/
  3. server_standalone/
  4. .gitignore
  5. allocator.go
  6. allocator_test.go
  7. attrs.go
  8. attrs_stubs.go
  9. attrs_test.go
  10. attrs_unix.go
  11. client.go
  12. client_integration_darwin_test.go
  13. client_integration_linux_test.go
  14. client_integration_test.go
  15. client_test.go
  16. conn.go
  17. CONTRIBUTORS
  18. debug.go
  19. example_test.go
  20. fuzz.go
  21. go.mod
  22. go.sum
  23. LICENSE
  24. Makefile
  25. match.go
  26. packet-manager.go
  27. packet-manager_test.go
  28. packet-typing.go
  29. packet.go
  30. packet_test.go
  31. README.md
  32. release.go
  33. request-attrs.go
  34. request-attrs_test.go
  35. request-errors.go
  36. request-example.go
  37. request-interfaces.go
  38. request-plan9.go
  39. request-readme.md
  40. request-server.go
  41. request-server_test.go
  42. request-unix.go
  43. request.go
  44. request_test.go
  45. request_windows.go
  46. server.go
  47. server_integration_test.go
  48. server_statvfs_darwin.go
  49. server_statvfs_impl.go
  50. server_statvfs_linux.go
  51. server_statvfs_plan9.go
  52. server_statvfs_stubs.go
  53. server_stubs.go
  54. server_test.go
  55. server_unix.go
  56. sftp.go
  57. sftp_test.go
  58. stat_plan9.go
  59. stat_posix.go
  60. syscall_fixed.go
  61. syscall_good.go
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.