COMMAND LINE WARRIORS

Taking Control of your Own Technology

  • RSS-Button

SFTP in Python: Paramiko

28 May 2008

In your scripts or applications, you might need to copy a file from one server to another. One way to do this is to use SFTP, the secure file transfer program, which uses an encrypted SSH (Secure Shell) transport which in turns runs over TCP/IP.

One of the Python implementations of SSH is called Paramiko (available in package managers as paramiko or python-paramiko).

Paramiko is extremely comprehensive so you can get as complicated as you like, but for me, I just want to be able to copy files from a known remotepath to a known localpath and back again.

In this post I explain how to do this using Paramiko directly, in the next-post, I look at another approach.

So we start by importing the module, and specifying the log file:

import paramiko
paramiko.util.log_to_file('/tmp/paramiko.log')

We open an SSH transport:

host = "example.com"
port = 22
transport = paramiko.Transport((host, port))

Next we want to authenticate. We can do this with a password:

password = "example101"
username = "warrior"
transport.connect(username = username, password = password)

Another way is to use an SSH key:

import os
privatekeyfile = os.path.expanduser('~/.ssh/id_rsa')
mykey = paramiko.RSAKey.from_private_key_file(privatekeyfile)
username = 'warrior'
transport.connect(username = username, pkey = mykey)

Now we can start the SFTP client:

sftp = paramiko.SFTPClient.from_transport(transport)

Now lets pull a file across from the remote to the local system:

filepath = '/home/zeth/lenna.jpg'
localpath = '/home/zeth/lenna.jpg'
sftp.get(filepath, localpath)

Now lets go the other way:

filepath = '/home/zeth/lenna.jpg'
localpath = '/home/zeth/lenna.jpg'
sftp.put(filepath, localpath)

Lastly, we need to close the SFTP connection and the transport:

sftp.close()
transport.close()

In my humble opinion, one should not have to write so many lines or care about the SSH protocol just to send a file from a to b. In the next-post, I will share my own higher level API that runs on top of Paramiko.

1 Phill says...

I use Paramiko in the script I have to upload sermons to the Fordham website. It's pretty basic - just creating directories and uploading an MP3. I'm sure I got it to use a key though!

Posted at 4:06 p.m. on May 28, 2008


2 numerodix says...

Is there some reason you can't just use scp?

Posted at 5:09 p.m. on May 28, 2008


3 zeth says...

Phill - I figured it out in the end, see update above.

Numerodix, well that is a valid approach for a small script. However, for an application, spawning a subprocess and running the command-line application scp would be relatively slow and RAM intensive. Paramiko allows us to keep the SSH connection open and perform as many SFTP operations as we like.

Posted at 9:09 p.m. on May 28, 2008


4 Todd Partridge aka Dirk says...

Nice job on the site design. Very viewable! TEXT it's always about text. :)

Posted at 3:54 p.m. on May 29, 2008


5 Harshad Modi says...

Thanks helping me!!! but I have problem on banner.... I try to make my own sftp server using paramiko inherit paramiko.ServerInterface class. but I got this error:

ERROR:paramiko.transport:SSHException: Error reading SSH protocol banner

so can you help me ? how to resloved ?

Posted at 2:58 p.m. on August 18, 2008


6 karan says...

thanks for the help...really kewl tutorial..

Posted at 12:05 p.m. on September 29, 2008


7 sahar says...

I want to copy a file from a Windows machine to a Linux, may I use this code? what should I replace with 'Host' , 'Username' and "Password"?

Posted at 6:16 a.m. on October 2, 2008


8 Suprabhath Reddy Gajjala says...

Hello ,

This Tutorial is really helpful for me. It is really cool. Thank you for the posting and there is some flaw in this tutorial.

For getting a file from remote machine to local machine, the code is correct.

But for transferring a file from local machine to remote machine :

sftp.put(filepath, localpath) is incorrect.

This should be sftp.put(localpath, filepath)

Posted at 3:29 p.m. on December 3, 2008


9 Mr Zog says...

In my job we have a vendor we must scp/sftp files to who does not allow ssh keys. Scp forces you to enter a password interactively.

Posted at 10:21 p.m. on May 7, 2009


10 livededge says...

i need to use an sftp written entirely in php (php server). any ideas?

Posted at 5:47 p.m. on June 12, 2009


11 Priyaranjan says...

Thank you so much for this. I would like to know if there is a way to synchronize folders instead of upload all the files each time.

Posted at 3:25 p.m. on July 11, 2009


What do you have to say?

Show Editing Help

About

Hello, my name is Zeth, I'll be your host here.

Command Line Warriors is about taking control of your own technology, it looks at our experiences of computing; especially using GNU/Linux, the Python programming language, the command-line and issues such as techno-ethics, best practices and whatever is cool now. If you take control of your technology then you are a Warrior too!

This site is your site too which means that you can contribute and get involved. You can leave comments using the facility provided. For me, the comments and discussions are by far the best part of the site. So please do have your say!

Latest Discussions

Zeth

November 29, 2009
Hi Jordan, yes that URL is gone now. I have a new contact form on this site.
→ Python CGI contact forms

Jordan

November 29, 2009
Zeth attention! Your form, http://zeth.me.uk/contact/, is not working The explorer says connecting ..but nothing happens Sorry for my poor English: I am Spanish Regards
→ Python CGI contact forms

Jordan

November 26, 2009
Sorry: tell me , not tellme (I'm spaniard) And http://zeth.me.uk/contact/ don't work
→ You got the touch, you got the power

David Jones

November 25, 2009
Your mad skillz are too l33t! for me. I specifically switched to Google Reader so that I could show people what blogs I read. But I couldn't work out how ...
→ How to find the fashionable blogs quickly

Brian R. Hickey

November 20, 2009
Symantec picked it up too.
→ How to bring down Internet Explorer with six words

Zeth

November 17, 2009
Thanks djm, I am the moose here. Christian, assuming one actually does Internationalise the countries, it should still work I guess, as the gettext stuff will happen before the list ...
→ Countries in Django

Phillip Temple

November 17, 2009
Good start, but: a) wouldn't I want None back rather than 'ZZ'? b) why not add a 'shortcut' boolean, then prepend flagged fields (plus usual '-----' separator) to the actual ...
→ Countries in Django

djm

November 17, 2009
Am I being a moose or did you mean: from whatever.countries import CountryField instead of from whatever.countries import CharField ? Good post though, cheers.
→ Countries in Django

Christian Joergensen

November 17, 2009
Wouldn't the ordering get messed up after i18n?
→ Countries in Django

Steve - Electronic Cigarettes Fan

November 17, 2009
Very well done. Is your blog just you writing? Nicely done, Steven.
→ Blogger vs Wordpress

vetetix

November 15, 2009
Sorry to bother you nearly two years after you wrote this blog article, but I can't manage to find how to modify an existing field. I am trying to change ...
→ Three Useful Python Bindings - ClamAV, Apt and Evolution

Manju

November 4, 2009
I am transferring some files using psftp to other device's FAT partition. But the filestamp of the file being transferred is modified to that of FAT device, after the transfer. ...
→ PuTTY Series: Using PSFTP

iki

November 2, 2009
or simpler: socket.gethostbyname_ex(socket.gethostname())[2]
→ How to find out your IP address in Python

iki

November 2, 2009
local_ip = set([ i[4][0] for i in socket.getaddrinfo(socket.gethostname(), None) if i[0] == 2 ])
→ How to find out your IP address in Python

Fred

November 2, 2009
testing rst ------------- - point 1
→ An Introduction to ReStructuredText

Ano

October 27, 2009
"You simply found the license of the StumbleUpon Toolbar for Internet Explorer." That's possible. I've got some more interesting information to add. Firstly, go to this page: https://addons.mozilla.org/en-US/firefox/addon/138 - this ...
→ Are your Firefox extensions proprietary software?

Ken

October 21, 2009
Stumbled in here at lunch. This is the best find of the week. Thanks.
→ Three classic command line tips

Jim

October 19, 2009
Thanks for the rtsp:// post - that's something that has been bugging me for a while!
→ Three classic command line tips

Zeth

October 18, 2009
Thanks for the comments guys. Great to see the all the gang are still here!
→ Three classic command line tips

Bubba

October 18, 2009
Is there any way psftp can return the true transfer rates oberved during the actual transfer?
→ PuTTY Series: Using PSFTP

Made with Django. Creative Commons License Theme Designers Homepage Valid XHTML 1.0 Strict