Socket
Socket
Sign inDemoInstall

github.com/d-kononov/go-sftp

Package Overview
Dependencies
Alerts
File Explorer
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

github.com/d-kononov/go-sftp


Version published
Created
Source

go-sftp

A pure SFTP protocol implementation for Go!

This library provides an SFTP client and server (not yet) implementation and low-level packet definitions for SFTP version 3. The cmd/sftp package contains a SFTP commandline client with interactive shell and auto-completion.

// Create a new sftp client. 
cli, _ := sftp.NewClient(sshConn)

// List contents of a directory
list, _ := cli.List("/tmp")
for _, fileInfo := range list {
    fmt.Printf("%s    %dbytes\n", fileInfo.Name(), fileInfo.Size())
}

// Create an io.Reader for a given file and copy contents to stdout
reader, _ := cli.FileReader("/etc/passwd")
io.Copy(os.Stdout, reader)

// Create an io.WriteCloser for the given remote file and copy contents from 
// a local file
f, _ := os.Open("/tmp/foobar")
writer, _ := cli.FileWriter("/tmp/barfoo")
io.Copy(writer, f)

// There is also Get() and Put() to upload/download files
cli.Put("/tmp/local_file", "/tmp/remote_file")

cli.Get("/tmp/remote_file", "/tmp/local_file")

// Copy a remote file to a remote destination (client forwards data)
reader, _ = cli.FileReader("/tmp/source")
writer, _ = cli.FileWriter("/tmp/dest")
io.Copy(writer, reader)

// Remove a file
cli.Remove("/tmp/foobar")

// Rename/Move a file or directory
cli.Rename("/tmp/bar", "/tmp/foo")

// Create a new directory
cli.MkDir("/tmp/mydir")

// Remove a directory
cli.RmDir("/tmp/mydir")

go-sftp is not yet complete an some protocol features are still missing. In addition, the server implementation is postponed until the client is fully functional.

FAQs

Package last updated on 02 Jun 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc