commit | 09d6de934e8b36de95db7f8a0a36f6bb6b3e42bc | [log] [tgz] |
---|---|---|
author | bramvdbogaerde <contact@bramvdb.com> | Sun May 23 22:26:02 2021 +0200 |
committer | bramvdbogaerde <contact@bramvdb.com> | Sun May 23 22:26:02 2021 +0200 |
tree | a416cfe89c2e442d352a8b4222e5a1930d605737 | |
parent | 28fbae487e3f39d00a969c81ca909c552c05236e [diff] |
Fixed Grammar
This package makes it very easy to copy files over scp in Go. It uses the golang.org/x/crypto/ssh package to establish a secure connection to a remote server in order to copy the files via the SCP protocol.
package main import ( "fmt" scp "github.com/bramvdbogaerde/go-scp" "github.com/bramvdbogaerde/go-scp/auth" "golang.org/x/crypto/ssh" "os" ) func main() { // Use SSH key authentication from the auth package // we ignore the host key in this example, please change this if you use this library clientConfig, _ := auth.PrivateKey("username", "/path/to/rsa/key", ssh.InsecureIgnoreHostKey()) // For other authentication methods see ssh.ClientConfig and ssh.AuthMethod // Create a new SCP client client := scp.NewClient("example.com:22", &clientConfig) // Connect to the remote server err := client.Connect() if err != nil { fmt.Println("Couldn't establish a connection to the remote server ", err) return } // Open a file f, _ := os.Open("/path/to/local/file") // Close client connection after the file has been copied defer client.Close() // Close the file after it has been copied defer f.Close() // Finaly, copy the file over // Usage: CopyFile(fileReader, remotePath, permission) err = client.CopyFile(f, "/home/server/test.txt", "0655") if err != nil { fmt.Println("Error while copying file ", err) } }
If you have an existing established SSH connection, you can use that instead.
func connectSSH() *ssh.Client { // setup SSH connection } func main() { sshClient := connectSSH() // Create a new SCP client, note that this function might // return an error, as a new SSH session is established using the existing connecton client, err := scp.NewClientBySSH(sshClient) if err != nil { fmt.Println("Error creating new SSH session from existing connection", err) } /* .. same as above .. */ }
It is also possible to copy remote files using this library. The usage is similar to the example at the top of this section, except that CopyFromRemote
needsto be used instead.
For a more comprehensive example, please consult the TestDownloadFile
function in t he tests/basic_test.go
file.
This library is licensed under the Mozilla Public License 2.0.
A copy of the license is provided in the LICENSE.txt
file.
Copyright (c) 2020 Bram Vandenbogaerde