redlibssh2 2.0.0

Installation

Binary wheel packages are provided for Linux on all Python versions. Wheel packages have no dependencies.

pip may need to be updated to be able to install binary wheel packages - pip install -U pip.

pip install redlibssh2

For from source installation instructions, including building against system provided libssh2, see documentation.

For creating native system packages for Centos/RedHat, Ubuntu, Debian and Fedora, see instructions in the documentation.

API Feature Set

At this time all of the libssh2 API has been implemented up to version 1.9.0.

Complete example scripts for various operations can be found in the examples directory.

In addition, as redlibssh2 is a thin wrapper of libssh2 with Python semantics, its code examples can be ported straight over to Python with only minimal changes.

Quick Start

Both byte and unicode strings are accepted as arguments and encoded appropriately. To change default encoding, utf-8, change the value of ssh2.utils.ENCODING. Output is always in byte strings.

See Complete Example for an example including socket connect.

Please use either the issue tracker for reporting issues with code or the mail group for discussion and questions.

Contributions are most welcome!

from __future__ import print_function

from ssh2.session import Session

sock = <create and connect socket>

session = Session()
session.handshake(sock)
print(session.userauth_list())

['publickey', 'password', 'keyboard-interactive']

session.agent_auth(user)

channel = session.open_session()
channel.execute('echo Hello')

size, data = channel.read()
while(size > 0):
    print(data)
    size, data = channel.read()

Hello

print("Exit status: %s" % (channel.get_exit_status()))

Exit status: 0

session.userauth_publickey_fromfile(
    username, 'private_key_file')

session.userauth_password(
    username, '<my password>')

from ssh2.sftp import LIBSSH2_FXF_READ, LIBSSH2_SFTP_S_IRUSR

sftp = session.sftp_init()
with sftp.open(<remote file to read>,
               LIBSSH2_FXF_READ, LIBSSH2_SFTP_S_IRUSR) as remote_fh, \
        open(<local file to write>, 'wb') as local_fh:
    for size, data in remote_fh:
        local_fh.write(data)

Complete Example

A simple usage example looks very similar to libssh2 usage examples.

See examples directory for more complete example scripts.

As mentioned, redlibssh2 is intentionally a thin wrapper over libssh2 and directly maps most of its API.

Clients using this library can be much simpler to use than interfacing with the libssh2 API directly.

from __future__ import print_function

import os
import socket

from ssh2.session import Session

host = 'localhost'
user = os.getlogin()

sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.connect((host, 22))

session = Session()
session.handshake(sock)
session.agent_auth(user)

channel = session.open_session()
channel.execute('echo me; exit 2')
size, data = channel.read()
while size > 0:
    print(data)
    size, data = channel.read()
channel.close()
print("Exit status: %s" % channel.get_exit_status())

Output:

me

Exit status: 2

SSH Functionality currently implemented

• SSH channel operations (exec,shell,subsystem) and methods

• SSH agent functionality

• Public key authentication and management

• SFTP operations

• SFTP file handles and attributes

• SSH port forwarding and tunnelling

• Non-blocking mode

• SCP send and receive

• Listener for port forwarding

• Subsystem support

• Host key checking and manipulation

And more, as per libssh2 functionality.

time python examples/example_echo.py
time python examples/paramiko_comparison.py

Why did you drop manylinux1 wheels?

Because frankly the manylinux1 docker containers won’t run on my build hosts because I run up to date software and kernels. The manylinux1 docker images are also full of extremely old package versions that will not receive updates or security fixes. The way that ParallelSSH handled this was to bundle their own versions of libssh2, OpenSSL and zlib in the repository.

Why did you drop Windows and OSX wheels?

I don’t have build infrastructure for them and I don’t use these platforms anywhere. If someone would like these wheels to be built you can open an issue and it’ll be reviewed based on what can be provided to get such builds running.