Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Native Python SSHv2 protocol library
Python Groff
Failed to load latest commit information.
demos Use modern api to check if event is set.
images [project @ Arch-1:robey@lag.net--2005-master-shake%paramiko--dev--1--…
paramiko Error message langauge tweak
sites Merge branch '1.15'
tests Suggest a MIN_WINDOW_SIZE and MIN_PACKET_SIZE
.bzrignore [project @ robey@lag.net-20080706223938-fn82xx2k0zvklazm]
.gitignore Merge branch 'master' into gssapi-py3-support
.travis.yml Merge branch '1.14' into 1.15
ChangeLog.0 [project @ Arch-1:robey@lag.net--2005-master-shake%paramiko--dev--1--…
ChangeLog.1 [project @ Arch-1:robey@lag.net--2005-master-shake%paramiko--dev--1--…
LICENSE Fix FSF address
MANIFEST.in [project @ robey@lag.net-20061031185035-b57ad8184c39063a]
NEWS Nuke sphinx-changelogg'd material
NOTES [project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-33]
README Merge branch '1.14' into 1.15
TODO Take ownership of TODO file
dev-requirements.txt Packaging updates
setup.cfg Revert "Revert "Add a setup.cfg identifying this package as universal""
setup.py Merge branch 'master' into 298-int
setup_helper.py Fixed a typo in the license header of most files
tasks.py Not sure how this got nuked
test.py Merge branch 'master' into 267-int
tox-requirements.txt Meta prep work (reqs.txt, tasks.py)
tox.ini Don't tell pip to use mirrors anymore

README

========
paramiko
========

:Paramiko: Python SSH module
:Copyright: Copyright (c) 2003-2009  Robey Pointer <robeypointer@gmail.com>
:Copyright: Copyright (c) 2013-2015  Jeff Forcier <jeff@bitprophet.org>
:License: LGPL
:Homepage: https://github.com/paramiko/paramiko/
:API docs: http://docs.paramiko.org


What
----

"paramiko" is a combination of the esperanto words for "paranoid" and
"friend".  it's a module for python 2.6+ that implements the SSH2 protocol
for secure (encrypted and authenticated) connections to remote machines.
unlike SSL (aka TLS), SSH2 protocol does not require hierarchical
certificates signed by a powerful central authority. you may know SSH2 as
the protocol that replaced telnet and rsh for secure access to remote
shells, but the protocol also includes the ability to open arbitrary
channels to remote services across the encrypted tunnel (this is how sftp
works, for example).

it is written entirely in python (no C or platform-dependent code) and is
released under the GNU LGPL (lesser GPL). 

the package and its API is fairly well documented in the "doc/" folder
that should have come with this archive.


Requirements
------------

  - Python 2.6 or better <http://www.python.org/> - this includes Python
    3.2 and higher as well.
  - pycrypto 2.1 or better <https://www.dlitz.net/software/pycrypto/>
  - ecdsa 0.9 or better <https://pypi.python.org/pypi/ecdsa>

If you have setuptools, you can build and install paramiko and all its
dependencies with this command (as root)::

    easy_install ./


Portability
-----------

i code and test this library on Linux and MacOS X. for that reason, i'm
pretty sure that it works for all posix platforms, including MacOS. it
should also work on Windows, though i don't test it as frequently there.
if you run into Windows problems, send me a patch: portability is important
to me.

some python distributions don't include the utf-8 string encodings, for
reasons of space (misdirected as that is). if your distribution is
missing encodings, you'll see an error like this::

    LookupError: no codec search functions registered: can't find encoding

this means you need to copy string encodings over from a working system.
(it probably only happens on embedded systems, not normal python
installs.) Valeriy Pogrebitskiy says the best place to look is
``.../lib/python*/encodings/__init__.py``.


Bugs & Support
--------------

Please file bug reports at https://github.com/paramiko/paramiko/. There is currently no mailing list but we plan to create a new one ASAP.


Kerberos Support
----------------

Paramiko ships with optional Kerberos/GSSAPI support; for info on the extra
dependencies for this, see the 'GSS-API' section on the 'Installation' page of
our main website, http://paramiko.org .


Demo
----

several demo scripts come with paramiko to demonstrate how to use it.
probably the simplest demo of all is this::

    import paramiko, base64
    key = paramiko.RSAKey(data=base64.decodestring('AAA...'))
    client = paramiko.SSHClient()
    client.get_host_keys().add('ssh.example.com', 'ssh-rsa', key)
    client.connect('ssh.example.com', username='strongbad', password='thecheat')
    stdin, stdout, stderr = client.exec_command('ls')
    for line in stdout:
        print '... ' + line.strip('\n')
    client.close()

...which prints out the results of executing ``ls`` on a remote server.
(the host key 'AAA...' should of course be replaced by the actual base64
encoding of the host key.  if you skip host key verification, the
connection is not secure!)

the following example scripts (in demos/) get progressively more detailed:

:demo_simple.py:
    calls invoke_shell() and emulates a terminal/tty through which you can
    execute commands interactively on a remote server.  think of it as a
    poor man's ssh command-line client.

:demo.py:
    same as demo_simple.py, but allows you to authenticiate using a
    private key, attempts to use an SSH-agent if present, and uses the long
    form of some of the API calls.

:forward.py:
    command-line script to set up port-forwarding across an ssh transport.
    (requires python 2.3.)

:demo_sftp.py:
    opens an sftp session and does a few simple file operations.

:demo_server.py:
    an ssh server that listens on port 2200 and accepts a login for
    'robey' (password 'foo'), and pretends to be a BBS.  meant to be a
    very simple demo of writing an ssh server.

:demo_keygen.py:
    an key generator similar to openssh ssh-keygen(1) program with
    paramiko keys generation and progress functions.

Use
---

the demo scripts are probably the best example of how to use this package.
there is also a lot of documentation, generated with Sphinx autodoc, in the doc/ folder.

there are also unit tests here::

    $ python ./test.py

which will verify that most of the core components are working correctly.
Something went wrong with that request. Please try again.