stensmo/sftpclient.jl

Julia SFTP Client

Julia SFTP Client

Package for working with SFTP in Julia. Built on Downloads.jl, but in my opinion much easier to use. Downloads.jl is in turn based on Curl.

The Julia SFTP client supports username/password as well as certificates for authentication.

The following methods are supported: readdir, download, upload, cd, rm, rmdir, mkdir, mv, sftpstat (like stat)

Examples:

    using SFTPClient
    sftp = SFTP("sftp://test.rebex.net/pub/example/", "demo", "password")
    files=readdir(sftp)
    # On Windows, replace this with an appropriate path
    downloadDir="/tmp/"
    SFTPClient.download.(sftp, files, downloadDir=downloadDir)

    statStructs = sftpstat(sftp)

    #You can also use it like this
    df=DataFrame(CSV.File(SFTPClient.download(sftp, "/mydir/test.csv")))
    # For certificaes you can use this for setting it up
    sftp = SFTP("sftp://mysitewhereIhaveACertificate.com", "myuser")
    # Since 0.3.8 you can also do this
    sftp = SFTP("sftp://mysitewhereIhaveACertificate.com", "myuser", "cert.pub", "cert.pem") # Assumes cert.pub and cert.pem is in your current path
    # The cert.pem is your certificate (private key), and the cert.pub can be obtained from the private key.
    # ssh-keygen -y  -f ./cert.pem. Save the output into "cert.pub". 

API Documentation

Troubleshooting

If you get: RequestError: Failure establishing ssh session: -5, Unable to exchange encryption keys while requesting... Try and upgrade to Julia 1.9.4. It seems to be a bug in an underlying library.

sftpclient.jl's Issues

Register in Registry

@JuliaRegistrator register

Directories containing Space doesn't work for some operations

rm, rmdir, etc does not work for directories containing space. Probably some upstream bug.

Private/public key are NULL for a defined path

I'm trying the library in Windows 10, and when I defined a path for the private and public key I can not connect to the server.
The code is the following:

using SFTPClient
sftp = SFTP("sftp://$ip", "root", "test.pub" , "test.pem")
sftp.verbose = true
files=readdir(sftp) 

from the debug info the keys have the value NULL:

• SSH MD5 public key: NULL
• SSH SHA256 public key: NULL